<!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"/>
<title>Apache Portable Runtime: apr_hooks.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>apr_hooks.h</h1> </div>
</div>
<div class="contents">
<a href="apr__hooks_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_HOOKS_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_HOOKS_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "apu.h"</span>
<a name="l00021"></a>00021 <span class="comment">/* For apr_array_header_t */</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="apr__tables_8h.html" title="APR Table library.">apr_tables.h</a>"</span>
<a name="l00023"></a>00023 <span class="comment"></span>
<a name="l00024"></a>00024 <span class="comment">/**</span>
<a name="l00025"></a>00025 <span class="comment"> * @file apr_hooks.h</span>
<a name="l00026"></a>00026 <span class="comment"> * @brief Apache hook functions</span>
<a name="l00027"></a>00027 <span class="comment"> */</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00033"></a>00033 <span class="comment"> * @defgroup APR_Util_Hook Hook Functions</span>
<a name="l00034"></a>00034 <span class="comment"> * @ingroup APR_Util</span>
<a name="l00035"></a>00035 <span class="comment"> * @{</span>
<a name="l00036"></a>00036 <span class="comment"> */</span><span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/** macro to return the prototype of the hook function */</span>
<a name="l00038"></a><a class="code" href="group___a_p_r___util___hook.html#ga832a6d3b73a43b3f7c58c5702ddccce9">00038</a> <span class="preprocessor">#define APR_IMPLEMENT_HOOK_GET_PROTO(ns,link,name) \</span>
<a name="l00039"></a>00039 <span class="preprocessor">link##_DECLARE(apr_array_header_t *) ns##_hook_get_##name(void)</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/** macro to declare the hook correctly */</span>
<a name="l00042"></a><a class="code" href="group___a_p_r___util___hook.html#ga69298243d3c4ffb4627fd3d04b522f44">00042</a> <span class="preprocessor">#define APR_DECLARE_EXTERNAL_HOOK(ns,link,ret,name,args) \</span>
<a name="l00043"></a>00043 <span class="preprocessor">typedef ret ns##_HOOK_##name##_t args; \</span>
<a name="l00044"></a>00044 <span class="preprocessor">link##_DECLARE(void) ns##_hook_##name(ns##_HOOK_##name##_t *pf, \</span>
<a name="l00045"></a>00045 <span class="preprocessor"> const char * const *aszPre, \</span>
<a name="l00046"></a>00046 <span class="preprocessor"> const char * const *aszSucc, int nOrder); \</span>
<a name="l00047"></a>00047 <span class="preprocessor">link##_DECLARE(ret) ns##_run_##name args; \</span>
<a name="l00048"></a>00048 <span class="preprocessor">APR_IMPLEMENT_HOOK_GET_PROTO(ns,link,name); \</span>
<a name="l00049"></a>00049 <span class="preprocessor">typedef struct ns##_LINK_##name##_t \</span>
<a name="l00050"></a>00050 <span class="preprocessor"> { \</span>
<a name="l00051"></a>00051 <span class="preprocessor"> ns##_HOOK_##name##_t *pFunc; \</span>
<a name="l00052"></a>00052 <span class="preprocessor"> const char *szName; \</span>
<a name="l00053"></a>00053 <span class="preprocessor"> const char * const *aszPredecessors; \</span>
<a name="l00054"></a>00054 <span class="preprocessor"> const char * const *aszSuccessors; \</span>
<a name="l00055"></a>00055 <span class="preprocessor"> int nOrder; \</span>
<a name="l00056"></a>00056 <span class="preprocessor"> } ns##_LINK_##name##_t;</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">/** macro to declare the hook structure */</span>
<a name="l00059"></a><a class="code" href="group___a_p_r___util___hook.html#gaa936f5a0d1164d301aa157de6023fae5">00059</a> <span class="preprocessor">#define APR_HOOK_STRUCT(members) \</span>
<a name="l00060"></a>00060 <span class="preprocessor">static struct { members } _hooks;</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/** macro to link the hook structure */</span>
<a name="l00063"></a><a class="code" href="group___a_p_r___util___hook.html#ga5699f73166bae88b6f6ac0bf7618b0f6">00063</a> <span class="preprocessor">#define APR_HOOK_LINK(name) \</span>
<a name="l00064"></a>00064 <span class="preprocessor"> apr_array_header_t *link_##name;</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">/** macro to implement the hook */</span>
<a name="l00067"></a><a class="code" href="group___a_p_r___util___hook.html#ga2500abadaa54b3a9d6ec25ff33a6b0cc">00067</a> <span class="preprocessor">#define APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ns,link,name) \</span>
<a name="l00068"></a>00068 <span class="preprocessor">link##_DECLARE(void) ns##_hook_##name(ns##_HOOK_##name##_t *pf,const char * const *aszPre, \</span>
<a name="l00069"></a>00069 <span class="preprocessor"> const char * const *aszSucc,int nOrder) \</span>
<a name="l00070"></a>00070 <span class="preprocessor"> { \</span>
<a name="l00071"></a>00071 <span class="preprocessor"> ns##_LINK_##name##_t *pHook; \</span>
<a name="l00072"></a>00072 <span class="preprocessor"> if(!_hooks.link_##name) \</span>
<a name="l00073"></a>00073 <span class="preprocessor"> { \</span>
<a name="l00074"></a>00074 <span class="preprocessor"> _hooks.link_##name=apr_array_make(apr_hook_global_pool,1,sizeof(ns##_LINK_##name##_t)); \</span>
<a name="l00075"></a>00075 <span class="preprocessor"> apr_hook_sort_register(#name,&_hooks.link_##name); \</span>
<a name="l00076"></a>00076 <span class="preprocessor"> } \</span>
<a name="l00077"></a>00077 <span class="preprocessor"> pHook=apr_array_push(_hooks.link_##name); \</span>
<a name="l00078"></a>00078 <span class="preprocessor"> pHook->pFunc=pf; \</span>
<a name="l00079"></a>00079 <span class="preprocessor"> pHook->aszPredecessors=aszPre; \</span>
<a name="l00080"></a>00080 <span class="preprocessor"> pHook->aszSuccessors=aszSucc; \</span>
<a name="l00081"></a>00081 <span class="preprocessor"> pHook->nOrder=nOrder; \</span>
<a name="l00082"></a>00082 <span class="preprocessor"> pHook->szName=apr_hook_debug_current; \</span>
<a name="l00083"></a>00083 <span class="preprocessor"> if(apr_hook_debug_enabled) \</span>
<a name="l00084"></a>00084 <span class="preprocessor"> apr_hook_debug_show(#name,aszPre,aszSucc); \</span>
<a name="l00085"></a>00085 <span class="preprocessor"> } \</span>
<a name="l00086"></a>00086 <span class="preprocessor"> APR_IMPLEMENT_HOOK_GET_PROTO(ns,link,name) \</span>
<a name="l00087"></a>00087 <span class="preprocessor"> { \</span>
<a name="l00088"></a>00088 <span class="preprocessor"> return _hooks.link_##name; \</span>
<a name="l00089"></a>00089 <span class="preprocessor"> }</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment">/**</span>
<a name="l00092"></a>00092 <span class="comment"> * Implement a hook that has no return code, and therefore runs all of the</span>
<a name="l00093"></a>00093 <span class="comment"> * registered functions</span>
<a name="l00094"></a>00094 <span class="comment"> * @param ns The namespace prefix of the hook functions</span>
<a name="l00095"></a>00095 <span class="comment"> * @param link The linkage declaration prefix of the hook</span>
<a name="l00096"></a>00096 <span class="comment"> * @param name The name of the hook</span>
<a name="l00097"></a>00097 <span class="comment"> * @param args_decl The declaration of the arguments for the hook</span>
<a name="l00098"></a>00098 <span class="comment"> * @param args_use The names for the arguments for the hook</span>
<a name="l00099"></a>00099 <span class="comment"> * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which</span>
<a name="l00100"></a>00100 <span class="comment"> * provide export linkage from the module that IMPLEMENTs the hook, and</span>
<a name="l00101"></a>00101 <span class="comment"> * import linkage from external modules that link to the hook's module.</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a><a class="code" href="group___a_p_r___util___hook.html#ga2d11a43b6431ec568cc1647da4a2079c">00103</a> <span class="preprocessor">#define APR_IMPLEMENT_EXTERNAL_HOOK_VOID(ns,link,name,args_decl,args_use) \</span>
<a name="l00104"></a>00104 <span class="preprocessor">APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ns,link,name) \</span>
<a name="l00105"></a>00105 <span class="preprocessor">link##_DECLARE(void) ns##_run_##name args_decl \</span>
<a name="l00106"></a>00106 <span class="preprocessor"> { \</span>
<a name="l00107"></a>00107 <span class="preprocessor"> ns##_LINK_##name##_t *pHook; \</span>
<a name="l00108"></a>00108 <span class="preprocessor"> int n; \</span>
<a name="l00109"></a>00109 <span class="preprocessor">\</span>
<a name="l00110"></a>00110 <span class="preprocessor"> if(!_hooks.link_##name) \</span>
<a name="l00111"></a>00111 <span class="preprocessor"> return; \</span>
<a name="l00112"></a>00112 <span class="preprocessor">\</span>
<a name="l00113"></a>00113 <span class="preprocessor"> pHook=(ns##_LINK_##name##_t *)_hooks.link_##name->elts; \</span>
<a name="l00114"></a>00114 <span class="preprocessor"> for(n=0 ; n < _hooks.link_##name->nelts ; ++n) \</span>
<a name="l00115"></a>00115 <span class="preprocessor"> pHook[n].pFunc args_use; \</span>
<a name="l00116"></a>00116 <span class="preprocessor"> }</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span>
<a name="l00118"></a>00118 <span class="comment">/* FIXME: note that this returns ok when nothing is run. I suspect it should</span>
<a name="l00119"></a>00119 <span class="comment"> really return decline, but that breaks Apache currently - Ben</span>
<a name="l00120"></a>00120 <span class="comment">*/</span><span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">/**</span>
<a name="l00122"></a>00122 <span class="comment"> * Implement a hook that runs until one of the functions returns something</span>
<a name="l00123"></a>00123 <span class="comment"> * other than OK or DECLINE</span>
<a name="l00124"></a>00124 <span class="comment"> * @param ns The namespace prefix of the hook functions</span>
<a name="l00125"></a>00125 <span class="comment"> * @param link The linkage declaration prefix of the hook</span>
<a name="l00126"></a>00126 <span class="comment"> * @param ret Type to return</span>
<a name="l00127"></a>00127 <span class="comment"> * @param name The name of the hook</span>
<a name="l00128"></a>00128 <span class="comment"> * @param args_decl The declaration of the arguments for the hook</span>
<a name="l00129"></a>00129 <span class="comment"> * @param args_use The names for the arguments for the hook</span>
<a name="l00130"></a>00130 <span class="comment"> * @param ok Success value</span>
<a name="l00131"></a>00131 <span class="comment"> * @param decline Decline value</span>
<a name="l00132"></a>00132 <span class="comment"> * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which</span>
<a name="l00133"></a>00133 <span class="comment"> * provide export linkage from the module that IMPLEMENTs the hook, and</span>
<a name="l00134"></a>00134 <span class="comment"> * import linkage from external modules that link to the hook's module.</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a><a class="code" href="group___a_p_r___util___hook.html#gab466280bdabe0cc2ee5880cbb512fa3d">00136</a> <span class="preprocessor">#define APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ns,link,ret,name,args_decl,args_use,ok,decline) \</span>
<a name="l00137"></a>00137 <span class="preprocessor">APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ns,link,name) \</span>
<a name="l00138"></a>00138 <span class="preprocessor">link##_DECLARE(ret) ns##_run_##name args_decl \</span>
<a name="l00139"></a>00139 <span class="preprocessor"> { \</span>
<a name="l00140"></a>00140 <span class="preprocessor"> ns##_LINK_##name##_t *pHook; \</span>
<a name="l00141"></a>00141 <span class="preprocessor"> int n; \</span>
<a name="l00142"></a>00142 <span class="preprocessor"> ret rv; \</span>
<a name="l00143"></a>00143 <span class="preprocessor">\</span>
<a name="l00144"></a>00144 <span class="preprocessor"> if(!_hooks.link_##name) \</span>
<a name="l00145"></a>00145 <span class="preprocessor"> return ok; \</span>
<a name="l00146"></a>00146 <span class="preprocessor">\</span>
<a name="l00147"></a>00147 <span class="preprocessor"> pHook=(ns##_LINK_##name##_t *)_hooks.link_##name->elts; \</span>
<a name="l00148"></a>00148 <span class="preprocessor"> for(n=0 ; n < _hooks.link_##name->nelts ; ++n) \</span>
<a name="l00149"></a>00149 <span class="preprocessor"> { \</span>
<a name="l00150"></a>00150 <span class="preprocessor"> rv=pHook[n].pFunc args_use; \</span>
<a name="l00151"></a>00151 <span class="preprocessor">\</span>
<a name="l00152"></a>00152 <span class="preprocessor"> if(rv != ok && rv != decline) \</span>
<a name="l00153"></a>00153 <span class="preprocessor"> return rv; \</span>
<a name="l00154"></a>00154 <span class="preprocessor"> } \</span>
<a name="l00155"></a>00155 <span class="preprocessor"> return ok; \</span>
<a name="l00156"></a>00156 <span class="preprocessor"> }</span>
<a name="l00157"></a>00157 <span class="preprocessor"></span>
<a name="l00158"></a>00158 <span class="comment"></span>
<a name="l00159"></a>00159 <span class="comment">/**</span>
<a name="l00160"></a>00160 <span class="comment"> * Implement a hook that runs until the first function returns something</span>
<a name="l00161"></a>00161 <span class="comment"> * other than the value of decline</span>
<a name="l00162"></a>00162 <span class="comment"> * @param ns The namespace prefix of the hook functions</span>
<a name="l00163"></a>00163 <span class="comment"> * @param link The linkage declaration prefix of the hook</span>
<a name="l00164"></a>00164 <span class="comment"> * @param name The name of the hook</span>
<a name="l00165"></a>00165 <span class="comment"> * @param ret Type to return</span>
<a name="l00166"></a>00166 <span class="comment"> * @param args_decl The declaration of the arguments for the hook</span>
<a name="l00167"></a>00167 <span class="comment"> * @param args_use The names for the arguments for the hook</span>
<a name="l00168"></a>00168 <span class="comment"> * @param decline Decline value</span>
<a name="l00169"></a>00169 <span class="comment"> * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which</span>
<a name="l00170"></a>00170 <span class="comment"> * provide export linkage from the module that IMPLEMENTs the hook, and</span>
<a name="l00171"></a>00171 <span class="comment"> * import linkage from external modules that link to the hook's module.</span>
<a name="l00172"></a>00172 <span class="comment"> */</span>
<a name="l00173"></a><a class="code" href="group___a_p_r___util___hook.html#ga0420a2aa9ca6b3c1638bdb76025ecc57">00173</a> <span class="preprocessor">#define APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(ns,link,ret,name,args_decl,args_use,decline) \</span>
<a name="l00174"></a>00174 <span class="preprocessor">APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ns,link,name) \</span>
<a name="l00175"></a>00175 <span class="preprocessor">link##_DECLARE(ret) ns##_run_##name args_decl \</span>
<a name="l00176"></a>00176 <span class="preprocessor"> { \</span>
<a name="l00177"></a>00177 <span class="preprocessor"> ns##_LINK_##name##_t *pHook; \</span>
<a name="l00178"></a>00178 <span class="preprocessor"> int n; \</span>
<a name="l00179"></a>00179 <span class="preprocessor"> ret rv; \</span>
<a name="l00180"></a>00180 <span class="preprocessor">\</span>
<a name="l00181"></a>00181 <span class="preprocessor"> if(!_hooks.link_##name) \</span>
<a name="l00182"></a>00182 <span class="preprocessor"> return decline; \</span>
<a name="l00183"></a>00183 <span class="preprocessor">\</span>
<a name="l00184"></a>00184 <span class="preprocessor"> pHook=(ns##_LINK_##name##_t *)_hooks.link_##name->elts; \</span>
<a name="l00185"></a>00185 <span class="preprocessor"> for(n=0 ; n < _hooks.link_##name->nelts ; ++n) \</span>
<a name="l00186"></a>00186 <span class="preprocessor"> { \</span>
<a name="l00187"></a>00187 <span class="preprocessor"> rv=pHook[n].pFunc args_use; \</span>
<a name="l00188"></a>00188 <span class="preprocessor">\</span>
<a name="l00189"></a>00189 <span class="preprocessor"> if(rv != decline) \</span>
<a name="l00190"></a>00190 <span class="preprocessor"> return rv; \</span>
<a name="l00191"></a>00191 <span class="preprocessor"> } \</span>
<a name="l00192"></a>00192 <span class="preprocessor"> return decline; \</span>
<a name="l00193"></a>00193 <span class="preprocessor"> }</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span>
<a name="l00195"></a>00195 <span class="comment">/* Hook orderings */</span><span class="comment"></span>
<a name="l00196"></a>00196 <span class="comment">/** run this hook first, before ANYTHING */</span>
<a name="l00197"></a><a class="code" href="group___a_p_r___util___hook.html#gab004dcbfff32997deb15040e48f07e92">00197</a> <span class="preprocessor">#define APR_HOOK_REALLY_FIRST (-10)</span>
<a name="l00198"></a>00198 <span class="preprocessor"></span><span class="comment">/** run this hook first */</span>
<a name="l00199"></a><a class="code" href="group___a_p_r___util___hook.html#ga564dea4803813674cb6b742f65a3d2b2">00199</a> <span class="preprocessor">#define APR_HOOK_FIRST 0</span>
<a name="l00200"></a>00200 <span class="preprocessor"></span><span class="comment">/** run this hook somewhere */</span>
<a name="l00201"></a><a class="code" href="group___a_p_r___util___hook.html#gab9a5d50c3478c4d640deccec6b0ce879">00201</a> <span class="preprocessor">#define APR_HOOK_MIDDLE 10</span>
<a name="l00202"></a>00202 <span class="preprocessor"></span><span class="comment">/** run this hook after every other hook which is defined*/</span>
<a name="l00203"></a><a class="code" href="group___a_p_r___util___hook.html#gaa610a95f03d7b4aee922c28b0919f028">00203</a> <span class="preprocessor">#define APR_HOOK_LAST 20</span>
<a name="l00204"></a>00204 <span class="preprocessor"></span><span class="comment">/** run this hook last, after EVERYTHING */</span>
<a name="l00205"></a><a class="code" href="group___a_p_r___util___hook.html#gae3c7d2cf35e8c89828dfff7a85b0ed77">00205</a> <span class="preprocessor">#define APR_HOOK_REALLY_LAST 30</span>
<a name="l00206"></a>00206 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00207"></a>00207 <span class="comment">/**</span>
<a name="l00208"></a>00208 <span class="comment"> * The global pool used to allocate any memory needed by the hooks.</span>
<a name="l00209"></a>00209 <span class="comment"> */</span>
<a name="l00210"></a>00210 APU_DECLARE_DATA <span class="keyword">extern</span> <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *<a class="code" href="group___a_p_r___util___hook.html#ga8911bb699a5f03ad3c36d579ca0eca23">apr_hook_global_pool</a>;
<a name="l00211"></a>00211 <span class="comment"></span>
<a name="l00212"></a>00212 <span class="comment">/**</span>
<a name="l00213"></a>00213 <span class="comment"> * A global variable to determine if debugging information about the</span>
<a name="l00214"></a>00214 <span class="comment"> * hooks functions should be printed</span>
<a name="l00215"></a>00215 <span class="comment"> */</span>
<a name="l00216"></a>00216 APU_DECLARE_DATA <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group___a_p_r___util___hook.html#ga59309caeb9b47d921727530494f264be">apr_hook_debug_enabled</a>;
<a name="l00217"></a>00217 <span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment">/**</span>
<a name="l00219"></a>00219 <span class="comment"> * The name of the module that is currently registering a function</span>
<a name="l00220"></a>00220 <span class="comment"> */</span>
<a name="l00221"></a>00221 APU_DECLARE_DATA <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group___a_p_r___util___hook.html#ga37be3c217439ceddbda16054b020a658">apr_hook_debug_current</a>;
<a name="l00222"></a>00222 <span class="comment"></span>
<a name="l00223"></a>00223 <span class="comment">/**</span>
<a name="l00224"></a>00224 <span class="comment"> * Register a hook function to be sorted</span>
<a name="l00225"></a>00225 <span class="comment"> * @param szHookName The name of the Hook the function is registered for</span>
<a name="l00226"></a>00226 <span class="comment"> * @param aHooks The array which stores all of the functions for this hook</span>
<a name="l00227"></a>00227 <span class="comment"> */</span>
<a name="l00228"></a>00228 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___hook.html#ga04843fe00dc3c08c23130fef3ba1260c">apr_hook_sort_register</a>(const <span class="keywordtype">char</span> *szHookName,
<a name="l00229"></a>00229 <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> **aHooks);<span class="comment"></span>
<a name="l00230"></a>00230 <span class="comment">/**</span>
<a name="l00231"></a>00231 <span class="comment"> * Sort all of the registerd functions for a given hook</span>
<a name="l00232"></a>00232 <span class="comment"> */</span>
<a name="l00233"></a>00233 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___hook.html#ga1e0b6cf91dac5417c1b9cbd1b46b8991">apr_hook_sort_all</a>(<span class="keywordtype">void</span>);
<a name="l00234"></a>00234 <span class="comment"></span>
<a name="l00235"></a>00235 <span class="comment">/**</span>
<a name="l00236"></a>00236 <span class="comment"> * Print all of the information about the current hook. This is used for</span>
<a name="l00237"></a>00237 <span class="comment"> * debugging purposes.</span>
<a name="l00238"></a>00238 <span class="comment"> * @param szName The name of the hook</span>
<a name="l00239"></a>00239 <span class="comment"> * @param aszPre All of the functions in the predecessor array</span>
<a name="l00240"></a>00240 <span class="comment"> * @param aszSucc All of the functions in the successor array</span>
<a name="l00241"></a>00241 <span class="comment"> */</span>
<a name="l00242"></a>00242 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___hook.html#ga1de31557683f53c2a07f73990962c585">apr_hook_debug_show</a>(const <span class="keywordtype">char</span> *szName,
<a name="l00243"></a>00243 const <span class="keywordtype">char</span> * const *aszPre,
<a name="l00244"></a>00244 const <span class="keywordtype">char</span> * const *aszSucc);
<a name="l00245"></a>00245 <span class="comment"></span>
<a name="l00246"></a>00246 <span class="comment">/**</span>
<a name="l00247"></a>00247 <span class="comment"> * Remove all currently registered functions.</span>
<a name="l00248"></a>00248 <span class="comment"> */</span>
<a name="l00249"></a>00249 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___hook.html#ga5d20451da75574c8433feb1bd5b2ce10">apr_hook_deregister_all</a>(<span class="keywordtype">void</span>);
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">/** @} */</span>
<a name="l00252"></a>00252 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00253"></a>00253 <span class="preprocessor"></span>}
<a name="l00254"></a>00254 <span class="preprocessor">#endif</span>
<a name="l00255"></a>00255 <span class="preprocessor"></span>
<a name="l00256"></a>00256 <span class="preprocessor">#endif </span><span class="comment">/* APR_HOOKS_H */</span>
</pre></div></div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
