<!-- 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_tables.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_tables.h</h1><a href="apr__tables_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_TABLES_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_TABLES_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/**</span>
<a name="l00021"></a>00021 <span class="comment"> * @file apr_tables.h</span>
<a name="l00022"></a>00022 <span class="comment"> * @brief APR Table library</span>
<a name="l00023"></a>00023 <span class="comment"> */</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="apr_8h.html" title="APR Platform Definitions.">apr.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#if APR_HAVE_STDARG_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include <stdarg.h></span> <span class="comment">/* for va_list */</span>
<a name="l00030"></a>00030 <span class="preprocessor">#endif</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00034"></a>00034 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/**</span>
<a name="l00037"></a>00037 <span class="comment"> * @defgroup apr_tables Table and Array Functions</span>
<a name="l00038"></a>00038 <span class="comment"> * @ingroup APR </span>
<a name="l00039"></a>00039 <span class="comment"> * Arrays are used to store data which is referenced sequentially or</span>
<a name="l00040"></a>00040 <span class="comment"> * as a stack. Functions are provided to push and pop individual</span>
<a name="l00041"></a>00041 <span class="comment"> * elements as well as to operate on the entire array.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * Tables are used to store data which can be referenced by key.</span>
<a name="l00044"></a>00044 <span class="comment"> * Limited capabilities are provided for tables with multiple elements</span>
<a name="l00045"></a>00045 <span class="comment"> * which share a key; while key lookup will return only a single</span>
<a name="l00046"></a>00046 <span class="comment"> * element, iteration is available. Additionally, a table can be</span>
<a name="l00047"></a>00047 <span class="comment"> * compressed to resolve duplicates.</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * Both arrays and tables may store string or binary data; some features,</span>
<a name="l00050"></a>00050 <span class="comment"> * such as concatenation or merging of elements, work only for string</span>
<a name="l00051"></a>00051 <span class="comment"> * data.</span>
<a name="l00052"></a>00052 <span class="comment"> * @{</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">/** the table abstract data type */</span>
<a name="l00056"></a><a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">00056</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a>;
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">/** @see apr_array_header_t */</span>
<a name="l00059"></a><a class="code" href="group__apr__tables.html#ga63e76617a1cd3828bbaefcbf93928ec2">00059</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a>;
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">/** An opaque array type */</span>
<a name="l00062"></a><a class="code" href="structapr__array__header__t.html">00062</a> <span class="keyword">struct </span><a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> {<span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** The pool the array is allocated out of */</span>
<a name="l00064"></a><a class="code" href="structapr__array__header__t.html#a68f353ce65943172fcc9494aa9f6e424">00064</a> <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *<a class="code" href="structapr__array__header__t.html#a68f353ce65943172fcc9494aa9f6e424">pool</a>;<span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** The amount of memory allocated for each element of the array */</span>
<a name="l00066"></a><a class="code" href="structapr__array__header__t.html#a36a690ebc781edc9e99ac1bec53c1770">00066</a> <span class="keywordtype">int</span> <a class="code" href="structapr__array__header__t.html#a36a690ebc781edc9e99ac1bec53c1770">elt_size</a>;<span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** The number of active elements in the array */</span>
<a name="l00068"></a><a class="code" href="structapr__array__header__t.html#ab11b88220885c5a0920a06ac85680055">00068</a> <span class="keywordtype">int</span> <a class="code" href="structapr__array__header__t.html#ab11b88220885c5a0920a06ac85680055">nelts</a>;<span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> /** The number of elements allocated in the array */</span>
<a name="l00070"></a><a class="code" href="structapr__array__header__t.html#a0ceb78a23ebef1bceea5f0cd3e1513b6">00070</a> <span class="keywordtype">int</span> <a class="code" href="structapr__array__header__t.html#a0ceb78a23ebef1bceea5f0cd3e1513b6">nalloc</a>;<span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /** The elements in the array */</span>
<a name="l00072"></a><a class="code" href="structapr__array__header__t.html#af8462fa2a1ddf6406c66cd3dd441a269">00072</a> <span class="keywordtype">char</span> *<a class="code" href="structapr__array__header__t.html#af8462fa2a1ddf6406c66cd3dd441a269">elts</a>;
<a name="l00073"></a>00073 };
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment">/**</span>
<a name="l00076"></a>00076 <span class="comment"> * The (opaque) structure for string-content tables.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a><a class="code" href="group__apr__tables.html#gac7e0151b714e58b75c597dafed75df3f">00078</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__table__entry__t.html">apr_table_entry_t</a> <a class="code" href="structapr__table__entry__t.html">apr_table_entry_t</a>;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/** The type for each entry in a string-content table */</span>
<a name="l00081"></a><a class="code" href="structapr__table__entry__t.html">00081</a> <span class="keyword">struct </span><a class="code" href="structapr__table__entry__t.html">apr_table_entry_t</a> {<span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** The key for the current table entry */</span>
<a name="l00083"></a><a class="code" href="structapr__table__entry__t.html#abdccb35ea49dd95082fdce65a5a6001f">00083</a> <span class="keywordtype">char</span> *<a class="code" href="structapr__table__entry__t.html#abdccb35ea49dd95082fdce65a5a6001f">key</a>; <span class="comment">/* maybe NULL in future;</span>
<a name="l00084"></a>00084 <span class="comment"> * check when iterating thru table_elts</span>
<a name="l00085"></a>00085 <span class="comment"> */</span><span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** The value for the current table entry */</span>
<a name="l00087"></a><a class="code" href="structapr__table__entry__t.html#a755371d0aa6a9487b502c34807271e6f">00087</a> <span class="keywordtype">char</span> *<a class="code" href="structapr__table__entry__t.html#a755371d0aa6a9487b502c34807271e6f">val</a>;
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /** A checksum for the key, for use by the apr_table internals */</span>
<a name="l00090"></a><a class="code" href="structapr__table__entry__t.html#a0c51574420b6cc7bc6c2e35710e0ad3a">00090</a> apr_uint32_t <a class="code" href="structapr__table__entry__t.html#a0c51574420b6cc7bc6c2e35710e0ad3a">key_checksum</a>;
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">/**</span>
<a name="l00094"></a>00094 <span class="comment"> * Get the elements from a table.</span>
<a name="l00095"></a>00095 <span class="comment"> * @param t The table</span>
<a name="l00096"></a>00096 <span class="comment"> * @return An array containing the contents of the table</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keyword">const</span> <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="group__apr__tables.html#gaea3005541cce67481f48ab201b5c0cf3">apr_table_elts</a>(const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t);
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment">/**</span>
<a name="l00101"></a>00101 <span class="comment"> * Determine if the table is empty (either NULL or having no elements).</span>
<a name="l00102"></a>00102 <span class="comment"> * @param t The table to check</span>
<a name="l00103"></a>00103 <span class="comment"> * @return True if empty, False otherwise</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__tables.html#ga198e52683a86ecf8df9642990c220ff7">apr_is_empty_table</a>(const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/**</span>
<a name="l00108"></a>00108 <span class="comment"> * Determine if the array is empty (either NULL or having no elements).</span>
<a name="l00109"></a>00109 <span class="comment"> * @param a The array to check</span>
<a name="l00110"></a>00110 <span class="comment"> * @return True if empty, False otherwise</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__tables.html#gacae19f5b2182d5813f4ef3050f82ff29">apr_is_empty_array</a>(const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *a);
<a name="l00113"></a>00113 <span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment">/**</span>
<a name="l00115"></a>00115 <span class="comment"> * Create an array.</span>
<a name="l00116"></a>00116 <span class="comment"> * @param p The pool to allocate the memory out of</span>
<a name="l00117"></a>00117 <span class="comment"> * @param nelts the number of elements in the initial array</span>
<a name="l00118"></a>00118 <span class="comment"> * @param elt_size The size of each element in the array.</span>
<a name="l00119"></a>00119 <span class="comment"> * @return The new array</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>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="group__apr__tables.html#ga8f4308b5a1636ec06544113a9c283304">apr_array_make</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00122"></a>00122 <span class="keywordtype">int</span> nelts, <span class="keywordtype">int</span> elt_size);
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment">/**</span>
<a name="l00125"></a>00125 <span class="comment"> * Add a new element to an array (as a first-in, last-out stack).</span>
<a name="l00126"></a>00126 <span class="comment"> * @param arr The array to add an element to.</span>
<a name="l00127"></a>00127 <span class="comment"> * @return Location for the new element in the array.</span>
<a name="l00128"></a>00128 <span class="comment"> * @remark If there are no free spots in the array, then this function will</span>
<a name="l00129"></a>00129 <span class="comment"> * allocate new space for the new element.</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__tables.html#gac08267b32905197dd02ffff3314d9603">apr_array_push</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *arr);
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment">/** A helper macro for accessing a member of an APR array.</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * @param ary the array</span>
<a name="l00136"></a>00136 <span class="comment"> * @param i the index into the array to return</span>
<a name="l00137"></a>00137 <span class="comment"> * @param type the type of the objects stored in the array</span>
<a name="l00138"></a>00138 <span class="comment"> *</span>
<a name="l00139"></a>00139 <span class="comment"> * @return the item at index i</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a><a class="code" href="group__apr__tables.html#ga84066caaa4c7632671af18c229809fc4">00141</a> <span class="preprocessor">#define APR_ARRAY_IDX(ary,i,type) (((type *)(ary)->elts)[i])</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment">/** A helper macro for pushing elements into an APR array.</span>
<a name="l00144"></a>00144 <span class="comment"> *</span>
<a name="l00145"></a>00145 <span class="comment"> * @param ary the array</span>
<a name="l00146"></a>00146 <span class="comment"> * @param type the type of the objects stored in the array</span>
<a name="l00147"></a>00147 <span class="comment"> *</span>
<a name="l00148"></a>00148 <span class="comment"> * @return the location where the new object should be placed</span>
<a name="l00149"></a>00149 <span class="comment"> */</span>
<a name="l00150"></a><a class="code" href="group__apr__tables.html#ga1833b0f940ec03d0b95926812152e1ca">00150</a> <span class="preprocessor">#define APR_ARRAY_PUSH(ary,type) (*((type *)apr_array_push(ary)))</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00152"></a>00152 <span class="comment">/**</span>
<a name="l00153"></a>00153 <span class="comment"> * Remove an element from an array (as a first-in, last-out stack).</span>
<a name="l00154"></a>00154 <span class="comment"> * @param arr The array to remove an element from.</span>
<a name="l00155"></a>00155 <span class="comment"> * @return Location of the element in the array.</span>
<a name="l00156"></a>00156 <span class="comment"> * @remark If there are no elements in the array, NULL is returned.</span>
<a name="l00157"></a>00157 <span class="comment"> */</span>
<a name="l00158"></a>00158 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span> *) <a class="code" href="group__apr__tables.html#gad1ab3e0ca2de25a7ff2fbed393380972">apr_array_pop</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *arr);
<a name="l00159"></a>00159 <span class="comment"></span>
<a name="l00160"></a>00160 <span class="comment">/**</span>
<a name="l00161"></a>00161 <span class="comment"> * Remove all elements from an array.</span>
<a name="l00162"></a>00162 <span class="comment"> * @param arr The array to remove all elements from.</span>
<a name="l00163"></a>00163 <span class="comment"> * @remark As the underlying storage is allocated from a pool, no</span>
<a name="l00164"></a>00164 <span class="comment"> * memory is freed by this operation, but is available for reuse.</span>
<a name="l00165"></a>00165 <span class="comment"> */</span>
<a name="l00166"></a>00166 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga6a6436840256ed8a47b5d6be4ea2ae03">apr_array_clear</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *arr);
<a name="l00167"></a>00167 <span class="comment"></span>
<a name="l00168"></a>00168 <span class="comment">/**</span>
<a name="l00169"></a>00169 <span class="comment"> * Concatenate two arrays together.</span>
<a name="l00170"></a>00170 <span class="comment"> * @param dst The destination array, and the one to go first in the combined </span>
<a name="l00171"></a>00171 <span class="comment"> * array</span>
<a name="l00172"></a>00172 <span class="comment"> * @param src The source array to add to the destination array</span>
<a name="l00173"></a>00173 <span class="comment"> */</span>
<a name="l00174"></a>00174 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga532e0f0e4d1e2b7243ebdb7eb1f783c7">apr_array_cat</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *dst,
<a name="l00175"></a>00175 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *src);
<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 the entire array.</span>
<a name="l00179"></a>00179 <span class="comment"> * @param p The pool to allocate the copy of the array out of</span>
<a name="l00180"></a>00180 <span class="comment"> * @param arr The array to copy</span>
<a name="l00181"></a>00181 <span class="comment"> * @return An exact copy of the array passed in</span>
<a name="l00182"></a>00182 <span class="comment"> * @remark The alternate apr_array_copy_hdr copies only the header, and arranges </span>
<a name="l00183"></a>00183 <span class="comment"> * for the elements to be copied if (and only if) the code subsequently</span>
<a name="l00184"></a>00184 <span class="comment"> * does a push or arraycat.</span>
<a name="l00185"></a>00185 <span class="comment"> */</span>
<a name="l00186"></a>00186 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="group__apr__tables.html#ga327e2d5e29fa49d5a2a31295a6932950">apr_array_copy</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00187"></a>00187 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *arr);<span class="comment"></span>
<a name="l00188"></a>00188 <span class="comment">/**</span>
<a name="l00189"></a>00189 <span class="comment"> * Copy the headers of the array, and arrange for the elements to be copied if</span>
<a name="l00190"></a>00190 <span class="comment"> * and only if the code subsequently does a push or arraycat.</span>
<a name="l00191"></a>00191 <span class="comment"> * @param p The pool to allocate the copy of the array out of</span>
<a name="l00192"></a>00192 <span class="comment"> * @param arr The array to copy</span>
<a name="l00193"></a>00193 <span class="comment"> * @return An exact copy of the array passed in</span>
<a name="l00194"></a>00194 <span class="comment"> * @remark The alternate apr_array_copy copies the *entire* array.</span>
<a name="l00195"></a>00195 <span class="comment"> */</span>
<a name="l00196"></a>00196 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="group__apr__tables.html#ga6203e9f731bf43e7373857c38d04397d">apr_array_copy_hdr</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00197"></a>00197 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *arr);
<a name="l00198"></a>00198 <span class="comment"></span>
<a name="l00199"></a>00199 <span class="comment">/**</span>
<a name="l00200"></a>00200 <span class="comment"> * Append one array to the end of another, creating a new array in the process.</span>
<a name="l00201"></a>00201 <span class="comment"> * @param p The pool to allocate the new array out of</span>
<a name="l00202"></a>00202 <span class="comment"> * @param first The array to put first in the new array.</span>
<a name="l00203"></a>00203 <span class="comment"> * @param second The array to put second in the new array.</span>
<a name="l00204"></a>00204 <span class="comment"> * @return A new array containing the data from the two arrays passed in.</span>
<a name="l00205"></a>00205 <span class="comment">*/</span>
<a name="l00206"></a>00206 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="group__apr__tables.html#ga893cade58c5fabecb593cb4ffac7e9be">apr_array_append</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00207"></a>00207 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *first,
<a name="l00208"></a>00208 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *second);
<a name="l00209"></a>00209 <span class="comment"></span>
<a name="l00210"></a>00210 <span class="comment">/**</span>
<a name="l00211"></a>00211 <span class="comment"> * Generate a new string from the apr_pool_t containing the concatenated </span>
<a name="l00212"></a>00212 <span class="comment"> * sequence of substrings referenced as elements within the array. The string </span>
<a name="l00213"></a>00213 <span class="comment"> * will be empty if all substrings are empty or null, or if there are no </span>
<a name="l00214"></a>00214 <span class="comment"> * elements in the array. If sep is non-NUL, it will be inserted between </span>
<a name="l00215"></a>00215 <span class="comment"> * elements as a separator.</span>
<a name="l00216"></a>00216 <span class="comment"> * @param p The pool to allocate the string out of</span>
<a name="l00217"></a>00217 <span class="comment"> * @param arr The array to generate the string from</span>
<a name="l00218"></a>00218 <span class="comment"> * @param sep The separator to use</span>
<a name="l00219"></a>00219 <span class="comment"> * @return A string containing all of the data in the array.</span>
<a name="l00220"></a>00220 <span class="comment"> */</span>
<a name="l00221"></a>00221 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">char</span> *) <a class="code" href="group__apr__tables.html#ga6232817e4a32ee5619c99fe55e145c7a">apr_array_pstrcat</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00222"></a>00222 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *arr,
<a name="l00223"></a>00223 const <span class="keywordtype">char</span> sep);
<a name="l00224"></a>00224 <span class="comment"></span>
<a name="l00225"></a>00225 <span class="comment">/**</span>
<a name="l00226"></a>00226 <span class="comment"> * Make a new table.</span>
<a name="l00227"></a>00227 <span class="comment"> * @param p The pool to allocate the pool out of</span>
<a name="l00228"></a>00228 <span class="comment"> * @param nelts The number of elements in the initial table.</span>
<a name="l00229"></a>00229 <span class="comment"> * @return The new table.</span>
<a name="l00230"></a>00230 <span class="comment"> * @warning This table can only store text data</span>
<a name="l00231"></a>00231 <span class="comment"> */</span>
<a name="l00232"></a>00232 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *) <a class="code" href="group__apr__tables.html#ga7b0a16a1388c68e66bff32190cf092f6">apr_table_make</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keywordtype">int</span> nelts);
<a name="l00233"></a>00233 <span class="comment"></span>
<a name="l00234"></a>00234 <span class="comment">/**</span>
<a name="l00235"></a>00235 <span class="comment"> * Create a new table and copy another table into it.</span>
<a name="l00236"></a>00236 <span class="comment"> * @param p The pool to allocate the new table out of</span>
<a name="l00237"></a>00237 <span class="comment"> * @param t The table to copy</span>
<a name="l00238"></a>00238 <span class="comment"> * @return A copy of the table passed in</span>
<a name="l00239"></a>00239 <span class="comment"> * @warning The table keys and respective values are not copied</span>
<a name="l00240"></a>00240 <span class="comment"> */</span>
<a name="l00241"></a>00241 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *) <a class="code" href="group__apr__tables.html#gae69f2b0b593bcdbf4c678a0f3dfde5f3">apr_table_copy</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00242"></a>00242 const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t);
<a name="l00243"></a>00243 <span class="comment"></span>
<a name="l00244"></a>00244 <span class="comment">/**</span>
<a name="l00245"></a>00245 <span class="comment"> * Create a new table whose contents are deep copied from the given</span>
<a name="l00246"></a>00246 <span class="comment"> * table. A deep copy operation copies all fields, and makes copies</span>
<a name="l00247"></a>00247 <span class="comment"> * of dynamically allocated memory pointed to by the fields.</span>
<a name="l00248"></a>00248 <span class="comment"> * @param p The pool to allocate the new table out of</span>
<a name="l00249"></a>00249 <span class="comment"> * @param t The table to clone</span>
<a name="l00250"></a>00250 <span class="comment"> * @return A deep copy of the table passed in</span>
<a name="l00251"></a>00251 <span class="comment"> */</span>
<a name="l00252"></a>00252 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *) <a class="code" href="group__apr__tables.html#ga7e8bc16b272840302545ed4a6a082a6e">apr_table_clone</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00253"></a>00253 const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t);
<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"> * Delete all of the elements from a table.</span>
<a name="l00257"></a>00257 <span class="comment"> * @param t The table to clear</span>
<a name="l00258"></a>00258 <span class="comment"> */</span>
<a name="l00259"></a>00259 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga03f03de545f9a18e25420f261938ffea">apr_table_clear</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t);
<a name="l00260"></a>00260 <span class="comment"></span>
<a name="l00261"></a>00261 <span class="comment">/**</span>
<a name="l00262"></a>00262 <span class="comment"> * Get the value associated with a given key from the table. After this call,</span>
<a name="l00263"></a>00263 <span class="comment"> * the data is still in the table.</span>
<a name="l00264"></a>00264 <span class="comment"> * @param t The table to search for the key</span>
<a name="l00265"></a>00265 <span class="comment"> * @param key The key to search for (case does not matter)</span>
<a name="l00266"></a>00266 <span class="comment"> * @return The value associated with the key, or NULL if the key does not exist. </span>
<a name="l00267"></a>00267 <span class="comment"> */</span>
<a name="l00268"></a>00268 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(const <span class="keywordtype">char</span> *) <a class="code" href="group__apr__tables.html#ga4db13e3915c6b9a3142b175d4c15d915">apr_table_get</a>(const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key);
<a name="l00269"></a>00269 <span class="comment"></span>
<a name="l00270"></a>00270 <span class="comment">/**</span>
<a name="l00271"></a>00271 <span class="comment"> * Add a key/value pair to a table. If another element already exists with the</span>
<a name="l00272"></a>00272 <span class="comment"> * same key, this will overwrite the old data.</span>
<a name="l00273"></a>00273 <span class="comment"> * @param t The table to add the data to.</span>
<a name="l00274"></a>00274 <span class="comment"> * @param key The key to use (case does not matter)</span>
<a name="l00275"></a>00275 <span class="comment"> * @param val The value to add</span>
<a name="l00276"></a>00276 <span class="comment"> * @remark When adding data, this function makes a copy of both the key and the</span>
<a name="l00277"></a>00277 <span class="comment"> * value.</span>
<a name="l00278"></a>00278 <span class="comment"> */</span>
<a name="l00279"></a>00279 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#gaf101d92c2f6343cdf4ec062ff416f244">apr_table_set</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key,
<a name="l00280"></a>00280 const <span class="keywordtype">char</span> *val);
<a name="l00281"></a>00281 <span class="comment"></span>
<a name="l00282"></a>00282 <span class="comment">/**</span>
<a name="l00283"></a>00283 <span class="comment"> * Add a key/value pair to a table. If another element already exists with the</span>
<a name="l00284"></a>00284 <span class="comment"> * same key, this will overwrite the old data.</span>
<a name="l00285"></a>00285 <span class="comment"> * @param t The table to add the data to.</span>
<a name="l00286"></a>00286 <span class="comment"> * @param key The key to use (case does not matter)</span>
<a name="l00287"></a>00287 <span class="comment"> * @param val The value to add</span>
<a name="l00288"></a>00288 <span class="comment"> * @warning When adding data, this function does not make a copy of the key or </span>
<a name="l00289"></a>00289 <span class="comment"> * the value, so care should be taken to ensure that the values will </span>
<a name="l00290"></a>00290 <span class="comment"> * not change after they have been added..</span>
<a name="l00291"></a>00291 <span class="comment"> */</span>
<a name="l00292"></a>00292 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga1fe7bb25d4027bb79d3c2bb41d8d8b75">apr_table_setn</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key,
<a name="l00293"></a>00293 const <span class="keywordtype">char</span> *val);
<a name="l00294"></a>00294 <span class="comment"></span>
<a name="l00295"></a>00295 <span class="comment">/**</span>
<a name="l00296"></a>00296 <span class="comment"> * Remove data from the table.</span>
<a name="l00297"></a>00297 <span class="comment"> * @param t The table to remove data from</span>
<a name="l00298"></a>00298 <span class="comment"> * @param key The key of the data being removed (case does not matter)</span>
<a name="l00299"></a>00299 <span class="comment"> */</span>
<a name="l00300"></a>00300 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#gab0df7a237feb4cd9beed201f4e236127">apr_table_unset</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key);
<a name="l00301"></a>00301 <span class="comment"></span>
<a name="l00302"></a>00302 <span class="comment">/**</span>
<a name="l00303"></a>00303 <span class="comment"> * Add data to a table by merging the value with data that has already been </span>
<a name="l00304"></a>00304 <span class="comment"> * stored. The merging is done by concatenating the two values, separated</span>
<a name="l00305"></a>00305 <span class="comment"> * by the string ", ".</span>
<a name="l00306"></a>00306 <span class="comment"> * @param t The table to search for the data</span>
<a name="l00307"></a>00307 <span class="comment"> * @param key The key to merge data for (case does not matter)</span>
<a name="l00308"></a>00308 <span class="comment"> * @param val The data to add</span>
<a name="l00309"></a>00309 <span class="comment"> * @remark If the key is not found, then this function acts like apr_table_add</span>
<a name="l00310"></a>00310 <span class="comment"> */</span>
<a name="l00311"></a>00311 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#gad5d10eca30b76fb44d999b4dfda8d632">apr_table_merge</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key,
<a name="l00312"></a>00312 const <span class="keywordtype">char</span> *val);
<a name="l00313"></a>00313 <span class="comment"></span>
<a name="l00314"></a>00314 <span class="comment">/**</span>
<a name="l00315"></a>00315 <span class="comment"> * Add data to a table by merging the value with data that has already been </span>
<a name="l00316"></a>00316 <span class="comment"> * stored. The merging is done by concatenating the two values, separated</span>
<a name="l00317"></a>00317 <span class="comment"> * by the string ", ".</span>
<a name="l00318"></a>00318 <span class="comment"> * @param t The table to search for the data</span>
<a name="l00319"></a>00319 <span class="comment"> * @param key The key to merge data for (case does not matter)</span>
<a name="l00320"></a>00320 <span class="comment"> * @param val The data to add</span>
<a name="l00321"></a>00321 <span class="comment"> * @remark If the key is not found, then this function acts like apr_table_addn</span>
<a name="l00322"></a>00322 <span class="comment"> */</span>
<a name="l00323"></a>00323 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga1d50805448114c476cfcd00d5ee3e3a8">apr_table_mergen</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key,
<a name="l00324"></a>00324 const <span class="keywordtype">char</span> *val);
<a name="l00325"></a>00325 <span class="comment"></span>
<a name="l00326"></a>00326 <span class="comment">/**</span>
<a name="l00327"></a>00327 <span class="comment"> * Add data to a table, regardless of whether there is another element with the</span>
<a name="l00328"></a>00328 <span class="comment"> * same key.</span>
<a name="l00329"></a>00329 <span class="comment"> * @param t The table to add to</span>
<a name="l00330"></a>00330 <span class="comment"> * @param key The key to use</span>
<a name="l00331"></a>00331 <span class="comment"> * @param val The value to add.</span>
<a name="l00332"></a>00332 <span class="comment"> * @remark When adding data, this function makes a copy of both the key and the</span>
<a name="l00333"></a>00333 <span class="comment"> * value.</span>
<a name="l00334"></a>00334 <span class="comment"> */</span>
<a name="l00335"></a>00335 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#gab2ea874754a0fbf139b7316c1f837f12">apr_table_add</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key,
<a name="l00336"></a>00336 const <span class="keywordtype">char</span> *val);
<a name="l00337"></a>00337 <span class="comment"></span>
<a name="l00338"></a>00338 <span class="comment">/**</span>
<a name="l00339"></a>00339 <span class="comment"> * Add data to a table, regardless of whether there is another element with the</span>
<a name="l00340"></a>00340 <span class="comment"> * same key.</span>
<a name="l00341"></a>00341 <span class="comment"> * @param t The table to add to</span>
<a name="l00342"></a>00342 <span class="comment"> * @param key The key to use</span>
<a name="l00343"></a>00343 <span class="comment"> * @param val The value to add.</span>
<a name="l00344"></a>00344 <span class="comment"> * @remark When adding data, this function does not make a copy of the key or the</span>
<a name="l00345"></a>00345 <span class="comment"> * value, so care should be taken to ensure that the values will not </span>
<a name="l00346"></a>00346 <span class="comment"> * change after they have been added.</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>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#gaff9fdbd8f499f0dfb07123230e19ea54">apr_table_addn</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, const <span class="keywordtype">char</span> *key,
<a name="l00349"></a>00349 const <span class="keywordtype">char</span> *val);
<a name="l00350"></a>00350 <span class="comment"></span>
<a name="l00351"></a>00351 <span class="comment">/**</span>
<a name="l00352"></a>00352 <span class="comment"> * Merge two tables into one new table.</span>
<a name="l00353"></a>00353 <span class="comment"> * @param p The pool to use for the new table</span>
<a name="l00354"></a>00354 <span class="comment"> * @param overlay The first table to put in the new table</span>
<a name="l00355"></a>00355 <span class="comment"> * @param base The table to add at the end of the new table</span>
<a name="l00356"></a>00356 <span class="comment"> * @return A new table containing all of the data from the two passed in</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>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *) <a class="code" href="group__apr__tables.html#ga783b5c439d46c109bb45e7bc1a6d7ef2">apr_table_overlay</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
<a name="l00359"></a>00359 const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *overlay,
<a name="l00360"></a>00360 const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *base);
<a name="l00361"></a>00361 <span class="comment"></span>
<a name="l00362"></a>00362 <span class="comment">/**</span>
<a name="l00363"></a>00363 <span class="comment"> * Declaration prototype for the iterator callback function of apr_table_do()</span>
<a name="l00364"></a>00364 <span class="comment"> * and apr_table_vdo().</span>
<a name="l00365"></a>00365 <span class="comment"> * @param rec The data passed as the first argument to apr_table_[v]do()</span>
<a name="l00366"></a>00366 <span class="comment"> * @param key The key from this iteration of the table</span>
<a name="l00367"></a>00367 <span class="comment"> * @param value The value from this iteration of the table</span>
<a name="l00368"></a>00368 <span class="comment"> * @remark Iteration continues while this callback function returns non-zero.</span>
<a name="l00369"></a>00369 <span class="comment"> * To export the callback function for apr_table_[v]do() it must be declared </span>
<a name="l00370"></a>00370 <span class="comment"> * in the _NONSTD convention.</span>
<a name="l00371"></a>00371 <span class="comment"> */</span>
<a name="l00372"></a><a class="code" href="group__apr__tables.html#ga0a59d6b321ade650c7cfa31d7fa93dcc">00372</a> typedef <span class="keywordtype">int</span> (<a class="code" href="group__apr__tables.html#ga0a59d6b321ade650c7cfa31d7fa93dcc">apr_table_do_callback_fn_t</a>)(<span class="keywordtype">void</span> *rec, const <span class="keywordtype">char</span> *key,
<a name="l00373"></a>00373 const <span class="keywordtype">char</span> *value);
<a name="l00374"></a>00374 <span class="comment"></span>
<a name="l00375"></a>00375 <span class="comment">/** </span>
<a name="l00376"></a>00376 <span class="comment"> * Iterate over a table running the provided function once for every</span>
<a name="l00377"></a>00377 <span class="comment"> * element in the table. The varargs array must be a list of zero or</span>
<a name="l00378"></a>00378 <span class="comment"> * more (char *) keys followed by a NULL pointer. If zero keys are</span>
<a name="l00379"></a>00379 <span class="comment"> * given, the @param comp function will be invoked for every element</span>
<a name="l00380"></a>00380 <span class="comment"> * in the table. Otherwise, the function is invoked only for those</span>
<a name="l00381"></a>00381 <span class="comment"> * elements matching the keys specified.</span>
<a name="l00382"></a>00382 <span class="comment"> *</span>
<a name="l00383"></a>00383 <span class="comment"> * If an invocation of the @param comp function returns zero,</span>
<a name="l00384"></a>00384 <span class="comment"> * iteration will continue using the next specified key, if any.</span>
<a name="l00385"></a>00385 <span class="comment"> *</span>
<a name="l00386"></a>00386 <span class="comment"> * @param comp The function to run</span>
<a name="l00387"></a>00387 <span class="comment"> * @param rec The data to pass as the first argument to the function</span>
<a name="l00388"></a>00388 <span class="comment"> * @param t The table to iterate over</span>
<a name="l00389"></a>00389 <span class="comment"> * @param ... A varargs array of zero or more (char *) keys followed by NULL</span>
<a name="l00390"></a>00390 <span class="comment"> * @return FALSE if one of the comp() iterations returned zero; TRUE if all</span>
<a name="l00391"></a>00391 <span class="comment"> * iterations returned non-zero</span>
<a name="l00392"></a>00392 <span class="comment"> * @see apr_table_do_callback_fn_t</span>
<a name="l00393"></a>00393 <span class="comment"> */</span>
<a name="l00394"></a>00394 <a class="code" href="group__apr__platform.html#ga3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__tables.html#ga5917e542ae910961ee48b0ec2d09a879">apr_table_do</a>(<a class="code" href="group__apr__tables.html#ga0a59d6b321ade650c7cfa31d7fa93dcc">apr_table_do_callback_fn_t</a> *comp,
<a name="l00395"></a>00395 <span class="keywordtype">void</span> *rec, const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, ...)
<a name="l00396"></a>00396 <span class="preprocessor">#if defined(__GNUC__) && __GNUC__ >= 4</span>
<a name="l00397"></a>00397 <span class="preprocessor"></span> __attribute__((sentinel))
<a name="l00398"></a>00398 <span class="preprocessor">#endif</span>
<a name="l00399"></a>00399 <span class="preprocessor"></span> ;
<a name="l00400"></a>00400 <span class="comment"></span>
<a name="l00401"></a>00401 <span class="comment">/** </span>
<a name="l00402"></a>00402 <span class="comment"> * Iterate over a table running the provided function once for every</span>
<a name="l00403"></a>00403 <span class="comment"> * element in the table. The @param vp varargs parameter must be a</span>
<a name="l00404"></a>00404 <span class="comment"> * list of zero or more (char *) keys followed by a NULL pointer. If</span>
<a name="l00405"></a>00405 <span class="comment"> * zero keys are given, the @param comp function will be invoked for</span>
<a name="l00406"></a>00406 <span class="comment"> * every element in the table. Otherwise, the function is invoked</span>
<a name="l00407"></a>00407 <span class="comment"> * only for those elements matching the keys specified.</span>
<a name="l00408"></a>00408 <span class="comment"> *</span>
<a name="l00409"></a>00409 <span class="comment"> * If an invocation of the @param comp function returns zero,</span>
<a name="l00410"></a>00410 <span class="comment"> * iteration will continue using the next specified key, if any.</span>
<a name="l00411"></a>00411 <span class="comment"> *</span>
<a name="l00412"></a>00412 <span class="comment"> * @param comp The function to run</span>
<a name="l00413"></a>00413 <span class="comment"> * @param rec The data to pass as the first argument to the function</span>
<a name="l00414"></a>00414 <span class="comment"> * @param t The table to iterate over</span>
<a name="l00415"></a>00415 <span class="comment"> * @param vp List of zero or more (char *) keys followed by NULL</span>
<a name="l00416"></a>00416 <span class="comment"> * @return FALSE if one of the comp() iterations returned zero; TRUE if all</span>
<a name="l00417"></a>00417 <span class="comment"> * iterations returned non-zero</span>
<a name="l00418"></a>00418 <span class="comment"> * @see apr_table_do_callback_fn_t</span>
<a name="l00419"></a>00419 <span class="comment"> */</span>
<a name="l00420"></a>00420 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__tables.html#ga753c5247c9cd7f90c8958b64d9b6aeae">apr_table_vdo</a>(<a class="code" href="group__apr__tables.html#ga0a59d6b321ade650c7cfa31d7fa93dcc">apr_table_do_callback_fn_t</a> *comp,
<a name="l00421"></a>00421 <span class="keywordtype">void</span> *rec, const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, va_list vp);
<a name="l00422"></a>00422 <span class="comment"></span>
<a name="l00423"></a>00423 <span class="comment">/** flag for overlap to use apr_table_setn */</span>
<a name="l00424"></a><a class="code" href="group__apr__tables.html#ga867455bb7008872e03b08c0742f9698c">00424</a> <span class="preprocessor">#define APR_OVERLAP_TABLES_SET (0)</span>
<a name="l00425"></a>00425 <span class="preprocessor"></span><span class="comment">/** flag for overlap to use apr_table_mergen */</span>
<a name="l00426"></a><a class="code" href="group__apr__tables.html#ga553eea6eb6fea4bafaf4cbd7acafdf5f">00426</a> <span class="preprocessor">#define APR_OVERLAP_TABLES_MERGE (1)</span>
<a name="l00427"></a>00427 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00428"></a>00428 <span class="comment"> * For each element in table b, either use setn or mergen to add the data</span>
<a name="l00429"></a>00429 <span class="comment"> * to table a. Which method is used is determined by the flags passed in.</span>
<a name="l00430"></a>00430 <span class="comment"> * @param a The table to add the data to.</span>
<a name="l00431"></a>00431 <span class="comment"> * @param b The table to iterate over, adding its data to table a</span>
<a name="l00432"></a>00432 <span class="comment"> * @param flags How to add the table to table a. One of:</span>
<a name="l00433"></a>00433 <span class="comment"> * APR_OVERLAP_TABLES_SET Use apr_table_setn</span>
<a name="l00434"></a>00434 <span class="comment"> * APR_OVERLAP_TABLES_MERGE Use apr_table_mergen</span>
<a name="l00435"></a>00435 <span class="comment"> * @remark When merging duplicates, the two values are concatenated,</span>
<a name="l00436"></a>00436 <span class="comment"> * separated by the string ", ".</span>
<a name="l00437"></a>00437 <span class="comment"> * @remark This function is highly optimized, and uses less memory and CPU cycles</span>
<a name="l00438"></a>00438 <span class="comment"> * than a function that just loops through table b calling other functions.</span>
<a name="l00439"></a>00439 <span class="comment"> */</span><span class="comment"></span>
<a name="l00440"></a>00440 <span class="comment">/**</span>
<a name="l00441"></a>00441 <span class="comment"> * Conceptually, apr_table_overlap does this:</span>
<a name="l00442"></a>00442 <span class="comment"> *</span>
<a name="l00443"></a>00443 <span class="comment"> * <pre></span>
<a name="l00444"></a>00444 <span class="comment"> * apr_array_header_t *barr = apr_table_elts(b);</span>
<a name="l00445"></a>00445 <span class="comment"> * apr_table_entry_t *belt = (apr_table_entry_t *)barr->elts;</span>
<a name="l00446"></a>00446 <span class="comment"> * int i;</span>
<a name="l00447"></a>00447 <span class="comment"> *</span>
<a name="l00448"></a>00448 <span class="comment"> * for (i = 0; i < barr->nelts; ++i) {</span>
<a name="l00449"></a>00449 <span class="comment"> * if (flags & APR_OVERLAP_TABLES_MERGE) {</span>
<a name="l00450"></a>00450 <span class="comment"> * apr_table_mergen(a, belt[i].key, belt[i].val);</span>
<a name="l00451"></a>00451 <span class="comment"> * }</span>
<a name="l00452"></a>00452 <span class="comment"> * else {</span>
<a name="l00453"></a>00453 <span class="comment"> * apr_table_setn(a, belt[i].key, belt[i].val);</span>
<a name="l00454"></a>00454 <span class="comment"> * }</span>
<a name="l00455"></a>00455 <span class="comment"> * }</span>
<a name="l00456"></a>00456 <span class="comment"> * </pre></span>
<a name="l00457"></a>00457 <span class="comment"> *</span>
<a name="l00458"></a>00458 <span class="comment"> * Except that it is more efficient (less space and cpu-time) especially</span>
<a name="l00459"></a>00459 <span class="comment"> * when b has many elements.</span>
<a name="l00460"></a>00460 <span class="comment"> *</span>
<a name="l00461"></a>00461 <span class="comment"> * Notice the assumptions on the keys and values in b -- they must be</span>
<a name="l00462"></a>00462 <span class="comment"> * in an ancestor of a's pool. In practice b and a are usually from</span>
<a name="l00463"></a>00463 <span class="comment"> * the same pool.</span>
<a name="l00464"></a>00464 <span class="comment"> */</span>
<a name="l00465"></a>00465
<a name="l00466"></a>00466 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga603ebc9b97703b855f8ad77640165372">apr_table_overlap</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *a, const <a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *b,
<a name="l00467"></a>00467 <span class="keywordtype">unsigned</span> flags);
<a name="l00468"></a>00468 <span class="comment"></span>
<a name="l00469"></a>00469 <span class="comment">/**</span>
<a name="l00470"></a>00470 <span class="comment"> * Eliminate redundant entries in a table by either overwriting</span>
<a name="l00471"></a>00471 <span class="comment"> * or merging duplicates.</span>
<a name="l00472"></a>00472 <span class="comment"> *</span>
<a name="l00473"></a>00473 <span class="comment"> * @param t Table.</span>
<a name="l00474"></a>00474 <span class="comment"> * @param flags APR_OVERLAP_TABLES_MERGE to merge, or</span>
<a name="l00475"></a>00475 <span class="comment"> * APR_OVERLAP_TABLES_SET to overwrite</span>
<a name="l00476"></a>00476 <span class="comment"> * @remark When merging duplicates, the two values are concatenated,</span>
<a name="l00477"></a>00477 <span class="comment"> * separated by the string ", ".</span>
<a name="l00478"></a>00478 <span class="comment"> */</span>
<a name="l00479"></a>00479 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<span class="keywordtype">void</span>) <a class="code" href="group__apr__tables.html#ga7f2a652a0cdaf8c20588823c97a3007f">apr_table_compress</a>(<a class="code" href="group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *t, <span class="keywordtype">unsigned</span> flags);
<a name="l00480"></a>00480 <span class="comment"></span>
<a name="l00481"></a>00481 <span class="comment">/** @} */</span>
<a name="l00482"></a>00482
<a name="l00483"></a>00483 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00484"></a>00484 <span class="preprocessor"></span>}
<a name="l00485"></a>00485 <span class="preprocessor">#endif</span>
<a name="l00486"></a>00486 <span class="preprocessor"></span>
<a name="l00487"></a>00487 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_TABLES_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
>
135
