<!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.11"/>
<title>ICU 58.2: 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="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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>
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.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">// Copyright (C) 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// License & terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* Copyright (C) 1997-2010, International Business Machines</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* Date Name Description</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* 06/23/00 aliu Creation.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">*/</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __UREP_H</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define __UREP_H</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> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></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> <a class="code" href="umachine_8h.html#a82c853d86803ab75c89267be54fbac6a">U_CDECL_BEGIN</a></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</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"> * General Notes</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> ********************************************************************</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * TODO</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Add usage scenario</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * Add test code</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * Talk about pinning</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * Talk about "can truncate result if out of memory"</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> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/********************************************************************</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Data Structures</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> ********************************************************************/</span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60"> 44</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="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html"> 53</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="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a6c4bfa47b6752f364e4dd3f2991cedbe"> 63</a></span>  int32_t (*<a class="code" href="structUReplaceableCallbacks.html#a6c4bfa47b6752f364e4dd3f2991cedbe">length</a>)(<span class="keyword">const</span> <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#acde97b3ed22a24127c66ecf38c698a72"> 76</a></span>  <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> (*<a class="code" href="structUReplaceableCallbacks.html#acde97b3ed22a24127c66ecf38c698a72">charAt</a>)(<span class="keyword">const</span> <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  int32_t offset);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#abeff06f74d058735c8ca083f034daa0f"> 89</a></span>  <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> (*<a class="code" href="structUReplaceableCallbacks.html#abeff06f74d058735c8ca083f034daa0f">char32At</a>)(<span class="keyword">const</span> <a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  int32_t offset);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a6fe116cc3825cc6c749a95f1bd0d2315"> 108</a></span>  void (*<a class="code" href="structUReplaceableCallbacks.html#a6fe116cc3825cc6c749a95f1bd0d2315">replace</a>)(<a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  int32_t start,</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  int32_t limit,</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* text,</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  int32_t textLength);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a423aefebaa21d2194334a795f7ae1809"> 127</a></span>  void (*<a class="code" href="structUReplaceableCallbacks.html#a423aefebaa21d2194334a795f7ae1809">extract</a>)(<a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  int32_t start,</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  int32_t limit,</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* dst);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="structUReplaceableCallbacks.html#a7affba31f6d3e5a31f8cd33358420fc6"> 148</a></span>  void (*<a class="code" href="structUReplaceableCallbacks.html#a7affba31f6d3e5a31f8cd33358420fc6">copy</a>)(<a class="code" href="urep_8h.html#a22b35ca6677ac47c2f5b0d01ffbead60">UReplaceable</a>* rep,</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  int32_t start,</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  int32_t limit,</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  int32_t dest); </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="urep_8h.html#aa74066a0ce9aa2d17bcc217892767057">UReplaceableCallbacks</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> <a class="code" href="umachine_8h.html#a1a820e5c6cbe8ac1742b654e6bf9ed7d">U_CDECL_END</a></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structUReplaceableCallbacks_html_a423aefebaa21d2194334a795f7ae1809"><div class="ttname"><a href="structUReplaceableCallbacks.html#a423aefebaa21d2194334a795f7ae1809">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#l00127">urep.h:127</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#l00044">urep.h:44</a></div></div>
<div class="ttc" id="structUReplaceableCallbacks_html_abeff06f74d058735c8ca083f034daa0f"><div class="ttname"><a href="structUReplaceableCallbacks.html#abeff06f74d058735c8ca083f034daa0f">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#l00089">urep.h:89</a></div></div>
<div class="ttc" id="structUReplaceableCallbacks_html_a7affba31f6d3e5a31f8cd33358420fc6"><div class="ttname"><a href="structUReplaceableCallbacks.html#a7affba31f6d3e5a31f8cd33358420fc6">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#l00148">urep.h:148</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#l00107">umachine.h:107</a></div></div>
<div class="ttc" id="structUReplaceableCallbacks_html_a6c4bfa47b6752f364e4dd3f2991cedbe"><div class="ttname"><a href="structUReplaceableCallbacks.html#a6c4bfa47b6752f364e4dd3f2991cedbe">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#l00063">urep.h:63</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#l00357">umachine.h:357</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#l00053">urep.h:53</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#l00337">umachine.h:337</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#l00108">umachine.h:108</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 class="ttc" id="structUReplaceableCallbacks_html_a6fe116cc3825cc6c749a95f1bd0d2315"><div class="ttname"><a href="structUReplaceableCallbacks.html#a6fe116cc3825cc6c749a95f1bd0d2315">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#l00108">urep.h:108</a></div></div>
<div class="ttc" id="structUReplaceableCallbacks_html_acde97b3ed22a24127c66ecf38c698a72"><div class="ttname"><a href="structUReplaceableCallbacks.html#acde97b3ed22a24127c66ecf38c698a72">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#l00076">urep.h:76</a></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.11
</small></address>
</body>
</html>
