<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: apr_lib.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">apr_lib.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="apr__lib_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">/* Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the License. You may obtain a copy of the License at</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"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef APR_LIB_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define APR_LIB_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/**</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @file apr_lib.h</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * This is collection of oddballs that didn't fit anywhere else,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * and might move to more appropriate headers with the release</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * of APR 1.0.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @brief APR general purpose library routines</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="apr_8h.html">apr.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#if APR_HAVE_CTYPE_H</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <ctype.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#if APR_HAVE_STDARG_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <stdarg.h></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/**</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @defgroup apr_lib General Purpose Library Routines</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @ingroup APR </span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * This is collection of oddballs that didn't fit anywhere else,</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * and might move to more appropriate headers with the release</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * of APR 1.0.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/** A constant representing a 'large' string. */</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group__apr__lib.html#ga0c9dd98f46b90b5bcd4cbf75e252d0da"> 52</a></span> <span class="preprocessor">#define HUGE_STRING_LEN 8192</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/*</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * Define the structures used by the APR general-purpose library.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/** @see apr_vformatter_buff_t */</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__apr__lib.html#ga5e9986deebda40f2d1cf8364fa03c3c5"> 59</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__vformatter__buff__t.html">apr_vformatter_buff_t</a> <a class="code" href="structapr__vformatter__buff__t.html">apr_vformatter_buff_t</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/**</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * Structure used by the variable-formatter routines.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> */</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structapr__vformatter__buff__t.html"> 64</a></span> <span class="keyword">struct </span><a class="code" href="structapr__vformatter__buff__t.html">apr_vformatter_buff_t</a> {<span class="comment"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /** The current position */</span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structapr__vformatter__buff__t.html#aad69bb2ce382b39f55df6cc59039aee9"> 66</a></span>  <span class="keywordtype">char</span> *<a class="code" href="structapr__vformatter__buff__t.html#aad69bb2ce382b39f55df6cc59039aee9">curpos</a>;<span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /** The end position of the format string */</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structapr__vformatter__buff__t.html#ab4884e759f4285c72df93e0d63022675"> 68</a></span>  <span class="keywordtype">char</span> *<a class="code" href="structapr__vformatter__buff__t.html#ab4884e759f4285c72df93e0d63022675">endpos</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/**</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * return the final element of the pathname</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @param pathname The path to get the final element of</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @return the final element of the path</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @remark</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * <PRE></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * For example:</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * "/foo/bar/gum" -> "gum"</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * "/foo/bar/gum/" -> ""</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * "gum" -> "gum"</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * "bs\\path\\stuff" -> "stuff"</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * </PRE></span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *) <a class="code" href="group__apr__lib.html#ga241e929df23aede34eb3f2651cf56bc9">apr_filepath_name_get</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *pathname);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/**</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * apr_killpg</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * Small utility macros to make things easier to read. Not usually a</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * goal, to be sure..</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#ifdef WIN32</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#define apr_killpg(x, y)</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#else </span><span class="comment">/* WIN32 */</span><span class="preprocessor"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#ifdef NO_KILLPG</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#define apr_killpg(x, y) (kill (-(x), (y)))</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#else </span><span class="comment">/* NO_KILLPG */</span><span class="preprocessor"></span></div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="group__apr__lib.html#gaa3b0264aadbd9f8d805252fb1ca1cd0e"> 98</a></span> <span class="preprocessor">#define apr_killpg(x, y) (killpg ((x), (y)))</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif </span><span class="comment">/* NO_KILLPG */</span><span class="preprocessor"></span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif </span><span class="comment">/* WIN32 */</span><span class="preprocessor"></span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/**</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * apr_vformatter() is a generic printf-style formatting routine</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * with some extensions.</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param flush_func The function to call when the buffer is full</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param c The buffer to write to</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @param fmt The format string</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @param ap The arguments to use to fill out the format string.</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @remark</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * <PRE></span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * The extensions are:</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> *</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * - %%pA takes a struct in_addr *, and prints it as a.b.c.d</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * - %%pI takes an apr_sockaddr_t * and prints it as a.b.c.d:port or</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * \[ipv6-address\]:port</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * - %%pT takes an apr_os_thread_t * and prints it in decimal</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * ('0' is printed if !APR_HAS_THREADS)</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * - %%pt takes an apr_os_thread_t * and prints it in hexadecimal</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * ('0' is printed if !APR_HAS_THREADS)</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * - %%pm takes an apr_status_t * and prints the appropriate error</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * string (from apr_strerror) corresponding to that error code.</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * - %%pp takes a void * and outputs it in hex</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * - %%pB takes a apr_uint32_t * as bytes and outputs it's apr_strfsize</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * - %%pF same as above, but takes a apr_off_t *</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * - %%pS same as above, but takes a apr_size_t *</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> *</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * %%pA, %%pI, %%pT, %%pp are available from APR 1.0.0 onwards (and in 0.9.x).</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * %%pt is only available from APR 1.2.0 onwards.</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * %%pm, %%pB, %%pF and %%pS are only available from APR 1.3.0 onwards.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> *</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * The %%p hacks are to force gcc's printf warning code to skip</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * over a pointer argument without complaining. This does</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * mean that the ANSI-style %%p (output a void * in hex format) won't</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * work as expected at all, but that seems to be a fair trade-off</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * for the increased robustness of having printf-warnings work.</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> *</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * Additionally, apr_vformatter allows for arbitrary output methods</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * using the apr_vformatter_buff and flush_func.</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> *</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * The apr_vformatter_buff has two elements curpos and endpos.</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * curpos is where apr_vformatter will write the next byte of output.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * It proceeds writing output to curpos, and updating curpos, until</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * either the end of output is reached, or curpos == endpos (i.e. the</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * buffer is full).</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> *</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * If the end of output is reached, apr_vformatter returns the</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * number of bytes written.</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> *</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * When the buffer is full, the flush_func is called. The flush_func</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * can return -1 to indicate that no further output should be attempted,</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * and apr_vformatter will return immediately with -1. Otherwise</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * the flush_func should flush the buffer in whatever manner is</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * appropriate, re apr_pool_t nitialize curpos and endpos, and return 0.</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * Note that flush_func is only invoked as a result of attempting to</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * write another byte at curpos when curpos >= endpos. So for</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * example, it's possible when the output exactly matches the buffer</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * space available that curpos == endpos will be true when</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * apr_vformatter returns.</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> *</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * apr_vformatter does not call out to any other code, it is entirely</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * self-contained. This allows the callers to do things which are</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * otherwise "unsafe". For example, apr_psprintf uses the "scratch"</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * space at the unallocated end of a block, and doesn't actually</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * complete the allocation until apr_vformatter returns. apr_psprintf</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * would be completely broken if apr_vformatter were to call anything</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * that used this same pool. Similarly http_bprintf() uses the "scratch"</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * space at the end of its output buffer, and doesn't actually note</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * that the space is in use until it either has to flush the buffer</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * or until apr_vformatter returns.</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * </PRE></span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__lib.html#gad2cd3594aeaafd45931d1034965f48c1">apr_vformatter</a>(<span class="keywordtype">int</span> (*flush_func)(<a class="code" href="structapr__vformatter__buff__t.html">apr_vformatter_buff_t</a> *b),</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="structapr__vformatter__buff__t.html">apr_vformatter_buff_t</a> *c, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  va_list ap);</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"></span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">/**</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * Display a prompt and read in the password from stdin.</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @param prompt The prompt to display</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @param pwbuf Buffer to store the password</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @param bufsize The length of the password buffer.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @remark If the password entered must be truncated to fit in</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * the provided buffer, APR_ENAMETOOLONG will be returned.</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * Note that the bufsize paramater is passed by reference for no</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * reason; its value will never be modified by the apr_password_get()</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * function.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> */</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__lib.html#ga377e0677598745769ec6f80fecf8f859">apr_password_get</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *prompt, <span class="keywordtype">char</span> *pwbuf, </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  apr_size_t *bufsize);</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"></span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/**</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @defgroup apr_ctype ctype functions</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * These macros allow correct support of 8-bit characters on systems which</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * support 8-bit characters. Pretty dumb how the cast is required, but</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * that's legacy libc for ya. These new macros do not support EOF like</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * the standard macros do. Tough.</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> */</span><span class="comment"></span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">/** @see isalnum */</span></div><div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga4fa78e6e7272dae64731768a17a2e003"> 203</a></span> <span class="preprocessor">#define apr_isalnum(c) (isalnum(((unsigned char)(c))))</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">/** @see isalpha */</span></div><div class="line"><a name="l00205"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga9ecd5b94a7816591afd68040b0624327"> 205</a></span> <span class="preprocessor">#define apr_isalpha(c) (isalpha(((unsigned char)(c))))</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">/** @see iscntrl */</span></div><div class="line"><a name="l00207"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#gacc8b4597be99c895ea042e8088ee94ab"> 207</a></span> <span class="preprocessor">#define apr_iscntrl(c) (iscntrl(((unsigned char)(c))))</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">/** @see isdigit */</span></div><div class="line"><a name="l00209"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga8c453b1d66015b357c3d3a3ddb7d97d7"> 209</a></span> <span class="preprocessor">#define apr_isdigit(c) (isdigit(((unsigned char)(c))))</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">/** @see isgraph */</span></div><div class="line"><a name="l00211"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#gad4fbfcf508e7771ca85e85e4ac9567c2"> 211</a></span> <span class="preprocessor">#define apr_isgraph(c) (isgraph(((unsigned char)(c))))</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">/** @see islower*/</span></div><div class="line"><a name="l00213"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#gaff5eeb2f6350095ce86cc2cd4b1d38ee"> 213</a></span> <span class="preprocessor">#define apr_islower(c) (islower(((unsigned char)(c))))</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">/** @see isascii */</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor">#ifdef isascii</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor">#define apr_isascii(c) (isascii(((unsigned char)(c))))</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00218"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#gae7cab1b39d2e0fc14f343ec14e12565a"> 218</a></span> <span class="preprocessor">#define apr_isascii(c) (((c) & ~0x7f)==0)</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">/** @see isprint */</span></div><div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga20da56fc8bbedc9f8a40d20c1cc58bac"> 221</a></span> <span class="preprocessor">#define apr_isprint(c) (isprint(((unsigned char)(c))))</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">/** @see ispunct */</span></div><div class="line"><a name="l00223"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga1db14e8d5f9891010c8bad08aa100674"> 223</a></span> <span class="preprocessor">#define apr_ispunct(c) (ispunct(((unsigned char)(c))))</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">/** @see isspace */</span></div><div class="line"><a name="l00225"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga23f4c7721923a0f0f444fd7fb196047a"> 225</a></span> <span class="preprocessor">#define apr_isspace(c) (isspace(((unsigned char)(c))))</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">/** @see isupper */</span></div><div class="line"><a name="l00227"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga362f53cc44aab662aaf04fa87e36035b"> 227</a></span> <span class="preprocessor">#define apr_isupper(c) (isupper(((unsigned char)(c))))</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">/** @see isxdigit */</span></div><div class="line"><a name="l00229"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga9d30f3c5d538c21c6d50565cda8654d0"> 229</a></span> <span class="preprocessor">#define apr_isxdigit(c) (isxdigit(((unsigned char)(c))))</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">/** @see tolower */</span></div><div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#gaa591f2a7eb578b1fb3ae9aeaab9eafaa"> 231</a></span> <span class="preprocessor">#define apr_tolower(c) (tolower(((unsigned char)(c))))</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">/** @see toupper */</span></div><div class="line"><a name="l00233"></a><span class="lineno"><a class="line" href="group__apr__ctype.html#ga83d2a3217282784d24897658ad0717b7"> 233</a></span> <span class="preprocessor">#define apr_toupper(c) (toupper(((unsigned char)(c))))</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"></span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> }</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor">#endif </span><span class="comment">/* ! APR_LIB_H */</span><span class="preprocessor"></span></div><div class="ttc" id="structapr__vformatter__buff__t_html_aad69bb2ce382b39f55df6cc59039aee9"><div class="ttname"><a href="structapr__vformatter__buff__t.html#aad69bb2ce382b39f55df6cc59039aee9">apr_vformatter_buff_t::curpos</a></div><div class="ttdeci">char * curpos</div><div class="ttdef"><b>Definition:</b> apr_lib.h:66</div></div>
<div class="ttc" id="group__apr__platform_html_gad7b91b811a172bfa802603c2fb688f98"><div class="ttname"><a href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a></div><div class="ttdeci">#define APR_DECLARE(type)</div><div class="ttdef"><b>Definition:</b> apr.h:479</div></div>
<div class="ttc" id="apr__errno_8h_html"><div class="ttname"><a href="apr__errno_8h.html">apr_errno.h</a></div><div class="ttdoc">APR Error Codes. </div></div>
<div class="ttc" id="structapr__vformatter__buff__t_html"><div class="ttname"><a href="structapr__vformatter__buff__t.html">apr_vformatter_buff_t</a></div><div class="ttdef"><b>Definition:</b> apr_lib.h:64</div></div>
<div class="ttc" id="apr_8h_html"><div class="ttname"><a href="apr_8h.html">apr.h</a></div><div class="ttdoc">APR Platform Definitions. </div></div>
<div class="ttc" id="structapr__vformatter__buff__t_html_ab4884e759f4285c72df93e0d63022675"><div class="ttname"><a href="structapr__vformatter__buff__t.html#ab4884e759f4285c72df93e0d63022675">apr_vformatter_buff_t::endpos</a></div><div class="ttdeci">char * endpos</div><div class="ttdef"><b>Definition:</b> apr_lib.h:68</div></div>
<div class="ttc" id="group__apr__lib_html_gad2cd3594aeaafd45931d1034965f48c1"><div class="ttname"><a href="group__apr__lib.html#gad2cd3594aeaafd45931d1034965f48c1">apr_vformatter</a></div><div class="ttdeci">int apr_vformatter(int(*flush_func)(apr_vformatter_buff_t *b), apr_vformatter_buff_t *c, const char *fmt, va_list ap)</div></div>
<div class="ttc" id="group__apr__lib_html_ga241e929df23aede34eb3f2651cf56bc9"><div class="ttname"><a href="group__apr__lib.html#ga241e929df23aede34eb3f2651cf56bc9">apr_filepath_name_get</a></div><div class="ttdeci">const char * apr_filepath_name_get(const char *pathname)</div></div>
<div class="ttc" id="group__apr__errno_html_gaf76ee4543247e9fb3f3546203e590a6c"><div class="ttname"><a href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a></div><div class="ttdeci">int apr_status_t</div><div class="ttdef"><b>Definition:</b> apr_errno.h:44</div></div>
<div class="ttc" id="group__apr__lib_html_ga377e0677598745769ec6f80fecf8f859"><div class="ttname"><a href="group__apr__lib.html#ga377e0677598745769ec6f80fecf8f859">apr_password_get</a></div><div class="ttdeci">apr_status_t apr_password_get(const char *prompt, char *pwbuf, apr_size_t *bufsize)</div></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.13
</small></address>
</body>
</html>
