<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.6"/> <title>ICU 53.1: urep.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ICU 53.1  <span id="projectnumber">53.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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> <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> <!-- 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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_55bf5c6bcedc2c5705af95fc7596ac50.html">icu</a></li><li class="navelem"><a class="el" href="dir_17c4e3d278dd0be6889e0e8c41145d45.html">source</a></li><li class="navelem"><a class="el" href="dir_9d30126de01c6acabed440c3eefed2e6.html">common</a></li><li class="navelem"><a class="el" href="dir_09927d28e4089b088d7b70dcc744d58d.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">urep.h</div> </div> </div><!--header--> <div class="contents"> <a href="urep_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (C) 1997-2010, International Business Machines</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* Date Name Description</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* 06/23/00 aliu Creation.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">*/</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef __UREP_H</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define __UREP_H</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <a class="code" href="umachine_8h.html#a82c853d86803ab75c89267be54fbac6a">U_CDECL_BEGIN</a></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/********************************************************************</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * General Notes</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> ********************************************************************</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * TODO</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Add usage scenario</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * Add test code</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Talk about pinning</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * Talk about "can truncate result if out of memory"</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/********************************************************************</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * Data Structures</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> ********************************************************************/</span></div> <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60"> 42</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span>* <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>;</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html"> 51</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structUReplaceableCallbacks.html">UReplaceableCallbacks</a> {</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#abe20b175db7fe49c652d32b0047bd44d"> 61</a></span>  int32_t (*<a class="code" href="structUReplaceableCallbacks.html#abe20b175db7fe49c652d32b0047bd44d">length</a>)(<span class="keyword">const</span> <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#add37b2389b812250b661fe51fe193941"> 74</a></span>  <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> (*<a class="code" href="structUReplaceableCallbacks.html#add37b2389b812250b661fe51fe193941">charAt</a>)(<span class="keyword">const</span> <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  int32_t offset);</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a6eb341066f05c7799cd13f6b0f1c56e7"> 87</a></span>  <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> (*<a class="code" href="structUReplaceableCallbacks.html#a6eb341066f05c7799cd13f6b0f1c56e7">char32At</a>)(<span class="keyword">const</span> <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  int32_t offset);</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div> <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a2c289af568adb2040768e83ae847c4b7"> 106</a></span>  void (*<a class="code" href="structUReplaceableCallbacks.html#a2c289af568adb2040768e83ae847c4b7">replace</a>)(<a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  int32_t start,</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  int32_t limit,</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* text,</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  int32_t textLength);</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div> <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a0973de83b91b9d436c268de9bc878316"> 125</a></span>  void (*<a class="code" href="structUReplaceableCallbacks.html#a0973de83b91b9d436c268de9bc878316">extract</a>)(<a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  int32_t start,</div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  int32_t limit,</div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* dst);</div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> <div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#afe7d8ea1241deed1c92c7209c99199d7"> 146</a></span>  void (*<a class="code" href="structUReplaceableCallbacks.html#afe7d8ea1241deed1c92c7209c99199d7">copy</a>)(<a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  int32_t start,</div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  int32_t limit,</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  int32_t dest); </div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> } <a class="code" href="urep_8h.html#aa74066a0ce9aa2d17bcc217892767057">UReplaceableCallbacks</a>;</div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <a class="code" href="umachine_8h.html#a1a820e5c6cbe8ac1742b654e6bf9ed7d">U_CDECL_END</a></div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#endif</span></div> <div class="ttc" id="structUReplaceableCallbacks_html_abe20b175db7fe49c652d32b0047bd44d"><div class="ttname"><a href="structUReplaceableCallbacks.html#abe20b175db7fe49c652d32b0047bd44d">UReplaceableCallbacks::length</a></div><div class="ttdeci">int32_t(* length)(const UReplaceable *rep)</div><div class="ttdoc">Function pointer that returns the number of UChar code units in this text. </div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00061">urep.h:61</a></div></div> <div class="ttc" id="urep_8h_html_a22b35ca6677ac47c2f5b0d01ffbead60"><div class="ttname"><a href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a></div><div class="ttdeci">void * UReplaceable</div><div class="ttdoc">An opaque replaceable text object. </div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00042">urep.h:42</a></div></div> <div class="ttc" id="umachine_8h_html_a82c853d86803ab75c89267be54fbac6a"><div class="ttname"><a href="umachine_8h.html#a82c853d86803ab75c89267be54fbac6a">U_CDECL_BEGIN</a></div><div class="ttdeci">#define U_CDECL_BEGIN</div><div class="ttdoc">This is used to begin a declaration of a library private ICU C API. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00082">umachine.h:82</a></div></div> <div class="ttc" id="structUReplaceableCallbacks_html_a6eb341066f05c7799cd13f6b0f1c56e7"><div class="ttname"><a href="structUReplaceableCallbacks.html#a6eb341066f05c7799cd13f6b0f1c56e7">UReplaceableCallbacks::char32At</a></div><div class="ttdeci">UChar32(* char32At)(const UReplaceable *rep, int32_t offset)</div><div class="ttdoc">Function pointer that returns a UChar32 code point at the given offset into this text. </div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00087">urep.h:87</a></div></div> <div class="ttc" id="structUReplaceableCallbacks_html_a2c289af568adb2040768e83ae847c4b7"><div class="ttname"><a href="structUReplaceableCallbacks.html#a2c289af568adb2040768e83ae847c4b7">UReplaceableCallbacks::replace</a></div><div class="ttdeci">void(* replace)(UReplaceable *rep, int32_t start, int32_t limit, const UChar *text, int32_t textLength)</div><div class="ttdoc">Function pointer that replaces text between start and limit in this text with the given text...</div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00106">urep.h:106</a></div></div> <div class="ttc" id="umachine_8h_html_a09fff5c3b5a5b015324dc3ec3cf92809"><div class="ttname"><a href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a></div><div class="ttdeci">int32_t UChar32</div><div class="ttdoc">Define UChar32 as a type for single Unicode code points. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00298">umachine.h:298</a></div></div> <div class="ttc" id="urep_8h_html_aa74066a0ce9aa2d17bcc217892767057"><div class="ttname"><a href="urep_8h.html#aa74066a0ce9aa2d17bcc217892767057">UReplaceableCallbacks</a></div><div class="ttdeci">struct UReplaceableCallbacks UReplaceableCallbacks</div><div class="ttdoc">A set of function pointers that transliterators use to manipulate a UReplaceable. ...</div></div> <div class="ttc" id="structUReplaceableCallbacks_html"><div class="ttname"><a href="structUReplaceableCallbacks.html">UReplaceableCallbacks</a></div><div class="ttdoc">A set of function pointers that transliterators use to manipulate a UReplaceable. ...</div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00051">urep.h:51</a></div></div> <div class="ttc" id="structUReplaceableCallbacks_html_a0973de83b91b9d436c268de9bc878316"><div class="ttname"><a href="structUReplaceableCallbacks.html#a0973de83b91b9d436c268de9bc878316">UReplaceableCallbacks::extract</a></div><div class="ttdeci">void(* extract)(UReplaceable *rep, int32_t start, int32_t limit, UChar *dst)</div><div class="ttdoc">Function pointer that copies the characters in the range [start, limit) into the array dst...</div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00125">urep.h:125</a></div></div> <div class="ttc" id="umachine_8h_html_a6bb9fad572d65b305324ef288165e2ac"><div class="ttname"><a href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="ttdeci">uint16_t UChar</div><div class="ttdoc">Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...</div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00278">umachine.h:278</a></div></div> <div class="ttc" id="umachine_8h_html_a1a820e5c6cbe8ac1742b654e6bf9ed7d"><div class="ttname"><a href="umachine_8h.html#a1a820e5c6cbe8ac1742b654e6bf9ed7d">U_CDECL_END</a></div><div class="ttdeci">#define U_CDECL_END</div><div class="ttdoc">This is used to end a declaration of a library private ICU C API. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00083">umachine.h:83</a></div></div> <div class="ttc" id="structUReplaceableCallbacks_html_afe7d8ea1241deed1c92c7209c99199d7"><div class="ttname"><a href="structUReplaceableCallbacks.html#afe7d8ea1241deed1c92c7209c99199d7">UReplaceableCallbacks::copy</a></div><div class="ttdeci">void(* copy)(UReplaceable *rep, int32_t start, int32_t limit, int32_t dest)</div><div class="ttdoc">Function pointer that copies text between start and limit in this text to another index in the text...</div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00146">urep.h:146</a></div></div> <div class="ttc" id="structUReplaceableCallbacks_html_add37b2389b812250b661fe51fe193941"><div class="ttname"><a href="structUReplaceableCallbacks.html#add37b2389b812250b661fe51fe193941">UReplaceableCallbacks::charAt</a></div><div class="ttdeci">UChar(* charAt)(const UReplaceable *rep, int32_t offset)</div><div class="ttdoc">Function pointer that returns a UChar code units at the given offset into this text; 0 <= offset < n...</div><div class="ttdef"><b>Definition:</b> <a href="urep_8h_source.html#l00074">urep.h:74</a></div></div> <div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> </body> </html>