<!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_escape.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_escape.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="apr__escape_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><span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/**</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * @file apr_escape.h</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * @brief APR-UTIL Escaping</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="preprocessor">#ifndef APR_ESCAPE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define APR_ESCAPE_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="apr_8h.html">apr.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="apr__general_8h.html">apr_general.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/**</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @defgroup APR_Util_Escaping Escape functions</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @ingroup APR</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/* Simple escape/unescape functions.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> */</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/**</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * When passing a string to one of the escape functions, this value can be</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * passed to indicate a string-valued key, and have the length computed</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * automatically.</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"><a class="line" href="group___a_p_r___util___escaping.html#ga793ae1b187ce490c65eeee2eb59d2831"> 43</a></span> <span class="preprocessor">#define APR_ESCAPE_STRING (-1)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/**</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * Perform shell escaping on the provided string.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * </span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Shell escaping causes characters to be prefixed with a '\' character.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * detected or the string was NULL</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> <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___a_p_r___util___escaping.html#gafdfca9adc06570fa6efd802e24dce6d1">apr_escape_shell</a>(<span class="keywordtype">char</span> *escaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  apr_ssize_t slen, apr_size_t *len);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></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"> * Perform shell escaping on the provided string, returning the result</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * from the pool.</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"> 64</span> <span class="comment"> * Shell escaping causes characters to be prefixed with a '\' character.</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> *</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * If no characters were escaped, the original string is returned.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @return the encoded string, allocated from the pool, or the original</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * string if no escaping took place or the string was NULL.</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> <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___a_p_r___util___escaping.html#ga81e97334f8033bfbc3acd5e15262323e">apr_pescape_shell</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *str)</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/**</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * Unescapes a URL, leaving reserved characters intact.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param url String to be unescaped</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param slen The length of the original url, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @param forbid Optional list of forbidden characters, in addition to</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * 0x00</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @param reserved Optional list of reserved characters that will be</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * left unescaped</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @param plus If non zero, '+' is converted to ' ' as per</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * application/x-www-form-urlencoded encoding</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param len If set, the length of the escaped string will be returned</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @return APR_SUCCESS on success, APR_NOTFOUND if no characters are</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * decoded or the string is NULL, APR_EINVAL if a bad escape sequence is</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * found, APR_BADCH if a character on the forbid list is found.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> */</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</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___a_p_r___util___escaping.html#ga9a6b08630ef5a605def1dfa4a54b026f">apr_unescape_url</a>(<span class="keywordtype">char</span> *escaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *url,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  apr_ssize_t slen, <span class="keyword">const</span> <span class="keywordtype">char</span> *forbid, <span class="keyword">const</span> <span class="keywordtype">char</span> *reserved, <span class="keywordtype">int</span> plus,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  apr_size_t *len);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/**</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * Unescapes a URL, leaving reserved characters intact, returning the</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * result from a pool.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @param url String to be unescaped in place</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @param forbid Optional list of forbidden characters, in addition to</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * 0x00</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param reserved Optional list of reserved characters that will be</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * left unescaped</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param plus If non zero, '+' is converted to ' ' as per</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * application/x-www-form-urlencoded encoding</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * if no characters are decoded, or NULL if a bad escape sequence is found</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * or if a character on the forbid list is found, or if the original string</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * was NULL.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</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___a_p_r___util___escaping.html#gac713d5687a00134cef5c795dbf4e6dbe">apr_punescape_url</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *url,</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *forbid, <span class="keyword">const</span> <span class="keywordtype">char</span> *reserved, <span class="keywordtype">int</span> plus)</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * Escape a path segment, as defined in RFC1808.</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * detected or the string was NULL</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> */</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</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___a_p_r___util___escaping.html#ga2fba5a28f4924f00f1ba9a56bc87f651">apr_escape_path_segment</a>(<span class="keywordtype">char</span> *escaped,</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *str, apr_ssize_t slen, apr_size_t *len);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/**</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * Escape a path segment, as defined in RFC1808, returning the result from a</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * pool.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @param str String to be escaped</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * if no characters are encoded or the string is NULL.</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</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___a_p_r___util___escaping.html#ga36bd45eb1f919fe61f04f5e9087c6242">apr_pescape_path_segment</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *str) __attribute__((nonnull(1)));</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"></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"> * Converts an OS path to a URL, in an OS dependent way, as defined in RFC1808.</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * In all cases if a ':' occurs before the first '/' in the URL, the URL should</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * be prefixed with "./" (or the ':' escaped). In the case of Unix, this means</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * leaving '/' alone, but otherwise doing what escape_path_segment() does. For</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * efficiency reasons, we don't use escape_path_segment(), which is provided for</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * reference. Again, RFC 1808 is where this stuff is defined.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> *</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * If partial is set, os_escape_path() assumes that the path will be appended to</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * something with a '/' in it (and thus does not prefix "./").</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @param path The original string</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @param partial If non zero, suppresses the prepending of "./"</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * detected or if the string was NULL</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> */</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</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___a_p_r___util___escaping.html#gae67859a1d260f354c16e939d24d67058">apr_escape_path</a>(<span class="keywordtype">char</span> *escaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *path,</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  apr_ssize_t slen, <span class="keywordtype">int</span> partial, apr_size_t *len);</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">/**</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * Converts an OS path to a URL, in an OS dependent way, as defined in RFC1808,</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * returning the result from a pool.</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> *</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * In all cases if a ':' occurs before the first '/' in the URL, the URL should</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * be prefixed with "./" (or the ':' escaped). In the case of Unix, this means</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * leaving '/' alone, but otherwise doing what escape_path_segment() does. For</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * efficiency reasons, we don't use escape_path_segment(), which is provided for</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * reference. Again, RFC 1808 is where this stuff is defined.</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> *</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * If partial is set, os_escape_path() assumes that the path will be appended to</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * something with a '/' in it (and thus does not prefix "./").</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @param partial If non zero, suppresses the prepending of "./"</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * if no characters are encoded or if the string was NULL.</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> */</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</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___a_p_r___util___escaping.html#gacd4fc208448eb07af16350802077783a">apr_pescape_path</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordtype">int</span> partial) __attribute__((nonnull(1)));</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"></span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">/**</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * Urlencode a string, as defined in</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * detected or if the stirng was NULL</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> <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___a_p_r___util___escaping.html#ga0a2cb4e99758afd5bed8fd62df05e16f">apr_escape_urlencoded</a>(<span class="keywordtype">char</span> *escaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  apr_ssize_t slen, apr_size_t *len);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">/**</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * Urlencode a string, as defined in</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1, returning</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * the result from a pool.</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * @param str String to be escaped</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * if no characters are encoded or if the string was NULL.</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> */</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</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___a_p_r___util___escaping.html#ga9caffb30731e3a07a8e23fa6464d35b5">apr_pescape_urlencoded</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *str) __attribute__((nonnull(1)));</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"></span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment">/**</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * Apply entity encoding to a string. Characters are replaced as follows:</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * '<' becomes '&lt;', '>' becomes '&gt;', '&' becomes '&amp;', the</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * double quote becomes '&quot;" and the single quote becomes '&apos;'.</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> *</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * If toasc is not zero, any non ascii character will be encoded as</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * '%\#ddd;', where ddd is the decimal code of the character.</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * @param toasc If non zero, encode non ascii characters</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * detected or the string was NULL</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> */</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</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___a_p_r___util___escaping.html#ga6973ca9a596c8fc9fc34eab647cff11c">apr_escape_entity</a>(<span class="keywordtype">char</span> *escaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  apr_ssize_t slen, <span class="keywordtype">int</span> toasc, apr_size_t *len);</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"></span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">/**</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * Apply entity encoding to a string, returning the result from a pool.</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * Characters are replaced as follows: '<' becomes '&lt;', '>' becomes</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * '&gt;', '&' becomes '&amp;', the double quote becomes '&quot;" and the</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * single quote becomes '&apos;'.</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * @param toasc If non zero, encode non ascii characters</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * if no characters are encoded or the string is NULL.</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> */</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</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___a_p_r___util___escaping.html#gad99b0f505645b63b5f552f5d35f174af">apr_pescape_entity</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordtype">int</span> toasc) __attribute__((nonnull(1)));</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"></span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment">/**</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * Decodes html entities or numeric character references in a string. If</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * the string to be unescaped is syntactically incorrect, then the</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * following fixups will be made:</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * unknown entities will be left undecoded;</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * references to unused numeric characters will be deleted.</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * In particular, &#00; will not be decoded, but will be deleted.</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * @param unescaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * detected or the string was NULL</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> */</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</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___a_p_r___util___escaping.html#ga9b835b2da5bf35c33f6c69e8e3100c99">apr_unescape_entity</a>(<span class="keywordtype">char</span> *unescaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  apr_ssize_t slen, apr_size_t *len);</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"></span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">/**</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * Decodes html entities or numeric character references in a string. If</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * the string to be unescaped is syntactically incorrect, then the</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * following fixups will be made:</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * unknown entities will be left undecoded;</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * references to unused numeric characters will be deleted.</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * In particular, &#00; will not be decoded, but will be deleted.</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * if no characters are encoded or the string is NULL.</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> */</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</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___a_p_r___util___escaping.html#gabaaeff6e19e92cf1f138b21e87889e05">apr_punescape_entity</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *str)</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  __attribute__((nonnull(1)));</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"></span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment">/**</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * Escape control characters in a string, as performed by the shell's</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * 'echo' command. Characters are replaced as follows:</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * \\a alert (bell), \\b backspace, \\f form feed, \\n new line, \\r carriage</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * return, \\t horizontal tab, \\v vertical tab, \\ backslash.</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> *</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * Any non ascii character will be encoded as '\\xHH', where HH is the hex</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * code of the character.</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> *</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * If quote is not zero, the double quote character will also be escaped.</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> * @param escaped Optional buffer to write the encoded string, can be</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * NULL</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * @param slen The length of the original string, or APR_ESCAPE_STRING</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * @param quote If non zero, encode double quotes</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if no changes to the string were</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * detected or the string was NULL</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> */</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</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___a_p_r___util___escaping.html#ga4ebbadaffa33c6aa34e92108c45cd38e">apr_escape_echo</a>(<span class="keywordtype">char</span> *escaped, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  apr_ssize_t slen, <span class="keywordtype">int</span> quote, apr_size_t *len);</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"></span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">/**</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * Escape control characters in a string, as performed by the shell's</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * 'echo' command, and return the results from a pool. Characters are</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * replaced as follows: \\a alert (bell), \\b backspace, \\f form feed,</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * \\n new line, \\r carriage return, \\t horizontal tab, \\v vertical tab,</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * \\ backslash.</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> *</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * Any non ascii character will be encoded as '\\xHH', where HH is the hex</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * code of the character.</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> *</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * If quote is not zero, the double quote character will also be escaped.</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * @param quote If non zero, encode double quotes</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * @return A string allocated from the pool on success, the original string</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * if no characters are encoded or the string is NULL.</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> */</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</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___a_p_r___util___escaping.html#ga1265c454e145b9fca52d2feafacd4a02">apr_pescape_echo</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <span class="keywordtype">int</span> quote);</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"></span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment">/**</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * Convert binary data to a hex encoding.</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * @param dest The destination buffer, can be NULL</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * @param src The original buffer</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * @param srclen The length of the original buffer</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * @param colon If not zero, insert colon characters between hex digits.</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> */</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</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___a_p_r___util___escaping.html#gac87b3c2f42fb60f6ea4d8321e60ce69e">apr_escape_hex</a>(<span class="keywordtype">char</span> *dest, <span class="keyword">const</span> <span class="keywordtype">void</span> *src,</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  apr_size_t srclen, <span class="keywordtype">int</span> colon, apr_size_t *len);</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"></span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment">/**</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * Convert binary data to a hex encoding, and return the results from a</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * pool.</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * @param src The original buffer</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * @param slen The length of the original buffer</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * @param colon If not zero, insert colon characters between hex digits.</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * @return A zero padded buffer allocated from the pool on success, or</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * NULL if src was NULL.</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> */</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</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___a_p_r___util___escaping.html#ga2a12cd35230cc148da52ea983da4b211">apr_pescape_hex</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">void</span> *src,</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  apr_size_t slen, <span class="keywordtype">int</span> colon) __attribute__((nonnull(1)));</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"></span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment">/**</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * Convert hex encoded string to binary data.</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * @param dest The destination buffer, can be NULL</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * @param str The original buffer</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * @param slen The length of the original buffer</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * @param colon If not zero, ignore colon characters between hex digits.</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * @param len If present, returns the length of the string</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL, or APR_BADCH</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * if a non hex character is present.</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> */</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</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___a_p_r___util___escaping.html#ga98c3558219d7ce3dd29420c0124ddd73">apr_unescape_hex</a>(<span class="keywordtype">void</span> *dest, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  apr_ssize_t slen, <span class="keywordtype">int</span> colon, apr_size_t *len);</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"></span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment">/**</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * Convert hex encoding to binary data, and return the results from a pool.</span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * If the colon character appears between pairs of hex digits, it will be</span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * ignored.</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * @param p Pool to allocate from</span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * @param str The original string</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * @param colon If not zero, ignore colon characters between hex digits.</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * @param len If present, returns the length of the final buffer</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * @return A buffer allocated from the pool on success, or NULL if src was</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * NULL, or a bad character was present.</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> */</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *) <a class="code" href="group___a_p_r___util___escaping.html#ga8cba37bcacb5e1c9440f2b35d44afc49">apr_punescape_hex</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="keywordtype">int</span> colon, apr_size_t *len);</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"></span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> }</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> </div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="preprocessor">#endif </span><span class="comment">/* !APR_ESCAPE_H */</span><span class="preprocessor"></span></div><div class="ttc" id="group___a_p_r___util___escaping_html_ga0a2cb4e99758afd5bed8fd62df05e16f"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga0a2cb4e99758afd5bed8fd62df05e16f">apr_escape_urlencoded</a></div><div class="ttdeci">apr_status_t apr_escape_urlencoded(char *escaped, const char *str, apr_ssize_t slen, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga81e97334f8033bfbc3acd5e15262323e"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga81e97334f8033bfbc3acd5e15262323e">apr_pescape_shell</a></div><div class="ttdeci">const char * apr_pescape_shell(apr_pool_t *p, const char *str)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga6973ca9a596c8fc9fc34eab647cff11c"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga6973ca9a596c8fc9fc34eab647cff11c">apr_escape_entity</a></div><div class="ttdeci">apr_status_t apr_escape_entity(char *escaped, const char *str, apr_ssize_t slen, int toasc, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga9b835b2da5bf35c33f6c69e8e3100c99"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga9b835b2da5bf35c33f6c69e8e3100c99">apr_unescape_entity</a></div><div class="ttdeci">apr_status_t apr_unescape_entity(char *unescaped, const char *str, apr_ssize_t slen, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_gacd4fc208448eb07af16350802077783a"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gacd4fc208448eb07af16350802077783a">apr_pescape_path</a></div><div class="ttdeci">const char * apr_pescape_path(apr_pool_t *p, const char *str, int partial)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_gad99b0f505645b63b5f552f5d35f174af"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gad99b0f505645b63b5f552f5d35f174af">apr_pescape_entity</a></div><div class="ttdeci">const char * apr_pescape_entity(apr_pool_t *p, const char *str, int toasc)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga8cba37bcacb5e1c9440f2b35d44afc49"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga8cba37bcacb5e1c9440f2b35d44afc49">apr_punescape_hex</a></div><div class="ttdeci">const void * apr_punescape_hex(apr_pool_t *p, const char *str, int colon, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_gac713d5687a00134cef5c795dbf4e6dbe"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gac713d5687a00134cef5c795dbf4e6dbe">apr_punescape_url</a></div><div class="ttdeci">const char * apr_punescape_url(apr_pool_t *p, const char *url, const char *forbid, const char *reserved, int plus)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga9caffb30731e3a07a8e23fa6464d35b5"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga9caffb30731e3a07a8e23fa6464d35b5">apr_pescape_urlencoded</a></div><div class="ttdeci">const char * apr_pescape_urlencoded(apr_pool_t *p, const char *str)</div></div>
<div class="ttc" id="apr__general_8h_html"><div class="ttname"><a href="apr__general_8h.html">apr_general.h</a></div><div class="ttdoc">APR Miscellaneous library routines. </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="group___a_p_r___util___escaping_html_ga2a12cd35230cc148da52ea983da4b211"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga2a12cd35230cc148da52ea983da4b211">apr_pescape_hex</a></div><div class="ttdeci">const char * apr_pescape_hex(apr_pool_t *p, const void *src, apr_size_t slen, int colon)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_gae67859a1d260f354c16e939d24d67058"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gae67859a1d260f354c16e939d24d67058">apr_escape_path</a></div><div class="ttdeci">apr_status_t apr_escape_path(char *escaped, const char *path, apr_ssize_t slen, int partial, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_gac87b3c2f42fb60f6ea4d8321e60ce69e"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gac87b3c2f42fb60f6ea4d8321e60ce69e">apr_escape_hex</a></div><div class="ttdeci">apr_status_t apr_escape_hex(char *dest, const void *src, apr_size_t srclen, int colon, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga1265c454e145b9fca52d2feafacd4a02"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga1265c454e145b9fca52d2feafacd4a02">apr_pescape_echo</a></div><div class="ttdeci">const char * apr_pescape_echo(apr_pool_t *p, const char *str, int quote)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga98c3558219d7ce3dd29420c0124ddd73"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga98c3558219d7ce3dd29420c0124ddd73">apr_unescape_hex</a></div><div class="ttdeci">apr_status_t apr_unescape_hex(void *dest, const char *str, apr_ssize_t slen, int colon, apr_size_t *len)</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="group___a_p_r___util___escaping_html_gabaaeff6e19e92cf1f138b21e87889e05"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gabaaeff6e19e92cf1f138b21e87889e05">apr_punescape_entity</a></div><div class="ttdeci">const char * apr_punescape_entity(apr_pool_t *p, const char *str)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga9a6b08630ef5a605def1dfa4a54b026f"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga9a6b08630ef5a605def1dfa4a54b026f">apr_unescape_url</a></div><div class="ttdeci">apr_status_t apr_unescape_url(char *escaped, const char *url, apr_ssize_t slen, const char *forbid, const char *reserved, int plus, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga36bd45eb1f919fe61f04f5e9087c6242"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga36bd45eb1f919fe61f04f5e9087c6242">apr_pescape_path_segment</a></div><div class="ttdeci">const char * apr_pescape_path_segment(apr_pool_t *p, const char *str)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_gafdfca9adc06570fa6efd802e24dce6d1"><div class="ttname"><a href="group___a_p_r___util___escaping.html#gafdfca9adc06570fa6efd802e24dce6d1">apr_escape_shell</a></div><div class="ttdeci">apr_status_t apr_escape_shell(char *escaped, const char *str, apr_ssize_t slen, apr_size_t *len)</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga4ebbadaffa33c6aa34e92108c45cd38e"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga4ebbadaffa33c6aa34e92108c45cd38e">apr_escape_echo</a></div><div class="ttdeci">apr_status_t apr_escape_echo(char *escaped, const char *str, apr_ssize_t slen, int quote, apr_size_t *len)</div></div>
<div class="ttc" id="group__apr__pools_html_gaf137f28edcf9a086cd6bc36c20d7cdfb"><div class="ttname"><a href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></div><div class="ttdeci">struct apr_pool_t apr_pool_t</div><div class="ttdef"><b>Definition:</b> apr_pools.h:60</div></div>
<div class="ttc" id="group___a_p_r___util___escaping_html_ga2fba5a28f4924f00f1ba9a56bc87f651"><div class="ttname"><a href="group___a_p_r___util___escaping.html#ga2fba5a28f4924f00f1ba9a56bc87f651">apr_escape_path_segment</a></div><div class="ttdeci">apr_status_t apr_escape_path_segment(char *escaped, const char *str, apr_ssize_t slen, apr_size_t *len)</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><!-- 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>
