<!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_xlate.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.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="namespaces.html"><span>Namespaces</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 id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>apr_xlate.h</h1> </div>
</div>
<div class="contents">
<a href="apr__xlate_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_XLATE_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_XLATE_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "apu.h"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html" title="APR Error Codes.">apr_errno.h</a>"</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00026"></a>00026 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/**</span>
<a name="l00029"></a>00029 <span class="comment"> * @file apr_xlate.h</span>
<a name="l00030"></a>00030 <span class="comment"> * @brief APR I18N translation library</span>
<a name="l00031"></a>00031 <span class="comment"> */</span>
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/**</span>
<a name="l00034"></a>00034 <span class="comment"> * @defgroup APR_XLATE I18N translation library</span>
<a name="l00035"></a>00035 <span class="comment"> * @ingroup APR</span>
<a name="l00036"></a>00036 <span class="comment"> * @{</span>
<a name="l00037"></a>00037 <span class="comment"> */</span><span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/** Opaque translation buffer */</span>
<a name="l00039"></a><a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">00039</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> <a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a>;
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/**</span>
<a name="l00042"></a>00042 <span class="comment"> * Set up for converting text from one charset to another.</span>
<a name="l00043"></a>00043 <span class="comment"> * @param convset The handle to be filled in by this function</span>
<a name="l00044"></a>00044 <span class="comment"> * @param topage The name of the target charset</span>
<a name="l00045"></a>00045 <span class="comment"> * @param frompage The name of the source charset</span>
<a name="l00046"></a>00046 <span class="comment"> * @param pool The pool to use</span>
<a name="l00047"></a>00047 <span class="comment"> * @remark</span>
<a name="l00048"></a>00048 <span class="comment"> * Specify APR_DEFAULT_CHARSET for one of the charset</span>
<a name="l00049"></a>00049 <span class="comment"> * names to indicate the charset of the source code at</span>
<a name="l00050"></a>00050 <span class="comment"> * compile time. This is useful if there are literal</span>
<a name="l00051"></a>00051 <span class="comment"> * strings in the source code which must be translated</span>
<a name="l00052"></a>00052 <span class="comment"> * according to the charset of the source code.</span>
<a name="l00053"></a>00053 <span class="comment"> * APR_DEFAULT_CHARSET is not useful if the source code</span>
<a name="l00054"></a>00054 <span class="comment"> * of the caller was not encoded in the same charset as</span>
<a name="l00055"></a>00055 <span class="comment"> * APR at compile time.</span>
<a name="l00056"></a>00056 <span class="comment"> *</span>
<a name="l00057"></a>00057 <span class="comment"> * @remark</span>
<a name="l00058"></a>00058 <span class="comment"> * Specify APR_LOCALE_CHARSET for one of the charset</span>
<a name="l00059"></a>00059 <span class="comment"> * names to indicate the charset of the current locale.</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * @remark</span>
<a name="l00062"></a>00062 <span class="comment"> * Return APR_EINVAL if unable to procure a convset, or APR_ENOTIMPL</span>
<a name="l00063"></a>00063 <span class="comment"> * if charset transcoding is not available in this instance of</span>
<a name="l00064"></a>00064 <span class="comment"> * apr-util at all (i.e., APR_HAS_XLATE is undefined).</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___x_l_a_t_e.html#gab7d55348056d7e4cadbc35cfb8e1e624">apr_xlate_open</a>(<a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> **convset,
<a name="l00067"></a>00067 const <span class="keywordtype">char</span> *topage,
<a name="l00068"></a>00068 const <span class="keywordtype">char</span> *frompage,
<a name="l00069"></a>00069 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment">/** </span>
<a name="l00072"></a>00072 <span class="comment"> * This is to indicate the charset of the sourcecode at compile time</span>
<a name="l00073"></a>00073 <span class="comment"> * names to indicate the charset of the source code at</span>
<a name="l00074"></a>00074 <span class="comment"> * compile time. This is useful if there are literal</span>
<a name="l00075"></a>00075 <span class="comment"> * strings in the source code which must be translated</span>
<a name="l00076"></a>00076 <span class="comment"> * according to the charset of the source code.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a><a class="code" href="group___a_p_r___x_l_a_t_e.html#ga3276c680eb0917ff51ff22c9b9959fa9">00078</a> <span class="preprocessor">#define APR_DEFAULT_CHARSET (const char *)0</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00080"></a>00080 <span class="comment"> * To indicate charset names of the current locale </span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a><a class="code" href="group___a_p_r___x_l_a_t_e.html#ga0e46c333fb1c900f0dd4a78664f5a0de">00082</a> <span class="preprocessor">#define APR_LOCALE_CHARSET (const char *)1</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">/**</span>
<a name="l00085"></a>00085 <span class="comment"> * Find out whether or not the specified conversion is single-byte-only.</span>
<a name="l00086"></a>00086 <span class="comment"> * @param convset The handle allocated by apr_xlate_open, specifying the </span>
<a name="l00087"></a>00087 <span class="comment"> * parameters of conversion</span>
<a name="l00088"></a>00088 <span class="comment"> * @param onoff Output: whether or not the conversion is single-byte-only</span>
<a name="l00089"></a>00089 <span class="comment"> * @remark</span>
<a name="l00090"></a>00090 <span class="comment"> * Return APR_ENOTIMPL if charset transcoding is not available</span>
<a name="l00091"></a>00091 <span class="comment"> * in this instance of apr-util (i.e., APR_HAS_XLATE is undefined).</span>
<a name="l00092"></a>00092 <span class="comment"> */</span>
<a name="l00093"></a>00093 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___x_l_a_t_e.html#ga578875b2e6b2a19f8466b80e0768792e">apr_xlate_sb_get</a>(<a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset, <span class="keywordtype">int</span> *onoff);
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">/**</span>
<a name="l00096"></a>00096 <span class="comment"> * Convert a buffer of text from one codepage to another.</span>
<a name="l00097"></a>00097 <span class="comment"> * @param convset The handle allocated by apr_xlate_open, specifying </span>
<a name="l00098"></a>00098 <span class="comment"> * the parameters of conversion</span>
<a name="l00099"></a>00099 <span class="comment"> * @param inbuf The address of the source buffer</span>
<a name="l00100"></a>00100 <span class="comment"> * @param inbytes_left Input: the amount of input data to be translated</span>
<a name="l00101"></a>00101 <span class="comment"> * Output: the amount of input data not yet translated </span>
<a name="l00102"></a>00102 <span class="comment"> * @param outbuf The address of the destination buffer</span>
<a name="l00103"></a>00103 <span class="comment"> * @param outbytes_left Input: the size of the output buffer</span>
<a name="l00104"></a>00104 <span class="comment"> * Output: the amount of the output buffer not yet used</span>
<a name="l00105"></a>00105 <span class="comment"> * @remark</span>
<a name="l00106"></a>00106 <span class="comment"> * Returns APR_ENOTIMPL if charset transcoding is not available</span>
<a name="l00107"></a>00107 <span class="comment"> * in this instance of apr-util (i.e., APR_HAS_XLATE is undefined).</span>
<a name="l00108"></a>00108 <span class="comment"> * Returns APR_INCOMPLETE if the input buffer ends in an incomplete</span>
<a name="l00109"></a>00109 <span class="comment"> * multi-byte character.</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * To correctly terminate the output buffer for some multi-byte</span>
<a name="l00112"></a>00112 <span class="comment"> * character set encodings, a final call must be made to this function</span>
<a name="l00113"></a>00113 <span class="comment"> * after the complete input string has been converted, passing</span>
<a name="l00114"></a>00114 <span class="comment"> * the inbuf and inbytes_left parameters as NULL. (Note that this</span>
<a name="l00115"></a>00115 <span class="comment"> * mode only works from version 1.1.0 onwards)</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___x_l_a_t_e.html#gab92a20b644aa78ca94c6147b254a54f1">apr_xlate_conv_buffer</a>(<a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset,
<a name="l00118"></a>00118 const <span class="keywordtype">char</span> *inbuf,
<a name="l00119"></a>00119 apr_size_t *inbytes_left,
<a name="l00120"></a>00120 <span class="keywordtype">char</span> *outbuf,
<a name="l00121"></a>00121 apr_size_t *outbytes_left);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">/* @see apr_file_io.h the comment in apr_file_io.h about this hack */</span>
<a name="l00124"></a>00124 <span class="preprocessor">#ifdef APR_NOT_DONE_YET</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00126"></a>00126 <span class="comment"> * The purpose of apr_xlate_conv_char is to translate one character</span>
<a name="l00127"></a>00127 <span class="comment"> * at a time. This needs to be written carefully so that it works</span>
<a name="l00128"></a>00128 <span class="comment"> * with double-byte character sets. </span>
<a name="l00129"></a>00129 <span class="comment"> * @param convset The handle allocated by apr_xlate_open, specifying the</span>
<a name="l00130"></a>00130 <span class="comment"> * parameters of conversion</span>
<a name="l00131"></a>00131 <span class="comment"> * @param inchar The character to convert</span>
<a name="l00132"></a>00132 <span class="comment"> * @param outchar The converted character</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_xlate_conv_char(<a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset,
<a name="l00135"></a>00135 <span class="keywordtype">char</span> inchar, <span class="keywordtype">char</span> outchar);
<a name="l00136"></a>00136 <span class="preprocessor">#endif</span>
<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment">/**</span>
<a name="l00139"></a>00139 <span class="comment"> * Convert a single-byte character from one charset to another.</span>
<a name="l00140"></a>00140 <span class="comment"> * @param convset The handle allocated by apr_xlate_open, specifying the </span>
<a name="l00141"></a>00141 <span class="comment"> * parameters of conversion</span>
<a name="l00142"></a>00142 <span class="comment"> * @param inchar The single-byte character to convert.</span>
<a name="l00143"></a>00143 <span class="comment"> * @warning This only works when converting between single-byte character sets.</span>
<a name="l00144"></a>00144 <span class="comment"> * -1 will be returned if the conversion can't be performed.</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 APU_DECLARE(apr_int32_t) <a class="code" href="group___a_p_r___x_l_a_t_e.html#ga90173cefe2dee6e5032ff17b15fea14b">apr_xlate_conv_byte</a>(<a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset,
<a name="l00147"></a>00147 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> inchar);
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">/**</span>
<a name="l00150"></a>00150 <span class="comment"> * Close a codepage translation handle.</span>
<a name="l00151"></a>00151 <span class="comment"> * @param convset The codepage translation handle to close</span>
<a name="l00152"></a>00152 <span class="comment"> * @remark</span>
<a name="l00153"></a>00153 <span class="comment"> * Return APR_ENOTIMPL if charset transcoding is not available</span>
<a name="l00154"></a>00154 <span class="comment"> * in this instance of apr-util (i.e., APR_HAS_XLATE is undefined).</span>
<a name="l00155"></a>00155 <span class="comment"> */</span>
<a name="l00156"></a>00156 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___x_l_a_t_e.html#ga2f88b0f72cd2512b8002344308480a8f">apr_xlate_close</a>(<a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset);
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment">/** @} */</span>
<a name="l00159"></a>00159 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00160"></a>00160 <span class="preprocessor"></span>}
<a name="l00161"></a>00161 <span class="preprocessor">#endif</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span>
<a name="l00163"></a>00163 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_XLATE_H */</span>
</pre></div></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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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 class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
