<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache Portable Runtime: apr_strings.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>apr_strings.h</h1><a href="apr__strings_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="comment">/* Portions of this file are covered by */</span>
<a name="l00018"></a>00018 <span class="comment">/* -*- mode: c; c-file-style: "k&r" -*-</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment"> strnatcmp.c -- Perform 'natural order' comparisons of strings in C.</span>
<a name="l00021"></a>00021 <span class="comment"> Copyright (C) 2000 by Martin Pool <mbp@humbug.org.au></span>
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment"> This software is provided 'as-is', without any express or implied</span>
<a name="l00024"></a>00024 <span class="comment"> warranty. In no event will the authors be held liable for any damages</span>
<a name="l00025"></a>00025 <span class="comment"> arising from the use of this software.</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"> Permission is granted to anyone to use this software for any purpose,</span>
<a name="l00028"></a>00028 <span class="comment"> including commercial applications, and to alter it and redistribute it</span>
<a name="l00029"></a>00029 <span class="comment"> freely, subject to the following restrictions:</span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment"> 1. The origin of this software must not be misrepresented; you must not</span>
<a name="l00032"></a>00032 <span class="comment"> claim that you wrote the original software. If you use this software</span>
<a name="l00033"></a>00033 <span class="comment"> in a product, an acknowledgment in the product documentation would be</span>
<a name="l00034"></a>00034 <span class="comment"> appreciated but is not required.</span>
<a name="l00035"></a>00035 <span class="comment"> 2. Altered source versions must be plainly marked as such, and must not be</span>
<a name="l00036"></a>00036 <span class="comment"> misrepresented as being the original software.</span>
<a name="l00037"></a>00037 <span class="comment"> 3. This notice may not be removed or altered from any source distribution.</span>
<a name="l00038"></a>00038 <span class="comment">*/</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#ifndef APR_STRINGS_H</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define APR_STRINGS_H</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">/**</span>
<a name="l00044"></a>00044 <span class="comment"> * @file apr_strings.h</span>
<a name="l00045"></a>00045 <span class="comment"> * @brief APR Strings library</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="preprocessor">#include "<a class="code" href="apr_8h.html" title="APR Platform Definitions.">apr.h</a>"</span>
<a name="l00049"></a>00049 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html" title="APR Error Codes.">apr_errno.h</a>"</span>
<a name="l00050"></a>00050 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
<a name="l00051"></a>00051 <span class="preprocessor">#define APR_WANT_IOVEC</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="apr__want_8h.html" title="APR Standard Headers Support.">apr_want.h</a>"</span>
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="preprocessor">#if APR_HAVE_STDARG_H</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#include <stdarg.h></span>
<a name="l00056"></a>00056 <span class="preprocessor">#endif</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00058"></a>00058 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00060"></a>00060 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/**</span>
<a name="l00063"></a>00063 <span class="comment"> * @defgroup apr_strings String routines</span>
<a name="l00064"></a>00064 <span class="comment"> * @ingroup APR </span>
<a name="l00065"></a>00065 <span class="comment"> * @{</span>
<a name="l00066"></a>00066 <span class="comment"> */</span>
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">/**</span>
<a name="l00069"></a>00069 <span class="comment"> * Do a natural order comparison of two strings.</span>
<a name="l00070"></a>00070 <span class="comment"> * @param a The first string to compare</span>
<a name="l00071"></a>00071 <span class="comment"> * @param b The second string to compare</span>
<a name="l00072"></a>00072 <span class="comment"> * @return Either <0, 0, or >0. If the first string is less than the second</span>
<a name="l00073"></a>00073 <span class="comment"> * this returns <0, if they are equivalent it returns 0, and if the</span>
<a name="l00074"></a>00074 <span class="comment"> * first string is greater than second string it retuns >0.</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__strings.html#gabe7e226c26e1535d787a7836b9c8d0a1">apr_strnatcmp</a>(<span class="keywordtype">char</span> const *a, <span class="keywordtype">char</span> const *b);
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">/**</span>
<a name="l00079"></a>00079 <span class="comment"> * Do a natural order comparison of two strings ignoring the case of the </span>
<a name="l00080"></a>00080 <span class="comment"> * strings.</span>
<a name="l00081"></a>00081 <span class="comment"> * @param a The first string to compare</span>
<a name="l00082"></a>00082 <span class="comment"> * @param b The second string to compare</span>
<a name="l00083"></a>00083 <span class="comment"> * @return Either <0, 0, or >0. If the first string is less than the second</span>
<a name="l00084"></a>00084 <span class="comment"> * this returns <0, if they are equivalent it returns 0, and if the</span>
<a name="l00085"></a>00085 <span class="comment"> * first string is greater than second string it retuns >0.</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a>00087 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__strings.html#ga1708d51c4989934fec663b23366430f3">apr_strnatcasecmp</a>(<span class="keywordtype">char</span> const *a, <span class="keywordtype">char</span> const *b);
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment">/**</span>
<a name="l00090"></a>00090 <span class="comment"> * duplicate a string into memory allocated out of a pool</span>
<a name="l00091"></a>00091 <span class="comment"> * @param p The pool to allocate out of</span>
<a name="l00092"></a>00092 <span class="comment"> * @param s The string to duplicate</span>
<a name="l00093"></a>00093 <span class="comment"> * @return The new string</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#gabc79e99ff19abbd7cfd18308c5f85d47">apr_pstrdup</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <span class="keywordtype">char</span> *s);
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment">/**</span>
<a name="l00098"></a>00098 <span class="comment"> * Create a null-terminated string by making a copy of a sequence</span>
<a name="l00099"></a>00099 <span class="comment"> * of characters and appending a null byte</span>
<a name="l00100"></a>00100 <span class="comment"> * @param p The pool to allocate out of</span>
<a name="l00101"></a>00101 <span class="comment"> * @param s The block of characters to duplicate</span>
<a name="l00102"></a>00102 <span class="comment"> * @param n The number of characters to duplicate</span>
<a name="l00103"></a>00103 <span class="comment"> * @return The new string</span>
<a name="l00104"></a>00104 <span class="comment"> * @remark This is a faster alternative to apr_pstrndup, for use</span>
<a name="l00105"></a>00105 <span class="comment"> * when you know that the string being duplicated really</span>
<a name="l00106"></a>00106 <span class="comment"> * has 'n' or more characters. If the string might contain</span>
<a name="l00107"></a>00107 <span class="comment"> * fewer characters, use apr_pstrndup.</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga0eae1185559578c0f9792413305eca25">apr_pstrmemdup</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <span class="keywordtype">char</span> *s, apr_size_t n);
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment">/**</span>
<a name="l00112"></a>00112 <span class="comment"> * Duplicate at most n characters of a string into memory allocated </span>
<a name="l00113"></a>00113 <span class="comment"> * out of a pool; the new string will be NUL-terminated</span>
<a name="l00114"></a>00114 <span class="comment"> * @param p The pool to allocate out of</span>
<a name="l00115"></a>00115 <span class="comment"> * @param s The string to duplicate</span>
<a name="l00116"></a>00116 <span class="comment"> * @param n The maximum number of characters to duplicate</span>
<a name="l00117"></a>00117 <span class="comment"> * @return The new string</span>
<a name="l00118"></a>00118 <span class="comment"> * @remark The amount of memory allocated from the pool is the length</span>
<a name="l00119"></a>00119 <span class="comment"> * of the returned string including the NUL terminator</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#gad17053ffe6604d908ae7cac33543a6b4">apr_pstrndup</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <span class="keywordtype">char</span> *s, apr_size_t n);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">/**</span>
<a name="l00124"></a>00124 <span class="comment"> * Duplicate a block of memory.</span>
<a name="l00125"></a>00125 <span class="comment"> *</span>
<a name="l00126"></a>00126 <span class="comment"> * @param p The pool to allocate from</span>
<a name="l00127"></a>00127 <span class="comment"> * @param m The memory to duplicate</span>
<a name="l00128"></a>00128 <span class="comment"> * @param n The number of bytes to duplicate</span>
<a name="l00129"></a>00129 <span class="comment"> * @return The new block of memory</span>
<a name="l00130"></a>00130 <span class="comment"> */</span>
<a name="l00131"></a>00131 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__strings.html#gac3886f14ecf5aed8fe4493087799685c">apr_pmemdup</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <span class="keywordtype">void</span> *m, apr_size_t n);
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment">/**</span>
<a name="l00134"></a>00134 <span class="comment"> * Concatenate multiple strings, allocating memory out a pool</span>
<a name="l00135"></a>00135 <span class="comment"> * @param p The pool to allocate out of</span>
<a name="l00136"></a>00136 <span class="comment"> * @param ... The strings to concatenate. The final string must be NULL</span>
<a name="l00137"></a>00137 <span class="comment"> * @return The new string</span>
<a name="l00138"></a>00138 <span class="comment"> */</span>
<a name="l00139"></a>00139 <a class="code" href="group__apr__platform.html#ga3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga7bd80c95ffb7b3f96bc78e7b5b5b0045">apr_pstrcat</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, ...)
<a name="l00140"></a>00140 <span class="preprocessor">#if defined(__GNUC__) && __GNUC__ >= 4</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span> __attribute__((sentinel))
<a name="l00142"></a>00142 <span class="preprocessor">#endif</span>
<a name="l00143"></a>00143 <span class="preprocessor"></span> ;
<a name="l00144"></a>00144 <span class="comment"></span>
<a name="l00145"></a>00145 <span class="comment">/**</span>
<a name="l00146"></a>00146 <span class="comment"> * Concatenate multiple strings specified in a writev-style vector</span>
<a name="l00147"></a>00147 <span class="comment"> * @param p The pool from which to allocate</span>
<a name="l00148"></a>00148 <span class="comment"> * @param vec The strings to concatenate</span>
<a name="l00149"></a>00149 <span class="comment"> * @param nvec The number of strings to concatenate</span>
<a name="l00150"></a>00150 <span class="comment"> * @param nbytes (output) strlen of new string (pass in NULL to omit)</span>
<a name="l00151"></a>00151 <span class="comment"> * @return The new string</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga15d0853af252a894e288c682b8f84309">apr_pstrcatv</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const struct iovec *vec,
<a name="l00154"></a>00154 apr_size_t nvec, apr_size_t *nbytes);
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment">/**</span>
<a name="l00157"></a>00157 <span class="comment"> * printf-style style printing routine. The data is output to a string </span>
<a name="l00158"></a>00158 <span class="comment"> * allocated from a pool</span>
<a name="l00159"></a>00159 <span class="comment"> * @param p The pool to allocate out of</span>
<a name="l00160"></a>00160 <span class="comment"> * @param fmt The format of the string</span>
<a name="l00161"></a>00161 <span class="comment"> * @param ap The arguments to use while printing the data</span>
<a name="l00162"></a>00162 <span class="comment"> * @return The new string</span>
<a name="l00163"></a>00163 <span class="comment"> */</span>
<a name="l00164"></a>00164 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga05248544edebc71070140d2ce5969c10">apr_pvsprintf</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <span class="keywordtype">char</span> *fmt, va_list ap);
<a name="l00165"></a>00165 <span class="comment"></span>
<a name="l00166"></a>00166 <span class="comment">/**</span>
<a name="l00167"></a>00167 <span class="comment"> * printf-style style printing routine. The data is output to a string </span>
<a name="l00168"></a>00168 <span class="comment"> * allocated from a pool</span>
<a name="l00169"></a>00169 <span class="comment"> * @param p The pool to allocate out of</span>
<a name="l00170"></a>00170 <span class="comment"> * @param fmt The format of the string</span>
<a name="l00171"></a>00171 <span class="comment"> * @param ... The arguments to use while printing the data</span>
<a name="l00172"></a>00172 <span class="comment"> * @return The new string</span>
<a name="l00173"></a>00173 <span class="comment"> */</span>
<a name="l00174"></a>00174 <a class="code" href="group__apr__platform.html#ga3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga3eca76b8d293c5c3f8021e45eda813d8">apr_psprintf</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <span class="keywordtype">char</span> *fmt, ...)
<a name="l00175"></a>00175 __attribute__((format(printf,2,3)));
<a name="l00176"></a>00176 <span class="comment"></span>
<a name="l00177"></a>00177 <span class="comment">/**</span>
<a name="l00178"></a>00178 <span class="comment"> * Copy up to dst_size characters from src to dst; does not copy</span>
<a name="l00179"></a>00179 <span class="comment"> * past a NUL terminator in src, but always terminates dst with a NUL</span>
<a name="l00180"></a>00180 <span class="comment"> * regardless.</span>
<a name="l00181"></a>00181 <span class="comment"> * @param dst The destination string</span>
<a name="l00182"></a>00182 <span class="comment"> * @param src The source string</span>
<a name="l00183"></a>00183 <span class="comment"> * @param dst_size The space available in dst; dst always receives</span>
<a name="l00184"></a>00184 <span class="comment"> * NUL termination, so if src is longer than</span>
<a name="l00185"></a>00185 <span class="comment"> * dst_size, the actual number of characters copied is</span>
<a name="l00186"></a>00186 <span class="comment"> * dst_size - 1.</span>
<a name="l00187"></a>00187 <span class="comment"> * @return Pointer to the NUL terminator of the destination string, dst</span>
<a name="l00188"></a>00188 <span class="comment"> * @remark</span>
<a name="l00189"></a>00189 <span class="comment"> * <PRE></span>
<a name="l00190"></a>00190 <span class="comment"> * Note the differences between this function and strncpy():</span>
<a name="l00191"></a>00191 <span class="comment"> * 1) strncpy() doesn't always NUL terminate; apr_cpystrn() does.</span>
<a name="l00192"></a>00192 <span class="comment"> * 2) strncpy() pads the destination string with NULs, which is often </span>
<a name="l00193"></a>00193 <span class="comment"> * unnecessary; apr_cpystrn() does not.</span>
<a name="l00194"></a>00194 <span class="comment"> * 3) strncpy() returns a pointer to the beginning of the dst string;</span>
<a name="l00195"></a>00195 <span class="comment"> * apr_cpystrn() returns a pointer to the NUL terminator of dst, </span>
<a name="l00196"></a>00196 <span class="comment"> * to allow a check for truncation.</span>
<a name="l00197"></a>00197 <span class="comment"> * </PRE></span>
<a name="l00198"></a>00198 <span class="comment"> */</span>
<a name="l00199"></a>00199 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga69700a825e82dd646f9f166599040431">apr_cpystrn</a>(<span class="keywordtype">char</span> *dst, const <span class="keywordtype">char</span> *src,
<a name="l00200"></a>00200 apr_size_t dst_size);
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment">/**</span>
<a name="l00203"></a>00203 <span class="comment"> * Remove all whitespace from a string</span>
<a name="l00204"></a>00204 <span class="comment"> * @param dest The destination string. It is okay to modify the string</span>
<a name="l00205"></a>00205 <span class="comment"> * in place. Namely dest == src</span>
<a name="l00206"></a>00206 <span class="comment"> * @param src The string to rid the spaces from.</span>
<a name="l00207"></a>00207 <span class="comment"> * @return A pointer to the destination string's null terminator.</span>
<a name="l00208"></a>00208 <span class="comment"> */</span>
<a name="l00209"></a>00209 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#gafd92441a5f4fa3b5f5aa49e1f9884bc7">apr_collapse_spaces</a>(<span class="keywordtype">char</span> *dest, const <span class="keywordtype">char</span> *src);
<a name="l00210"></a>00210 <span class="comment"></span>
<a name="l00211"></a>00211 <span class="comment">/**</span>
<a name="l00212"></a>00212 <span class="comment"> * Convert the arguments to a program from one string to an array of </span>
<a name="l00213"></a>00213 <span class="comment"> * strings terminated by a NULL pointer</span>
<a name="l00214"></a>00214 <span class="comment"> * @param arg_str The arguments to convert</span>
<a name="l00215"></a>00215 <span class="comment"> * @param argv_out Output location. This is a pointer to an array of strings.</span>
<a name="l00216"></a>00216 <span class="comment"> * @param token_context Pool to use.</span>
<a name="l00217"></a>00217 <span class="comment"> */</span>
<a name="l00218"></a>00218 <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__strings.html#ga5213cee7e8ba799df9dc2e57f71cd4dd">apr_tokenize_to_argv</a>(const <span class="keywordtype">char</span> *arg_str,
<a name="l00219"></a>00219 <span class="keywordtype">char</span> ***argv_out,
<a name="l00220"></a>00220 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *token_context);
<a name="l00221"></a>00221 <span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment">/**</span>
<a name="l00223"></a>00223 <span class="comment"> * Split a string into separate null-terminated tokens. The tokens are </span>
<a name="l00224"></a>00224 <span class="comment"> * delimited in the string by one or more characters from the sep</span>
<a name="l00225"></a>00225 <span class="comment"> * argument.</span>
<a name="l00226"></a>00226 <span class="comment"> * @param str The string to separate; this should be specified on the</span>
<a name="l00227"></a>00227 <span class="comment"> * first call to apr_strtok() for a given string, and NULL</span>
<a name="l00228"></a>00228 <span class="comment"> * on subsequent calls.</span>
<a name="l00229"></a>00229 <span class="comment"> * @param sep The set of delimiters</span>
<a name="l00230"></a>00230 <span class="comment"> * @param last Internal state saved by apr_strtok() between calls.</span>
<a name="l00231"></a>00231 <span class="comment"> * @return The next token from the string</span>
<a name="l00232"></a>00232 <span class="comment"> */</span>
<a name="l00233"></a>00233 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga1cf7fcb5843707ece733e27aad85c516">apr_strtok</a>(<span class="keywordtype">char</span> *str, const <span class="keywordtype">char</span> *sep, <span class="keywordtype">char</span> **last);
<a name="l00234"></a>00234 <span class="comment"></span>
<a name="l00235"></a>00235 <span class="comment">/**</span>
<a name="l00236"></a>00236 <span class="comment"> * @defgroup APR_Strings_Snprintf snprintf implementations</span>
<a name="l00237"></a>00237 <span class="comment"> * @warning</span>
<a name="l00238"></a>00238 <span class="comment"> * These are snprintf implementations based on apr_vformatter().</span>
<a name="l00239"></a>00239 <span class="comment"> *</span>
<a name="l00240"></a>00240 <span class="comment"> * Note that various standards and implementations disagree on the return</span>
<a name="l00241"></a>00241 <span class="comment"> * value of snprintf, and side-effects due to %n in the formatting string.</span>
<a name="l00242"></a>00242 <span class="comment"> * apr_snprintf (and apr_vsnprintf) behaves as follows:</span>
<a name="l00243"></a>00243 <span class="comment"> *</span>
<a name="l00244"></a>00244 <span class="comment"> * Process the format string until the entire string is exhausted, or</span>
<a name="l00245"></a>00245 <span class="comment"> * the buffer fills. If the buffer fills then stop processing immediately</span>
<a name="l00246"></a>00246 <span class="comment"> * (so no further %n arguments are processed), and return the buffer</span>
<a name="l00247"></a>00247 <span class="comment"> * length. In all cases the buffer is NUL terminated. It will return the</span>
<a name="l00248"></a>00248 <span class="comment"> * number of characters inserted into the buffer, not including the</span>
<a name="l00249"></a>00249 <span class="comment"> * terminating NUL. As a special case, if len is 0, apr_snprintf will</span>
<a name="l00250"></a>00250 <span class="comment"> * return the number of characters that would have been inserted if</span>
<a name="l00251"></a>00251 <span class="comment"> * the buffer had been infinite (in this case, *buffer can be NULL)</span>
<a name="l00252"></a>00252 <span class="comment"> *</span>
<a name="l00253"></a>00253 <span class="comment"> * In no event does apr_snprintf return a negative number.</span>
<a name="l00254"></a>00254 <span class="comment"> * @{</span>
<a name="l00255"></a>00255 <span class="comment"> */</span>
<a name="l00256"></a>00256 <span class="comment"></span>
<a name="l00257"></a>00257 <span class="comment">/**</span>
<a name="l00258"></a>00258 <span class="comment"> * snprintf routine based on apr_vformatter. This means it understands the</span>
<a name="l00259"></a>00259 <span class="comment"> * same extensions.</span>
<a name="l00260"></a>00260 <span class="comment"> * @param buf The buffer to write to</span>
<a name="l00261"></a>00261 <span class="comment"> * @param len The size of the buffer</span>
<a name="l00262"></a>00262 <span class="comment"> * @param format The format string</span>
<a name="l00263"></a>00263 <span class="comment"> * @param ... The arguments to use to fill out the format string.</span>
<a name="l00264"></a>00264 <span class="comment"> */</span>
<a name="l00265"></a>00265 <a class="code" href="group__apr__platform.html#ga3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___strings___snprintf.html#gaf0d0becc04278df5172f0ce5905f8ff9">apr_snprintf</a>(<span class="keywordtype">char</span> *buf, apr_size_t len,
<a name="l00266"></a>00266 const <span class="keywordtype">char</span> *format, ...)
<a name="l00267"></a>00267 __attribute__((format(printf,3,4)));
<a name="l00268"></a>00268 <span class="comment"></span>
<a name="l00269"></a>00269 <span class="comment">/**</span>
<a name="l00270"></a>00270 <span class="comment"> * vsnprintf routine based on apr_vformatter. This means it understands the</span>
<a name="l00271"></a>00271 <span class="comment"> * same extensions.</span>
<a name="l00272"></a>00272 <span class="comment"> * @param buf The buffer to write to</span>
<a name="l00273"></a>00273 <span class="comment"> * @param len The size of the buffer</span>
<a name="l00274"></a>00274 <span class="comment"> * @param format The format string</span>
<a name="l00275"></a>00275 <span class="comment"> * @param ap The arguments to use to fill out the format string.</span>
<a name="l00276"></a>00276 <span class="comment"> */</span>
<a name="l00277"></a>00277 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___strings___snprintf.html#gaf6bf63e240e48b517644ff3e99e49c26">apr_vsnprintf</a>(<span class="keywordtype">char</span> *buf, apr_size_t len, const <span class="keywordtype">char</span> *format,
<a name="l00278"></a>00278 va_list ap);<span class="comment"></span>
<a name="l00279"></a>00279 <span class="comment">/** @} */</span>
<a name="l00280"></a>00280 <span class="comment"></span>
<a name="l00281"></a>00281 <span class="comment">/**</span>
<a name="l00282"></a>00282 <span class="comment"> * create a string representation of an int, allocated from a pool</span>
<a name="l00283"></a>00283 <span class="comment"> * @param p The pool from which to allocate</span>
<a name="l00284"></a>00284 <span class="comment"> * @param n The number to format</span>
<a name="l00285"></a>00285 <span class="comment"> * @return The string representation of the number</span>
<a name="l00286"></a>00286 <span class="comment"> */</span>
<a name="l00287"></a>00287 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#gae1c780f2d908a286a141e4b885254a9c">apr_itoa</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keywordtype">int</span> n);
<a name="l00288"></a>00288 <span class="comment"></span>
<a name="l00289"></a>00289 <span class="comment">/**</span>
<a name="l00290"></a>00290 <span class="comment"> * create a string representation of a long, allocated from a pool</span>
<a name="l00291"></a>00291 <span class="comment"> * @param p The pool from which to allocate</span>
<a name="l00292"></a>00292 <span class="comment"> * @param n The number to format</span>
<a name="l00293"></a>00293 <span class="comment"> * @return The string representation of the number</span>
<a name="l00294"></a>00294 <span class="comment"> */</span>
<a name="l00295"></a>00295 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#ga578ea3fa78957c6b2e9b8ab4cbfd60b1">apr_ltoa</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keywordtype">long</span> n);
<a name="l00296"></a>00296 <span class="comment"></span>
<a name="l00297"></a>00297 <span class="comment">/**</span>
<a name="l00298"></a>00298 <span class="comment"> * create a string representation of an apr_off_t, allocated from a pool</span>
<a name="l00299"></a>00299 <span class="comment"> * @param p The pool from which to allocate</span>
<a name="l00300"></a>00300 <span class="comment"> * @param n The number to format</span>
<a name="l00301"></a>00301 <span class="comment"> * @return The string representation of the number</span>
<a name="l00302"></a>00302 <span class="comment"> */</span>
<a name="l00303"></a>00303 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#gabce9fb74bbad08d795389bfe859053d3">apr_off_t_toa</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_off_t n);
<a name="l00304"></a>00304 <span class="comment"></span>
<a name="l00305"></a>00305 <span class="comment">/**</span>
<a name="l00306"></a>00306 <span class="comment"> * Convert a numeric string into an apr_off_t numeric value.</span>
<a name="l00307"></a>00307 <span class="comment"> * @param offset The value of the parsed string.</span>
<a name="l00308"></a>00308 <span class="comment"> * @param buf The string to parse. It may contain optional whitespace,</span>
<a name="l00309"></a>00309 <span class="comment"> * followed by an optional '+' (positive, default) or '-' (negative)</span>
<a name="l00310"></a>00310 <span class="comment"> * character, followed by an optional '0x' prefix if base is 0 or 16,</span>
<a name="l00311"></a>00311 <span class="comment"> * followed by numeric digits appropriate for base.</span>
<a name="l00312"></a>00312 <span class="comment"> * @param end A pointer to the end of the valid character in buf. If</span>
<a name="l00313"></a>00313 <span class="comment"> * not NULL, it is set to the first invalid character in buf.</span>
<a name="l00314"></a>00314 <span class="comment"> * @param base A numeric base in the range between 2 and 36 inclusive,</span>
<a name="l00315"></a>00315 <span class="comment"> * or 0. If base is zero, buf will be treated as base ten unless its</span>
<a name="l00316"></a>00316 <span class="comment"> * digits are prefixed with '0x', in which case it will be treated as</span>
<a name="l00317"></a>00317 <span class="comment"> * base 16.</span>
<a name="l00318"></a>00318 <span class="comment"> * @bug *end breaks type safety; where *buf is const, *end needs to be</span>
<a name="l00319"></a>00319 <span class="comment"> * declared as const in APR 2.0</span>
<a name="l00320"></a>00320 <span class="comment"> */</span>
<a name="l00321"></a>00321 <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__strings.html#ga1583688e0777398174f62e46a522ae8f">apr_strtoff</a>(apr_off_t *offset, const <span class="keywordtype">char</span> *buf,
<a name="l00322"></a>00322 <span class="keywordtype">char</span> **end, <span class="keywordtype">int</span> base);
<a name="l00323"></a>00323 <span class="comment"></span>
<a name="l00324"></a>00324 <span class="comment">/**</span>
<a name="l00325"></a>00325 <span class="comment"> * parse a numeric string into a 64-bit numeric value</span>
<a name="l00326"></a>00326 <span class="comment"> * @param buf The string to parse. It may contain optional whitespace,</span>
<a name="l00327"></a>00327 <span class="comment"> * followed by an optional '+' (positive, default) or '-' (negative)</span>
<a name="l00328"></a>00328 <span class="comment"> * character, followed by an optional '0x' prefix if base is 0 or 16,</span>
<a name="l00329"></a>00329 <span class="comment"> * followed by numeric digits appropriate for base.</span>
<a name="l00330"></a>00330 <span class="comment"> * @param end A pointer to the end of the valid character in buf. If</span>
<a name="l00331"></a>00331 <span class="comment"> * not NULL, it is set to the first invalid character in buf.</span>
<a name="l00332"></a>00332 <span class="comment"> * @param base A numeric base in the range between 2 and 36 inclusive,</span>
<a name="l00333"></a>00333 <span class="comment"> * or 0. If base is zero, buf will be treated as base ten unless its</span>
<a name="l00334"></a>00334 <span class="comment"> * digits are prefixed with '0x', in which case it will be treated as</span>
<a name="l00335"></a>00335 <span class="comment"> * base 16.</span>
<a name="l00336"></a>00336 <span class="comment"> * @return The numeric value of the string. On overflow, errno is set</span>
<a name="l00337"></a>00337 <span class="comment"> * to ERANGE. On success, errno is set to 0.</span>
<a name="l00338"></a>00338 <span class="comment"> */</span>
<a name="l00339"></a>00339 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_int64_t) <a class="code" href="group__apr__strings.html#ga1da34829609e8976f498b235afd6cbe4">apr_strtoi64</a>(const <span class="keywordtype">char</span> *buf, <span class="keywordtype">char</span> **end, <span class="keywordtype">int</span> base);
<a name="l00340"></a>00340 <span class="comment"></span>
<a name="l00341"></a>00341 <span class="comment">/**</span>
<a name="l00342"></a>00342 <span class="comment"> * parse a base-10 numeric string into a 64-bit numeric value.</span>
<a name="l00343"></a>00343 <span class="comment"> * Equivalent to apr_strtoi64(buf, (char**)NULL, 10).</span>
<a name="l00344"></a>00344 <span class="comment"> * @param buf The string to parse</span>
<a name="l00345"></a>00345 <span class="comment"> * @return The numeric value of the string. On overflow, errno is set</span>
<a name="l00346"></a>00346 <span class="comment"> * to ERANGE. On success, errno is set to 0.</span>
<a name="l00347"></a>00347 <span class="comment"> */</span>
<a name="l00348"></a>00348 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_int64_t) <a class="code" href="group__apr__strings.html#gaf0653577ee64efb5406d932db95cce3d">apr_atoi64</a>(const <span class="keywordtype">char</span> *buf);
<a name="l00349"></a>00349 <span class="comment"></span>
<a name="l00350"></a>00350 <span class="comment">/**</span>
<a name="l00351"></a>00351 <span class="comment"> * Format a binary size (magnitiudes are 2^10 rather than 10^3) from an apr_off_t,</span>
<a name="l00352"></a>00352 <span class="comment"> * as bytes, K, M, T, etc, to a four character compacted human readable string.</span>
<a name="l00353"></a>00353 <span class="comment"> * @param size The size to format</span>
<a name="l00354"></a>00354 <span class="comment"> * @param buf The 5 byte text buffer (counting the trailing null)</span>
<a name="l00355"></a>00355 <span class="comment"> * @return The buf passed to apr_strfsize()</span>
<a name="l00356"></a>00356 <span class="comment"> * @remark All negative sizes report ' - ', apr_strfsize only formats positive values.</span>
<a name="l00357"></a>00357 <span class="comment"> */</span>
<a name="l00358"></a>00358 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__strings.html#gaf66522fda6d2dfa540fdc58831405980">apr_strfsize</a>(apr_off_t size, <span class="keywordtype">char</span> *buf);
<a name="l00359"></a>00359 <span class="comment"></span>
<a name="l00360"></a>00360 <span class="comment">/** @} */</span>
<a name="l00361"></a>00361
<a name="l00362"></a>00362 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00363"></a>00363 <span class="preprocessor"></span>}
<a name="l00364"></a>00364 <span class="preprocessor">#endif</span>
<a name="l00365"></a>00365 <span class="preprocessor"></span>
<a name="l00366"></a>00366 <span class="preprocessor">#endif </span><span class="comment">/* !APR_STRINGS_H */</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Feb 14 10:09:01 2012 for Apache Portable Runtime by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
e0236b39c613e86bcee76bad717809a5
>
files
>
131
