Debian Codegraph @

docs/html/apreq__util_8h.html

raw
1 <html>
2 <head>
3 <link rel="stylesheet" type="text/css" href="dox.css" />
4 <title>libapreq2-2.17: include/apreq_util.h File Reference</title>
5 </head>
6 <body>
7 <div id="page-header">
8 <p class="menu">
9 <a href="http://www.apache.org/">Apache Software Foundation</a> &gt; <a href="http://httpd.apache.org">HTTP Server Project</a> &gt;
10 <a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
11 <p class="apache">Apache HTTP Server Request Library</p>
12 <img alt="" src="feather.gif" /></div>
13 <!-- Generated by Doxygen 1.9.1 -->
14 <script type="text/javascript" src="menudata.js"></script>
15 <script type="text/javascript" src="menu.js"></script>
16 <script type="text/javascript">
17 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
18 $(function() {
19 initMenu('',false,false,'search.php','Search');
20 });
21 /* @license-end */</script>
22 <div id="main-nav"></div>
23 <div id="nav-path" class="navpath">
24 <ul>
25 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
26 </div>
27 </div><!-- top -->
28 <div class="header">
29 <div class="summary">
30 <a href="#func-members">Functions</a> </div>
31 <div class="headertitle">
32 <div class="title">apreq_util.h File Reference<div class="ingroups"><a class="el" href="group__libapreq2.html">Apache Request Library</a></div></div> </div>
33 </div><!--header-->
34 <div class="contents">
35
36 <p>Utility functions for apreq.
37 <a href="#details">More...</a></p>
38 <div class="textblock"><code>#include &quot;apr_file_io.h&quot;</code><br />
39 <code>#include &quot;apr_buckets.h&quot;</code><br />
40 <code>#include &quot;<a class="el" href="apreq_8h_source.html">apreq.h</a>&quot;</code><br />
41 </div>
42 <p><a href="apreq__util_8h_source.html">Go to the source code of this file.</a></p>
43 <table class="memberdecls">
44 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
45 Functions</h2></td></tr>
46 <tr class="memitem:a1aa668dc806fce4bd0fef348d1601930"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a1aa668dc806fce4bd0fef348d1601930">apreq_join</a> (apr_pool_t *p, const char *sep, const apr_array_header_t *arr, <a class="el" href="apreq_8h.html#ac3784c04255e92629350505d35b0473e">apreq_join_t</a> mode)</td></tr>
47 <tr class="separator:a1aa668dc806fce4bd0fef348d1601930"><td class="memSeparator" colspan="2">&#160;</td></tr>
48 <tr class="memitem:ac72c51ffe478faa804eaea5f68276dd8"><td class="memItemLeft" align="right" valign="top">apr_ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#ac72c51ffe478faa804eaea5f68276dd8">apreq_index</a> (const char *hay, apr_size_t hlen, const char *ndl, apr_size_t nlen, const <a class="el" href="apreq_8h.html#a590d7bfd9cd294f652d388c4f37fc8d5">apreq_match_t</a> type)</td></tr>
49 <tr class="separator:ac72c51ffe478faa804eaea5f68276dd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
50 <tr class="memitem:ab4aa9bed839bb576444f464666e0bd85"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#ab4aa9bed839bb576444f464666e0bd85">apreq_quote</a> (char *dest, const char *src, const apr_size_t slen)</td></tr>
51 <tr class="separator:ab4aa9bed839bb576444f464666e0bd85"><td class="memSeparator" colspan="2">&#160;</td></tr>
52 <tr class="memitem:afef8b7af9d36b0f7ec24e9d0f64a29a7"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#afef8b7af9d36b0f7ec24e9d0f64a29a7">apreq_quote_once</a> (char *dest, const char *src, const apr_size_t slen)</td></tr>
53 <tr class="separator:afef8b7af9d36b0f7ec24e9d0f64a29a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
54 <tr class="memitem:a034ccdfdcf751be6c0f8c2a1d30c2ae6"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a034ccdfdcf751be6c0f8c2a1d30c2ae6">apreq_encode</a> (char *dest, const char *src, const apr_size_t slen)</td></tr>
55 <tr class="separator:a034ccdfdcf751be6c0f8c2a1d30c2ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
56 <tr class="memitem:a801aa204656988ff4aa32cec6dd80e5a"><td class="memItemLeft" align="right" valign="top">apr_size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a801aa204656988ff4aa32cec6dd80e5a">apreq_cp1252_to_utf8</a> (char *dest, const char *src, apr_size_t slen)</td></tr>
57 <tr class="separator:a801aa204656988ff4aa32cec6dd80e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:ae11e0b3e2304a2e8c30aaa464ea78037"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#ae11e0b3e2304a2e8c30aaa464ea78037">apreq_charset_divine</a> (const char *src, apr_size_t slen)</td></tr>
59 <tr class="separator:ae11e0b3e2304a2e8c30aaa464ea78037"><td class="memSeparator" colspan="2">&#160;</td></tr>
60 <tr class="memitem:a3c1d46b8c0e7991ae1ced0178c2f4738"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a3c1d46b8c0e7991ae1ced0178c2f4738">apreq_decode</a> (char *dest, apr_size_t *dlen, const char *src, apr_size_t slen)</td></tr>
61 <tr class="separator:a3c1d46b8c0e7991ae1ced0178c2f4738"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:a13a090a30a4d05353caabab92a67179d"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a13a090a30a4d05353caabab92a67179d">apreq_decodev</a> (char *dest, apr_size_t *dlen, struct iovec *v, int nelts)</td></tr>
63 <tr class="separator:a13a090a30a4d05353caabab92a67179d"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a785be2ceae273b0a7b2ffda223b2ebae"><td class="memItemLeft" align="right" valign="top">static APR_INLINE char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a785be2ceae273b0a7b2ffda223b2ebae">apreq_escape</a> (apr_pool_t *p, const char *src, const apr_size_t slen)</td></tr>
65 <tr class="separator:a785be2ceae273b0a7b2ffda223b2ebae"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <tr class="memitem:a979c0af9322189581bde4644eec5fd41"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a979c0af9322189581bde4644eec5fd41">apreq_unescape</a> (char *str)</td></tr>
67 <tr class="separator:a979c0af9322189581bde4644eec5fd41"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a69acb9425572cb8f694d49277160b1f7"><td class="memItemLeft" align="right" valign="top">apr_int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a69acb9425572cb8f694d49277160b1f7">apreq_atoi64f</a> (const char *s)</td></tr>
69 <tr class="separator:a69acb9425572cb8f694d49277160b1f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a4e838a92724aa7d9be0b978dc5c4e50c"><td class="memItemLeft" align="right" valign="top">apr_int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a4e838a92724aa7d9be0b978dc5c4e50c">apreq_atoi64t</a> (const char *s)</td></tr>
71 <tr class="separator:a4e838a92724aa7d9be0b978dc5c4e50c"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 <tr class="memitem:a3bbe5ee2d1537c6a9f30d0fed9f5f1e1"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a3bbe5ee2d1537c6a9f30d0fed9f5f1e1">apreq_brigade_fwrite</a> (apr_file_t *f, apr_off_t *wlen, apr_bucket_brigade *bb)</td></tr>
73 <tr class="separator:a3bbe5ee2d1537c6a9f30d0fed9f5f1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <tr class="memitem:ab266a81c528de92654eb37f9890c4a7d"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#ab266a81c528de92654eb37f9890c4a7d">apreq_file_mktemp</a> (apr_file_t **fp, apr_pool_t *pool, const char *path)</td></tr>
75 <tr class="separator:ab266a81c528de92654eb37f9890c4a7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a91f3144692934b2daf54fb3c9ca7b180"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a91f3144692934b2daf54fb3c9ca7b180">apreq_brigade_setaside</a> (apr_bucket_brigade *bb, apr_pool_t *p)</td></tr>
77 <tr class="separator:a91f3144692934b2daf54fb3c9ca7b180"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:ab4def9e77622cf22cfa427e7fbf2ac45"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#ab4def9e77622cf22cfa427e7fbf2ac45">apreq_brigade_copy</a> (apr_bucket_brigade *d, apr_bucket_brigade *s)</td></tr>
79 <tr class="separator:ab4def9e77622cf22cfa427e7fbf2ac45"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:aa23561a0d169b50454a815926ccc0ba5"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#aa23561a0d169b50454a815926ccc0ba5">apreq_brigade_move</a> (apr_bucket_brigade *d, apr_bucket_brigade *s, apr_bucket *e)</td></tr>
81 <tr class="separator:aa23561a0d169b50454a815926ccc0ba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a8195b6a32954928a6088e7cea077dd75"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a8195b6a32954928a6088e7cea077dd75">apreq_header_attribute</a> (const char *hdr, const char *name, const apr_size_t nlen, const char **val, apr_size_t *vlen)</td></tr>
83 <tr class="separator:a8195b6a32954928a6088e7cea077dd75"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a4ddf563c9902474bdedbf014e24aafc8"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#a4ddf563c9902474bdedbf014e24aafc8">apreq_brigade_concat</a> (apr_pool_t *pool, const char *temp_dir, apr_size_t brigade_limit, apr_bucket_brigade *out, apr_bucket_brigade *in)</td></tr>
85 <tr class="separator:a4ddf563c9902474bdedbf014e24aafc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:aec0de2141b6b742a1468667eb8f8158e"><td class="memItemLeft" align="right" valign="top">apr_file_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__util_8h.html#aec0de2141b6b742a1468667eb8f8158e">apreq_brigade_spoolfile</a> (apr_bucket_brigade *bb)</td></tr>
87 <tr class="separator:aec0de2141b6b742a1468667eb8f8158e"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 </table>
89 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
90 <div class="textblock"><p>Utility functions for apreq. </p>
91 <p>This header contains useful functions for creating new parsers, hooks or modules. It includes</p>
92 <ul>
93 <li>string &lt;-&gt; array converters</li>
94 <li>substring search functions</li>
95 <li>simple encoders &amp; decoders for urlencoded strings</li>
96 <li>simple time, date, &amp; file-size converters </li>
97 </ul>
98 </div><h2 class="groupheader">Function Documentation</h2>
99 <a id="a69acb9425572cb8f694d49277160b1f7"></a>
100 <h2 class="memtitle"><span class="permalink"><a href="#a69acb9425572cb8f694d49277160b1f7">&#9670;&nbsp;</a></span>apreq_atoi64f()</h2>
101
102 <div class="memitem">
103 <div class="memproto">
104 <table class="memname">
105 <tr>
106 <td class="memname">apr_int64_t apreq_atoi64f </td>
107 <td>(</td>
108 <td class="paramtype">const char *&#160;</td>
109 <td class="paramname"><em>s</em></td><td>)</td>
110 <td></td>
111 </tr>
112 </table>
113 </div><div class="memdoc">
114 <p>Converts file sizes (KMG) to bytes</p>
115 <dl class="params"><dt>Parameters</dt><dd>
116 <table class="params">
117 <tr><td class="paramname">s</td><td>file size matching m/^\d+[KMG]b?$/i</td></tr>
118 </table>
119 </dd>
120 </dl>
121 <dl class="section return"><dt>Returns</dt><dd>64-bit integer representation of s.</dd></dl>
122 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>What happens when s is malformed? Should this return an unsigned value instead? </dd></dl>
123
124 </div>
125 </div>
126 <a id="a4e838a92724aa7d9be0b978dc5c4e50c"></a>
127 <h2 class="memtitle"><span class="permalink"><a href="#a4e838a92724aa7d9be0b978dc5c4e50c">&#9670;&nbsp;</a></span>apreq_atoi64t()</h2>
128
129 <div class="memitem">
130 <div class="memproto">
131 <table class="memname">
132 <tr>
133 <td class="memname">apr_int64_t apreq_atoi64t </td>
134 <td>(</td>
135 <td class="paramtype">const char *&#160;</td>
136 <td class="paramname"><em>s</em></td><td>)</td>
137 <td></td>
138 </tr>
139 </table>
140 </div><div class="memdoc">
141 <p>Converts time strings (YMDhms) to seconds</p>
142 <dl class="params"><dt>Parameters</dt><dd>
143 <table class="params">
144 <tr><td class="paramname">s</td><td>time string matching m/^\+?\d+[YMDhms]$/</td></tr>
145 </table>
146 </dd>
147 </dl>
148 <dl class="section return"><dt>Returns</dt><dd>64-bit integer representation of s as seconds.</dd></dl>
149 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>What happens when s is malformed? Should this return an unsigned value instead? </dd></dl>
150
151 </div>
152 </div>
153 <a id="a4ddf563c9902474bdedbf014e24aafc8"></a>
154 <h2 class="memtitle"><span class="permalink"><a href="#a4ddf563c9902474bdedbf014e24aafc8">&#9670;&nbsp;</a></span>apreq_brigade_concat()</h2>
155
156 <div class="memitem">
157 <div class="memproto">
158 <table class="memname">
159 <tr>
160 <td class="memname">apr_status_t apreq_brigade_concat </td>
161 <td>(</td>
162 <td class="paramtype">apr_pool_t *&#160;</td>
163 <td class="paramname"><em>pool</em>, </td>
164 </tr>
165 <tr>
166 <td class="paramkey"></td>
167 <td></td>
168 <td class="paramtype">const char *&#160;</td>
169 <td class="paramname"><em>temp_dir</em>, </td>
170 </tr>
171 <tr>
172 <td class="paramkey"></td>
173 <td></td>
174 <td class="paramtype">apr_size_t&#160;</td>
175 <td class="paramname"><em>brigade_limit</em>, </td>
176 </tr>
177 <tr>
178 <td class="paramkey"></td>
179 <td></td>
180 <td class="paramtype">apr_bucket_brigade *&#160;</td>
181 <td class="paramname"><em>out</em>, </td>
182 </tr>
183 <tr>
184 <td class="paramkey"></td>
185 <td></td>
186 <td class="paramtype">apr_bucket_brigade *&#160;</td>
187 <td class="paramname"><em>in</em>&#160;</td>
188 </tr>
189 <tr>
190 <td></td>
191 <td>)</td>
192 <td></td><td></td>
193 </tr>
194 </table>
195 </div><div class="memdoc">
196 <p>Concatenates the brigades, spooling large brigades into a tempfile (APREQ_SPOOL) bucket.</p>
197 <dl class="params"><dt>Parameters</dt><dd>
198 <table class="params">
199 <tr><td class="paramname">pool</td><td>Pool for creating a tempfile bucket. </td></tr>
200 <tr><td class="paramname">temp_dir</td><td>Directory for tempfile creation. </td></tr>
201 <tr><td class="paramname">brigade_limit</td><td>If out's length would exceed this value, the appended buckets get written to a tempfile. </td></tr>
202 <tr><td class="paramname">out</td><td>Resulting brigade. </td></tr>
203 <tr><td class="paramname">in</td><td>Brigade to append.</td></tr>
204 </table>
205 </dd>
206 </dl>
207 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
208 <dd>
209 Error status code resulting from either apr_brigade_length(), <a class="el" href="apreq__util_8h.html#ab266a81c528de92654eb37f9890c4a7d">apreq_file_mktemp()</a>, <a class="el" href="apreq__util_8h.html#a3bbe5ee2d1537c6a9f30d0fed9f5f1e1">apreq_brigade_fwrite()</a>, or apr_file_seek().</dd></dl>
210 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Flesh out these error codes, making them as explicit as possible. </dd></dl>
211
212 </div>
213 </div>
214 <a id="ab4def9e77622cf22cfa427e7fbf2ac45"></a>
215 <h2 class="memtitle"><span class="permalink"><a href="#ab4def9e77622cf22cfa427e7fbf2ac45">&#9670;&nbsp;</a></span>apreq_brigade_copy()</h2>
216
217 <div class="memitem">
218 <div class="memproto">
219 <table class="mlabels">
220 <tr>
221 <td class="mlabels-left">
222 <table class="memname">
223 <tr>
224 <td class="memname">static APR_INLINE apr_status_t apreq_brigade_copy </td>
225 <td>(</td>
226 <td class="paramtype">apr_bucket_brigade *&#160;</td>
227 <td class="paramname"><em>d</em>, </td>
228 </tr>
229 <tr>
230 <td class="paramkey"></td>
231 <td></td>
232 <td class="paramtype">apr_bucket_brigade *&#160;</td>
233 <td class="paramname"><em>s</em>&#160;</td>
234 </tr>
235 <tr>
236 <td></td>
237 <td>)</td>
238 <td></td><td></td>
239 </tr>
240 </table>
241 </td>
242 <td class="mlabels-right">
243 <span class="mlabels"><span class="mlabel">static</span></span> </td>
244 </tr>
245 </table>
246 </div><div class="memdoc">
247 <p>Copy a brigade.</p>
248 <dl class="params"><dt>Parameters</dt><dd>
249 <table class="params">
250 <tr><td class="paramname">d</td><td>(destination) Copied buckets are appended to this brigade. </td></tr>
251 <tr><td class="paramname">s</td><td>(source) Brigade to copy from.</td></tr>
252 </table>
253 </dd>
254 </dl>
255 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
256 <dd>
257 Error status code from an unsuccessful apr_bucket_copy().</dd></dl>
258 <dl class="section remark"><dt>Remarks</dt><dd>s == d produces Undefined Behavior. </dd></dl>
259
260 </div>
261 </div>
262 <a id="a3bbe5ee2d1537c6a9f30d0fed9f5f1e1"></a>
263 <h2 class="memtitle"><span class="permalink"><a href="#a3bbe5ee2d1537c6a9f30d0fed9f5f1e1">&#9670;&nbsp;</a></span>apreq_brigade_fwrite()</h2>
264
265 <div class="memitem">
266 <div class="memproto">
267 <table class="memname">
268 <tr>
269 <td class="memname">apr_status_t apreq_brigade_fwrite </td>
270 <td>(</td>
271 <td class="paramtype">apr_file_t *&#160;</td>
272 <td class="paramname"><em>f</em>, </td>
273 </tr>
274 <tr>
275 <td class="paramkey"></td>
276 <td></td>
277 <td class="paramtype">apr_off_t *&#160;</td>
278 <td class="paramname"><em>wlen</em>, </td>
279 </tr>
280 <tr>
281 <td class="paramkey"></td>
282 <td></td>
283 <td class="paramtype">apr_bucket_brigade *&#160;</td>
284 <td class="paramname"><em>bb</em>&#160;</td>
285 </tr>
286 <tr>
287 <td></td>
288 <td>)</td>
289 <td></td><td></td>
290 </tr>
291 </table>
292 </div><div class="memdoc">
293 <p>Writes brigade to a file.</p>
294 <dl class="params"><dt>Parameters</dt><dd>
295 <table class="params">
296 <tr><td class="paramname">f</td><td>File that gets the brigade. </td></tr>
297 <tr><td class="paramname">wlen</td><td>On a successful return, wlen holds the length of the brigade, which is the amount of data written to the file. </td></tr>
298 <tr><td class="paramname">bb</td><td>Bucket brigade.</td></tr>
299 </table>
300 </dd>
301 </dl>
302 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
303 <dd>
304 Error status code from either an unsuccessful apr_bucket_read(), or a failed apr_file_writev().</dd></dl>
305 <dl class="section remark"><dt>Remarks</dt><dd>This function leaks a bucket brigade into bb-&gt;p whenever the final bucket in bb is a spool bucket. </dd></dl>
306
307 </div>
308 </div>
309 <a id="aa23561a0d169b50454a815926ccc0ba5"></a>
310 <h2 class="memtitle"><span class="permalink"><a href="#aa23561a0d169b50454a815926ccc0ba5">&#9670;&nbsp;</a></span>apreq_brigade_move()</h2>
311
312 <div class="memitem">
313 <div class="memproto">
314 <table class="mlabels">
315 <tr>
316 <td class="mlabels-left">
317 <table class="memname">
318 <tr>
319 <td class="memname">static APR_INLINE void apreq_brigade_move </td>
320 <td>(</td>
321 <td class="paramtype">apr_bucket_brigade *&#160;</td>
322 <td class="paramname"><em>d</em>, </td>
323 </tr>
324 <tr>
325 <td class="paramkey"></td>
326 <td></td>
327 <td class="paramtype">apr_bucket_brigade *&#160;</td>
328 <td class="paramname"><em>s</em>, </td>
329 </tr>
330 <tr>
331 <td class="paramkey"></td>
332 <td></td>
333 <td class="paramtype">apr_bucket *&#160;</td>
334 <td class="paramname"><em>e</em>&#160;</td>
335 </tr>
336 <tr>
337 <td></td>
338 <td>)</td>
339 <td></td><td></td>
340 </tr>
341 </table>
342 </td>
343 <td class="mlabels-right">
344 <span class="mlabels"><span class="mlabel">static</span></span> </td>
345 </tr>
346 </table>
347 </div><div class="memdoc">
348 <p>Move the front of a brigade.</p>
349 <dl class="params"><dt>Parameters</dt><dd>
350 <table class="params">
351 <tr><td class="paramname">d</td><td>(destination) Append buckets to this brigade. </td></tr>
352 <tr><td class="paramname">s</td><td>(source) Brigade to take buckets from. </td></tr>
353 <tr><td class="paramname">e</td><td>First bucket of s after the move. All buckets before e are appended to d.</td></tr>
354 </table>
355 </dd>
356 </dl>
357 <dl class="section remark"><dt>Remarks</dt><dd>This moves all buckets when e == APR_BRIGADE_SENTINEL(s). </dd></dl>
358
359 </div>
360 </div>
361 <a id="a91f3144692934b2daf54fb3c9ca7b180"></a>
362 <h2 class="memtitle"><span class="permalink"><a href="#a91f3144692934b2daf54fb3c9ca7b180">&#9670;&nbsp;</a></span>apreq_brigade_setaside()</h2>
363
364 <div class="memitem">
365 <div class="memproto">
366 <table class="mlabels">
367 <tr>
368 <td class="mlabels-left">
369 <table class="memname">
370 <tr>
371 <td class="memname">static APR_INLINE apr_status_t apreq_brigade_setaside </td>
372 <td>(</td>
373 <td class="paramtype">apr_bucket_brigade *&#160;</td>
374 <td class="paramname"><em>bb</em>, </td>
375 </tr>
376 <tr>
377 <td class="paramkey"></td>
378 <td></td>
379 <td class="paramtype">apr_pool_t *&#160;</td>
380 <td class="paramname"><em>p</em>&#160;</td>
381 </tr>
382 <tr>
383 <td></td>
384 <td>)</td>
385 <td></td><td></td>
386 </tr>
387 </table>
388 </td>
389 <td class="mlabels-right">
390 <span class="mlabels"><span class="mlabel">static</span></span> </td>
391 </tr>
392 </table>
393 </div><div class="memdoc">
394 <p>Set aside all buckets in the brigade.</p>
395 <dl class="params"><dt>Parameters</dt><dd>
396 <table class="params">
397 <tr><td class="paramname">bb</td><td>Brigade. </td></tr>
398 <tr><td class="paramname">p</td><td>Setaside buckets into this pool. </td></tr>
399 </table>
400 </dd>
401 </dl>
402 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
403 <dd>
404 Error status code from an unsuccessful apr_bucket_setaside(). </dd></dl>
405
406 </div>
407 </div>
408 <a id="aec0de2141b6b742a1468667eb8f8158e"></a>
409 <h2 class="memtitle"><span class="permalink"><a href="#aec0de2141b6b742a1468667eb8f8158e">&#9670;&nbsp;</a></span>apreq_brigade_spoolfile()</h2>
410
411 <div class="memitem">
412 <div class="memproto">
413 <table class="memname">
414 <tr>
415 <td class="memname">apr_file_t* apreq_brigade_spoolfile </td>
416 <td>(</td>
417 <td class="paramtype">apr_bucket_brigade *&#160;</td>
418 <td class="paramname"><em>bb</em></td><td>)</td>
419 <td></td>
420 </tr>
421 </table>
422 </div><div class="memdoc">
423 <p>Determines the spool file used by the brigade. Returns NULL if the brigade is not spooled in a file (does not use an APREQ_SPOOL bucket).</p>
424 <dl class="params"><dt>Parameters</dt><dd>
425 <table class="params">
426 <tr><td class="paramname">bb</td><td>the bucket brigade </td></tr>
427 </table>
428 </dd>
429 </dl>
430 <dl class="section return"><dt>Returns</dt><dd>the spool file, or NULL. </dd></dl>
431
432 </div>
433 </div>
434 <a id="ae11e0b3e2304a2e8c30aaa464ea78037"></a>
435 <h2 class="memtitle"><span class="permalink"><a href="#ae11e0b3e2304a2e8c30aaa464ea78037">&#9670;&nbsp;</a></span>apreq_charset_divine()</h2>
436
437 <div class="memitem">
438 <div class="memproto">
439 <table class="memname">
440 <tr>
441 <td class="memname"><a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> apreq_charset_divine </td>
442 <td>(</td>
443 <td class="paramtype">const char *&#160;</td>
444 <td class="paramname"><em>src</em>, </td>
445 </tr>
446 <tr>
447 <td class="paramkey"></td>
448 <td></td>
449 <td class="paramtype">apr_size_t&#160;</td>
450 <td class="paramname"><em>slen</em>&#160;</td>
451 </tr>
452 <tr>
453 <td></td>
454 <td>)</td>
455 <td></td><td></td>
456 </tr>
457 </table>
458 </div><div class="memdoc">
459 <p>Heuristically determine the charset of a string.</p>
460 <dl class="params"><dt>Parameters</dt><dd>
461 <table class="params">
462 <tr><td class="paramname">src</td><td>String to scan. </td></tr>
463 <tr><td class="paramname">slen</td><td>Length of string.</td></tr>
464 </table>
465 </dd>
466 </dl>
467 <dl class="section return"><dt>Returns</dt><dd>APREQ_CHARSET_ASCII if the string contains only 7-bit chars; </dd>
468 <dd>
469 APREQ_CHARSET_UTF8 if the string is a valid utf8 byte sequence; </dd>
470 <dd>
471 APREQ_CHARSET_LATIN1 if the string has no control chars; </dd>
472 <dd>
473 APREQ_CHARSET_CP1252 if the string has control chars. </dd></dl>
474
475 </div>
476 </div>
477 <a id="a801aa204656988ff4aa32cec6dd80e5a"></a>
478 <h2 class="memtitle"><span class="permalink"><a href="#a801aa204656988ff4aa32cec6dd80e5a">&#9670;&nbsp;</a></span>apreq_cp1252_to_utf8()</h2>
479
480 <div class="memitem">
481 <div class="memproto">
482 <table class="memname">
483 <tr>
484 <td class="memname">apr_size_t apreq_cp1252_to_utf8 </td>
485 <td>(</td>
486 <td class="paramtype">char *&#160;</td>
487 <td class="paramname"><em>dest</em>, </td>
488 </tr>
489 <tr>
490 <td class="paramkey"></td>
491 <td></td>
492 <td class="paramtype">const char *&#160;</td>
493 <td class="paramname"><em>src</em>, </td>
494 </tr>
495 <tr>
496 <td class="paramkey"></td>
497 <td></td>
498 <td class="paramtype">apr_size_t&#160;</td>
499 <td class="paramname"><em>slen</em>&#160;</td>
500 </tr>
501 <tr>
502 <td></td>
503 <td>)</td>
504 <td></td><td></td>
505 </tr>
506 </table>
507 </div><div class="memdoc">
508 <p>Convert a string from cp1252 to utf8. Caller must ensure it is large enough to hold the encoded string and trailing '\0'.</p>
509 <dl class="params"><dt>Parameters</dt><dd>
510 <table class="params">
511 <tr><td class="paramname">dest</td><td>Location of utf8-encoded result string. Caller must ensure it is large enough to hold the encoded string and trailing '\0'. </td></tr>
512 <tr><td class="paramname">src</td><td>Original string. </td></tr>
513 <tr><td class="paramname">slen</td><td>Length of original string.</td></tr>
514 </table>
515 </dd>
516 </dl>
517 <dl class="section return"><dt>Returns</dt><dd>length of utf8-encoded string in dest; does not exceed 3 * slen. </dd></dl>
518
519 </div>
520 </div>
521 <a id="a3c1d46b8c0e7991ae1ced0178c2f4738"></a>
522 <h2 class="memtitle"><span class="permalink"><a href="#a3c1d46b8c0e7991ae1ced0178c2f4738">&#9670;&nbsp;</a></span>apreq_decode()</h2>
523
524 <div class="memitem">
525 <div class="memproto">
526 <table class="memname">
527 <tr>
528 <td class="memname">apr_status_t apreq_decode </td>
529 <td>(</td>
530 <td class="paramtype">char *&#160;</td>
531 <td class="paramname"><em>dest</em>, </td>
532 </tr>
533 <tr>
534 <td class="paramkey"></td>
535 <td></td>
536 <td class="paramtype">apr_size_t *&#160;</td>
537 <td class="paramname"><em>dlen</em>, </td>
538 </tr>
539 <tr>
540 <td class="paramkey"></td>
541 <td></td>
542 <td class="paramtype">const char *&#160;</td>
543 <td class="paramname"><em>src</em>, </td>
544 </tr>
545 <tr>
546 <td class="paramkey"></td>
547 <td></td>
548 <td class="paramtype">apr_size_t&#160;</td>
549 <td class="paramname"><em>slen</em>&#160;</td>
550 </tr>
551 <tr>
552 <td></td>
553 <td>)</td>
554 <td></td><td></td>
555 </tr>
556 </table>
557 </div><div class="memdoc">
558 <p>Url-decodes a string.</p>
559 <dl class="params"><dt>Parameters</dt><dd>
560 <table class="params">
561 <tr><td class="paramname">dest</td><td>Location of url-encoded result string. Caller must ensure dest is large enough to hold the encoded string and trailing null character. </td></tr>
562 <tr><td class="paramname">dlen</td><td>points to resultant length of url-decoded string in dest </td></tr>
563 <tr><td class="paramname">src</td><td>Original string. </td></tr>
564 <tr><td class="paramname">slen</td><td>Length of original string.</td></tr>
565 </table>
566 </dd>
567 </dl>
568 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
569 <dd>
570 APR_INCOMPLETE if the string ends in the middle of an escape sequence. </dd>
571 <dd>
572 <a class="el" href="apreq__error_8h.html#a73a69e21acc2cf849310a421ab43d2ba">APREQ_ERROR_BADSEQ</a> or <a class="el" href="apreq__error_8h.html#a04b6a01738a1ee7fd1ecc79d256e721f">APREQ_ERROR_BADCHAR</a> on malformed input.</dd></dl>
573 <dl class="section remark"><dt>Remarks</dt><dd>In the non-success case, dlen will be set to include the last successfully decoded value. This function decodes %uXXXX into a utf8 (wide) character, following ECMA-262 (the Javascript spec) Section B.2.1. </dd></dl>
574
575 </div>
576 </div>
577 <a id="a13a090a30a4d05353caabab92a67179d"></a>
578 <h2 class="memtitle"><span class="permalink"><a href="#a13a090a30a4d05353caabab92a67179d">&#9670;&nbsp;</a></span>apreq_decodev()</h2>
579
580 <div class="memitem">
581 <div class="memproto">
582 <table class="memname">
583 <tr>
584 <td class="memname">apr_status_t apreq_decodev </td>
585 <td>(</td>
586 <td class="paramtype">char *&#160;</td>
587 <td class="paramname"><em>dest</em>, </td>
588 </tr>
589 <tr>
590 <td class="paramkey"></td>
591 <td></td>
592 <td class="paramtype">apr_size_t *&#160;</td>
593 <td class="paramname"><em>dlen</em>, </td>
594 </tr>
595 <tr>
596 <td class="paramkey"></td>
597 <td></td>
598 <td class="paramtype">struct iovec *&#160;</td>
599 <td class="paramname"><em>v</em>, </td>
600 </tr>
601 <tr>
602 <td class="paramkey"></td>
603 <td></td>
604 <td class="paramtype">int&#160;</td>
605 <td class="paramname"><em>nelts</em>&#160;</td>
606 </tr>
607 <tr>
608 <td></td>
609 <td>)</td>
610 <td></td><td></td>
611 </tr>
612 </table>
613 </div><div class="memdoc">
614 <p>Url-decodes an iovec array.</p>
615 <dl class="params"><dt>Parameters</dt><dd>
616 <table class="params">
617 <tr><td class="paramname">dest</td><td>Location of url-encoded result string. Caller must ensure dest is large enough to hold the encoded string and trailing null character. </td></tr>
618 <tr><td class="paramname">dlen</td><td>Resultant length of dest. </td></tr>
619 <tr><td class="paramname">v</td><td>Array of iovecs that represent the source string </td></tr>
620 <tr><td class="paramname">nelts</td><td>Number of iovecs in the array.</td></tr>
621 </table>
622 </dd>
623 </dl>
624 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
625 <dd>
626 APR_INCOMPLETE if the iovec ends in the middle of an escape sequence. </dd>
627 <dd>
628 <a class="el" href="apreq__error_8h.html#a73a69e21acc2cf849310a421ab43d2ba">APREQ_ERROR_BADSEQ</a> or <a class="el" href="apreq__error_8h.html#a04b6a01738a1ee7fd1ecc79d256e721f">APREQ_ERROR_BADCHAR</a> on malformed input.</dd></dl>
629 <dl class="section remark"><dt>Remarks</dt><dd>In the non-APR_SUCCESS case, dlen will be set to include the last successfully decoded value. This function decodes %uXXXX into a utf8 (wide) character, following ECMA-262 (the Javascript spec) Section B.2.1. </dd></dl>
630
631 </div>
632 </div>
633 <a id="a034ccdfdcf751be6c0f8c2a1d30c2ae6"></a>
634 <h2 class="memtitle"><span class="permalink"><a href="#a034ccdfdcf751be6c0f8c2a1d30c2ae6">&#9670;&nbsp;</a></span>apreq_encode()</h2>
635
636 <div class="memitem">
637 <div class="memproto">
638 <table class="memname">
639 <tr>
640 <td class="memname">apr_size_t apreq_encode </td>
641 <td>(</td>
642 <td class="paramtype">char *&#160;</td>
643 <td class="paramname"><em>dest</em>, </td>
644 </tr>
645 <tr>
646 <td class="paramkey"></td>
647 <td></td>
648 <td class="paramtype">const char *&#160;</td>
649 <td class="paramname"><em>src</em>, </td>
650 </tr>
651 <tr>
652 <td class="paramkey"></td>
653 <td></td>
654 <td class="paramtype">const apr_size_t&#160;</td>
655 <td class="paramname"><em>slen</em>&#160;</td>
656 </tr>
657 <tr>
658 <td></td>
659 <td>)</td>
660 <td></td><td></td>
661 </tr>
662 </table>
663 </div><div class="memdoc">
664 <p>Url-encodes a string.</p>
665 <dl class="params"><dt>Parameters</dt><dd>
666 <table class="params">
667 <tr><td class="paramname">dest</td><td>Location of url-encoded result string. Caller must ensure it is large enough to hold the encoded string and trailing '\0'. </td></tr>
668 <tr><td class="paramname">src</td><td>Original string. </td></tr>
669 <tr><td class="paramname">slen</td><td>Length of original string.</td></tr>
670 </table>
671 </dd>
672 </dl>
673 <dl class="section return"><dt>Returns</dt><dd>length of url-encoded string in dest; does not exceed 3 * slen. </dd></dl>
674
675 </div>
676 </div>
677 <a id="a785be2ceae273b0a7b2ffda223b2ebae"></a>
678 <h2 class="memtitle"><span class="permalink"><a href="#a785be2ceae273b0a7b2ffda223b2ebae">&#9670;&nbsp;</a></span>apreq_escape()</h2>
679
680 <div class="memitem">
681 <div class="memproto">
682 <table class="mlabels">
683 <tr>
684 <td class="mlabels-left">
685 <table class="memname">
686 <tr>
687 <td class="memname">static APR_INLINE char* apreq_escape </td>
688 <td>(</td>
689 <td class="paramtype">apr_pool_t *&#160;</td>
690 <td class="paramname"><em>p</em>, </td>
691 </tr>
692 <tr>
693 <td class="paramkey"></td>
694 <td></td>
695 <td class="paramtype">const char *&#160;</td>
696 <td class="paramname"><em>src</em>, </td>
697 </tr>
698 <tr>
699 <td class="paramkey"></td>
700 <td></td>
701 <td class="paramtype">const apr_size_t&#160;</td>
702 <td class="paramname"><em>slen</em>&#160;</td>
703 </tr>
704 <tr>
705 <td></td>
706 <td>)</td>
707 <td></td><td></td>
708 </tr>
709 </table>
710 </td>
711 <td class="mlabels-right">
712 <span class="mlabels"><span class="mlabel">static</span></span> </td>
713 </tr>
714 </table>
715 </div><div class="memdoc">
716 <p>Returns an url-encoded copy of a string.</p>
717 <dl class="params"><dt>Parameters</dt><dd>
718 <table class="params">
719 <tr><td class="paramname">p</td><td>Pool used to allocate the return value. </td></tr>
720 <tr><td class="paramname">src</td><td>Original string. </td></tr>
721 <tr><td class="paramname">slen</td><td>Length of original string.</td></tr>
722 </table>
723 </dd>
724 </dl>
725 <dl class="section return"><dt>Returns</dt><dd>The url-encoded string.</dd></dl>
726 <dl class="section remark"><dt>Remarks</dt><dd>Use this function insead of apreq_encode if its caller might otherwise overflow dest. </dd></dl>
727
728 </div>
729 </div>
730 <a id="ab266a81c528de92654eb37f9890c4a7d"></a>
731 <h2 class="memtitle"><span class="permalink"><a href="#ab266a81c528de92654eb37f9890c4a7d">&#9670;&nbsp;</a></span>apreq_file_mktemp()</h2>
732
733 <div class="memitem">
734 <div class="memproto">
735 <table class="memname">
736 <tr>
737 <td class="memname">apr_status_t apreq_file_mktemp </td>
738 <td>(</td>
739 <td class="paramtype">apr_file_t **&#160;</td>
740 <td class="paramname"><em>fp</em>, </td>
741 </tr>
742 <tr>
743 <td class="paramkey"></td>
744 <td></td>
745 <td class="paramtype">apr_pool_t *&#160;</td>
746 <td class="paramname"><em>pool</em>, </td>
747 </tr>
748 <tr>
749 <td class="paramkey"></td>
750 <td></td>
751 <td class="paramtype">const char *&#160;</td>
752 <td class="paramname"><em>path</em>&#160;</td>
753 </tr>
754 <tr>
755 <td></td>
756 <td>)</td>
757 <td></td><td></td>
758 </tr>
759 </table>
760 </div><div class="memdoc">
761 <p>Makes a temporary file.</p>
762 <dl class="params"><dt>Parameters</dt><dd>
763 <table class="params">
764 <tr><td class="paramname">fp</td><td>Points to the temporary apr_file_t on success. </td></tr>
765 <tr><td class="paramname">pool</td><td>Pool to associate with the temp file. When the pool is destroyed, the temp file will be closed and deleted. </td></tr>
766 <tr><td class="paramname">path</td><td>The base directory which will contain the temp file. If param == NULL, the directory will be selected via tempnam(). See the tempnam manpage for details.</td></tr>
767 </table>
768 </dd>
769 </dl>
770 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
771 <dd>
772 Error status code from unsuccessful apr_filepath_merge(), or a failed apr_file_mktemp(). </dd></dl>
773
774 </div>
775 </div>
776 <a id="a8195b6a32954928a6088e7cea077dd75"></a>
777 <h2 class="memtitle"><span class="permalink"><a href="#a8195b6a32954928a6088e7cea077dd75">&#9670;&nbsp;</a></span>apreq_header_attribute()</h2>
778
779 <div class="memitem">
780 <div class="memproto">
781 <table class="memname">
782 <tr>
783 <td class="memname">apr_status_t apreq_header_attribute </td>
784 <td>(</td>
785 <td class="paramtype">const char *&#160;</td>
786 <td class="paramname"><em>hdr</em>, </td>
787 </tr>
788 <tr>
789 <td class="paramkey"></td>
790 <td></td>
791 <td class="paramtype">const char *&#160;</td>
792 <td class="paramname"><em>name</em>, </td>
793 </tr>
794 <tr>
795 <td class="paramkey"></td>
796 <td></td>
797 <td class="paramtype">const apr_size_t&#160;</td>
798 <td class="paramname"><em>nlen</em>, </td>
799 </tr>
800 <tr>
801 <td class="paramkey"></td>
802 <td></td>
803 <td class="paramtype">const char **&#160;</td>
804 <td class="paramname"><em>val</em>, </td>
805 </tr>
806 <tr>
807 <td class="paramkey"></td>
808 <td></td>
809 <td class="paramtype">apr_size_t *&#160;</td>
810 <td class="paramname"><em>vlen</em>&#160;</td>
811 </tr>
812 <tr>
813 <td></td>
814 <td>)</td>
815 <td></td><td></td>
816 </tr>
817 </table>
818 </div><div class="memdoc">
819 <p>Search a header string for the value of a particular named attribute.</p>
820 <dl class="params"><dt>Parameters</dt><dd>
821 <table class="params">
822 <tr><td class="paramname">hdr</td><td>Header string to scan. </td></tr>
823 <tr><td class="paramname">name</td><td>Name of attribute to search for. </td></tr>
824 <tr><td class="paramname">nlen</td><td>Length of name. </td></tr>
825 <tr><td class="paramname">val</td><td>Location of (first) matching value. </td></tr>
826 <tr><td class="paramname">vlen</td><td>Length of matching value.</td></tr>
827 </table>
828 </dd>
829 </dl>
830 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
831 <dd>
832 <a class="el" href="apreq__error_8h.html#affdf9393e5c9277aeae3ea8d2ecf55fa">APREQ_ERROR_NOATTR</a> if the attribute is not found. </dd>
833 <dd>
834 <a class="el" href="apreq__error_8h.html#a73a69e21acc2cf849310a421ab43d2ba">APREQ_ERROR_BADSEQ</a> if an unpaired quote mark was detected. </dd></dl>
835
836 </div>
837 </div>
838 <a id="ac72c51ffe478faa804eaea5f68276dd8"></a>
839 <h2 class="memtitle"><span class="permalink"><a href="#ac72c51ffe478faa804eaea5f68276dd8">&#9670;&nbsp;</a></span>apreq_index()</h2>
840
841 <div class="memitem">
842 <div class="memproto">
843 <table class="memname">
844 <tr>
845 <td class="memname">apr_ssize_t apreq_index </td>
846 <td>(</td>
847 <td class="paramtype">const char *&#160;</td>
848 <td class="paramname"><em>hay</em>, </td>
849 </tr>
850 <tr>
851 <td class="paramkey"></td>
852 <td></td>
853 <td class="paramtype">apr_size_t&#160;</td>
854 <td class="paramname"><em>hlen</em>, </td>
855 </tr>
856 <tr>
857 <td class="paramkey"></td>
858 <td></td>
859 <td class="paramtype">const char *&#160;</td>
860 <td class="paramname"><em>ndl</em>, </td>
861 </tr>
862 <tr>
863 <td class="paramkey"></td>
864 <td></td>
865 <td class="paramtype">apr_size_t&#160;</td>
866 <td class="paramname"><em>nlen</em>, </td>
867 </tr>
868 <tr>
869 <td class="paramkey"></td>
870 <td></td>
871 <td class="paramtype">const <a class="el" href="apreq_8h.html#a590d7bfd9cd294f652d388c4f37fc8d5">apreq_match_t</a>&#160;</td>
872 <td class="paramname"><em>type</em>&#160;</td>
873 </tr>
874 <tr>
875 <td></td>
876 <td>)</td>
877 <td></td><td></td>
878 </tr>
879 </table>
880 </div><div class="memdoc">
881 <p>Returns offset of match string's location, or -1 if no match is found.</p>
882 <dl class="params"><dt>Parameters</dt><dd>
883 <table class="params">
884 <tr><td class="paramname">hay</td><td>Location of bytes to scan. </td></tr>
885 <tr><td class="paramname">hlen</td><td>Number of bytes available for scanning. </td></tr>
886 <tr><td class="paramname">ndl</td><td>Search string </td></tr>
887 <tr><td class="paramname">nlen</td><td>Length of search string. </td></tr>
888 <tr><td class="paramname">type</td><td>Match type.</td></tr>
889 </table>
890 </dd>
891 </dl>
892 <dl class="section return"><dt>Returns</dt><dd>Offset of match string, or -1 if no match is found. </dd></dl>
893
894 </div>
895 </div>
896 <a id="a1aa668dc806fce4bd0fef348d1601930"></a>
897 <h2 class="memtitle"><span class="permalink"><a href="#a1aa668dc806fce4bd0fef348d1601930">&#9670;&nbsp;</a></span>apreq_join()</h2>
898
899 <div class="memitem">
900 <div class="memproto">
901 <table class="memname">
902 <tr>
903 <td class="memname">char* apreq_join </td>
904 <td>(</td>
905 <td class="paramtype">apr_pool_t *&#160;</td>
906 <td class="paramname"><em>p</em>, </td>
907 </tr>
908 <tr>
909 <td class="paramkey"></td>
910 <td></td>
911 <td class="paramtype">const char *&#160;</td>
912 <td class="paramname"><em>sep</em>, </td>
913 </tr>
914 <tr>
915 <td class="paramkey"></td>
916 <td></td>
917 <td class="paramtype">const apr_array_header_t *&#160;</td>
918 <td class="paramname"><em>arr</em>, </td>
919 </tr>
920 <tr>
921 <td class="paramkey"></td>
922 <td></td>
923 <td class="paramtype"><a class="el" href="apreq_8h.html#ac3784c04255e92629350505d35b0473e">apreq_join_t</a>&#160;</td>
924 <td class="paramname"><em>mode</em>&#160;</td>
925 </tr>
926 <tr>
927 <td></td>
928 <td>)</td>
929 <td></td><td></td>
930 </tr>
931 </table>
932 </div><div class="memdoc">
933 <p>Join an array of values. The result is an empty string if there are no values.</p>
934 <dl class="params"><dt>Parameters</dt><dd>
935 <table class="params">
936 <tr><td class="paramname">p</td><td>Pool to allocate return value. </td></tr>
937 <tr><td class="paramname">sep</td><td>String that is inserted between the joined values. </td></tr>
938 <tr><td class="paramname">arr</td><td>Array of <a class="el" href="structapreq__value__t.html" title="libapreq&#39;s pre-extensible string type">apreq_value_t</a> entries. </td></tr>
939 <tr><td class="paramname">mode</td><td>Join type- see apreq_join_t.</td></tr>
940 </table>
941 </dd>
942 </dl>
943 <dl class="section return"><dt>Returns</dt><dd>Joined string, or NULL on error </dd></dl>
944
945 </div>
946 </div>
947 <a id="ab4aa9bed839bb576444f464666e0bd85"></a>
948 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9bed839bb576444f464666e0bd85">&#9670;&nbsp;</a></span>apreq_quote()</h2>
949
950 <div class="memitem">
951 <div class="memproto">
952 <table class="memname">
953 <tr>
954 <td class="memname">apr_size_t apreq_quote </td>
955 <td>(</td>
956 <td class="paramtype">char *&#160;</td>
957 <td class="paramname"><em>dest</em>, </td>
958 </tr>
959 <tr>
960 <td class="paramkey"></td>
961 <td></td>
962 <td class="paramtype">const char *&#160;</td>
963 <td class="paramname"><em>src</em>, </td>
964 </tr>
965 <tr>
966 <td class="paramkey"></td>
967 <td></td>
968 <td class="paramtype">const apr_size_t&#160;</td>
969 <td class="paramname"><em>slen</em>&#160;</td>
970 </tr>
971 <tr>
972 <td></td>
973 <td>)</td>
974 <td></td><td></td>
975 </tr>
976 </table>
977 </div><div class="memdoc">
978 <p>Places a quoted copy of src into dest. Embedded quotes are escaped with a backslash ('\').</p>
979 <dl class="params"><dt>Parameters</dt><dd>
980 <table class="params">
981 <tr><td class="paramname">dest</td><td>Location of quoted copy. Must be large enough to hold the copy and trailing null byte. </td></tr>
982 <tr><td class="paramname">src</td><td>Original string. </td></tr>
983 <tr><td class="paramname">slen</td><td>Length of original string. </td></tr>
984 <tr><td class="paramname">dest</td><td>Destination string.</td></tr>
985 </table>
986 </dd>
987 </dl>
988 <dl class="section return"><dt>Returns</dt><dd>length of quoted copy in dest. </dd></dl>
989
990 </div>
991 </div>
992 <a id="afef8b7af9d36b0f7ec24e9d0f64a29a7"></a>
993 <h2 class="memtitle"><span class="permalink"><a href="#afef8b7af9d36b0f7ec24e9d0f64a29a7">&#9670;&nbsp;</a></span>apreq_quote_once()</h2>
994
995 <div class="memitem">
996 <div class="memproto">
997 <table class="memname">
998 <tr>
999 <td class="memname">apr_size_t apreq_quote_once </td>
1000 <td>(</td>
1001 <td class="paramtype">char *&#160;</td>
1002 <td class="paramname"><em>dest</em>, </td>
1003 </tr>
1004 <tr>
1005 <td class="paramkey"></td>
1006 <td></td>
1007 <td class="paramtype">const char *&#160;</td>
1008 <td class="paramname"><em>src</em>, </td>
1009 </tr>
1010 <tr>
1011 <td class="paramkey"></td>
1012 <td></td>
1013 <td class="paramtype">const apr_size_t&#160;</td>
1014 <td class="paramname"><em>slen</em>&#160;</td>
1015 </tr>
1016 <tr>
1017 <td></td>
1018 <td>)</td>
1019 <td></td><td></td>
1020 </tr>
1021 </table>
1022 </div><div class="memdoc">
1023 <p>Same as <a class="el" href="apreq__util_8h.html#ab4aa9bed839bb576444f464666e0bd85">apreq_quote()</a> except when src begins and ends in quote marks. In that case it assumes src is quoted correctly, and just copies src to dest.</p>
1024 <dl class="params"><dt>Parameters</dt><dd>
1025 <table class="params">
1026 <tr><td class="paramname">dest</td><td>Location of quoted copy. Must be large enough to hold the copy and trailing null byte. </td></tr>
1027 <tr><td class="paramname">src</td><td>Original string. </td></tr>
1028 <tr><td class="paramname">slen</td><td>Length of original string. </td></tr>
1029 <tr><td class="paramname">dest</td><td>Destination string.</td></tr>
1030 </table>
1031 </dd>
1032 </dl>
1033 <dl class="section return"><dt>Returns</dt><dd>length of quoted copy in dest. </dd></dl>
1034
1035 </div>
1036 </div>
1037 <a id="a979c0af9322189581bde4644eec5fd41"></a>
1038 <h2 class="memtitle"><span class="permalink"><a href="#a979c0af9322189581bde4644eec5fd41">&#9670;&nbsp;</a></span>apreq_unescape()</h2>
1039
1040 <div class="memitem">
1041 <div class="memproto">
1042 <table class="mlabels">
1043 <tr>
1044 <td class="mlabels-left">
1045 <table class="memname">
1046 <tr>
1047 <td class="memname">static APR_INLINE apr_ssize_t apreq_unescape </td>
1048 <td>(</td>
1049 <td class="paramtype">char *&#160;</td>
1050 <td class="paramname"><em>str</em></td><td>)</td>
1051 <td></td>
1052 </tr>
1053 </table>
1054 </td>
1055 <td class="mlabels-right">
1056 <span class="mlabels"><span class="mlabel">static</span></span> </td>
1057 </tr>
1058 </table>
1059 </div><div class="memdoc">
1060 <p>An <em>in-situ</em> url-decoder.</p>
1061 <dl class="params"><dt>Parameters</dt><dd>
1062 <table class="params">
1063 <tr><td class="paramname">str</td><td>The string to decode</td></tr>
1064 </table>
1065 </dd>
1066 </dl>
1067 <dl class="section return"><dt>Returns</dt><dd>Length of decoded string, or &lt; 0 on error. </dd></dl>
1068
1069 </div>
1070 </div>
1071 </div><!-- contents -->
1072 <div id="footer">
1073 <p class="apache">
1074 Copyright &copy; 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
1075 See <a href="apreq_license.html">LICENSE</a>.</p>
1076 <p class="menu">
1077 <span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
1078 version 1.9.1 on Thu Aug 18 2022</span>
1079 </p>
1080 </div>
1081 </body>
1082 </html>