<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.6: ushape.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</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>ushape.h File Reference</h1>C API: Arabic shaping. <a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="utypes_8h-source.html">unicode/utypes.h</a>"</code><br>
<p>
<a href="ushape_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#6a1f2f7bfdb19a43d3565b9dad22571f">U_SHAPE_LENGTH_GROW_SHRINK</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory option: allow the result to have a different length than the source. <a href="#6a1f2f7bfdb19a43d3565b9dad22571f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#067c06be151af4b0ee00a7a8c0553339">U_SHAPE_LENGTH_FIXED_SPACES_NEAR</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory option: the result must have the same length as the source. <a href="#067c06be151af4b0ee00a7a8c0553339"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#4550ccf631d9f6fd45d70bcd3266756d">U_SHAPE_LENGTH_FIXED_SPACES_AT_END</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory option: the result must have the same length as the source. <a href="#4550ccf631d9f6fd45d70bcd3266756d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#3bb94df74337f1bbd2793ea3557456fd">U_SHAPE_LENGTH_FIXED_SPACES_AT_BEGINNING</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory option: the result must have the same length as the source. <a href="#3bb94df74337f1bbd2793ea3557456fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#07a3119784a8db763914cf45f3cfd6bf">U_SHAPE_LENGTH_MASK</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit mask for memory options. <a href="#07a3119784a8db763914cf45f3cfd6bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#d36963ac2682d78232fd2838f0d6c4bf">U_SHAPE_TEXT_DIRECTION_LOGICAL</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Direction indicator: the source is in logical (keyboard) order. <a href="#d36963ac2682d78232fd2838f0d6c4bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#e379944cf4c71b7d1fc4410dbd7120c6">U_SHAPE_TEXT_DIRECTION_VISUAL_LTR</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Direction indicator: the source is in visual LTR order, the leftmost displayed character stored first. <a href="#e379944cf4c71b7d1fc4410dbd7120c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#2a455afff51ba49cbae8ba8fbded1467">U_SHAPE_TEXT_DIRECTION_MASK</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit mask for direction indicators. <a href="#2a455afff51ba49cbae8ba8fbded1467"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#b2591b984c0a4ee203f44cc6e62f0641">U_SHAPE_LETTERS_NOOP</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Letter shaping option: do not perform letter shaping. <a href="#b2591b984c0a4ee203f44cc6e62f0641"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#35a7060a92740af5059e81e6244501ae">U_SHAPE_LETTERS_SHAPE</a> 8</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Letter shaping option: replace abstract letter characters by "shaped" ones. <a href="#35a7060a92740af5059e81e6244501ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#467ea29597b4afeb621c2eac5b2f8e2e">U_SHAPE_LETTERS_UNSHAPE</a> 0x10</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Letter shaping option: replace "shaped" letter characters by abstract ones. <a href="#467ea29597b4afeb621c2eac5b2f8e2e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#aa252c41f59d8b13aeb19b6c4af703e7">U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED</a> 0x18</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Letter shaping option: replace abstract letter characters by "shaped" ones. <a href="#aa252c41f59d8b13aeb19b6c4af703e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#55165d3210c77071a656b23da6e629d7">U_SHAPE_LETTERS_MASK</a> 0x18</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit mask for letter shaping options. <a href="#55165d3210c77071a656b23da6e629d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#128ecde6923da39afc4b066452bfb20b">U_SHAPE_DIGITS_NOOP</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit shaping option: do not perform digit shaping. <a href="#128ecde6923da39afc4b066452bfb20b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#076d430390e29b366899aedf703d28ab">U_SHAPE_DIGITS_EN2AN</a> 0x20</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit shaping option: Replace European digits (U+0030. <a href="#076d430390e29b366899aedf703d28ab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#cd8e0e59cd951a98bfa82246817d9e3d">U_SHAPE_DIGITS_AN2EN</a> 0x40</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit shaping option: Replace Arabic-Indic digits by European digits (U+0030. <a href="#cd8e0e59cd951a98bfa82246817d9e3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#8a09d5e7b1ed9abb24f7e6a661985f8b">U_SHAPE_DIGITS_ALEN2AN_INIT_LR</a> 0x60</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit shaping option: Replace European digits (U+0030. <a href="#8a09d5e7b1ed9abb24f7e6a661985f8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#d4d3595d8e8acf62a983c330a94b7eea">U_SHAPE_DIGITS_ALEN2AN_INIT_AL</a> 0x80</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit shaping option: Replace European digits (U+0030. <a href="#d4d3595d8e8acf62a983c330a94b7eea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#d55c64656273fe4694da300163cc100e">U_SHAPE_DIGITS_RESERVED</a> 0xa0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Not a valid option value. <a href="#d55c64656273fe4694da300163cc100e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#7c053b32b1b4a2990e34de42a92ad6da">U_SHAPE_DIGITS_MASK</a> 0xe0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit mask for digit shaping options. <a href="#7c053b32b1b4a2990e34de42a92ad6da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#25839d9d3da0de5ce66fec0e8422858e">U_SHAPE_DIGIT_TYPE_AN</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit type option: Use Arabic-Indic digits (U+0660. <a href="#25839d9d3da0de5ce66fec0e8422858e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#1dde0161974e5a013bde61047b2d0cbd">U_SHAPE_DIGIT_TYPE_AN_EXTENDED</a> 0x100</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digit type option: Use Eastern (Extended) Arabic-Indic digits (U+06f0. <a href="#1dde0161974e5a013bde61047b2d0cbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#5be9054f489e828bd9b77d3a78cb7864">U_SHAPE_DIGIT_TYPE_RESERVED</a> 0x200</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Not a valid option value. <a href="#5be9054f489e828bd9b77d3a78cb7864"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#7000600c68e427693e43cd1a9eee4692">U_SHAPE_DIGIT_TYPE_MASK</a> 0x3f00</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit mask for digit type options. <a href="#7000600c68e427693e43cd1a9eee4692"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ushape_8h.html#b85f7fe2987a1b2702f455d65013a051">u_shapeArabic</a> (const UChar *source, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> sourceLength, UChar *dest, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> destSize, <a class="el" href="pwin32_8h.html#6dffdaa3be697bee6b7286a8120d3638">uint32_t</a> options, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> *<a class="el" href="ucnv_8h.html#7fb88d17e64bfb1dd2320c317ce1a1c6">pErrorCode</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shape Arabic text on a character basis. <a href="#b85f7fe2987a1b2702f455d65013a051"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C API: Arabic shaping.
<p>
<p>
Definition in file <a class="el" href="ushape_8h-source.html">ushape.h</a>.<hr><h2>Define Documentation</h2>
<a class="anchor" name="25839d9d3da0de5ce66fec0e8422858e"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGIT_TYPE_AN" ref="25839d9d3da0de5ce66fec0e8422858e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGIT_TYPE_AN 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit type option: Use Arabic-Indic digits (U+0660.
<p>
..U+0669).<dl compact><dt><b><a class="el" href="stable.html#_stable001606">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00223">223</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="1dde0161974e5a013bde61047b2d0cbd"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGIT_TYPE_AN_EXTENDED" ref="1dde0161974e5a013bde61047b2d0cbd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGIT_TYPE_AN_EXTENDED 0x100 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit type option: Use Eastern (Extended) Arabic-Indic digits (U+06f0.
<p>
..U+06f9).<dl compact><dt><b><a class="el" href="stable.html#_stable001607">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00226">226</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="7000600c68e427693e43cd1a9eee4692"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGIT_TYPE_MASK" ref="7000600c68e427693e43cd1a9eee4692" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGIT_TYPE_MASK 0x3f00 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bit mask for digit type options.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001609">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00232">232</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="5be9054f489e828bd9b77d3a78cb7864"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGIT_TYPE_RESERVED" ref="5be9054f489e828bd9b77d3a78cb7864" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGIT_TYPE_RESERVED 0x200 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Not a valid option value.
<p>
May be replaced by a new option.<dl compact><dt><b><a class="el" href="stable.html#_stable001608">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00229">229</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="d4d3595d8e8acf62a983c330a94b7eea"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_ALEN2AN_INIT_AL" ref="d4d3595d8e8acf62a983c330a94b7eea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_ALEN2AN_INIT_AL 0x80 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit shaping option: Replace European digits (U+0030.
<p>
..) by Arabic-Indic digits if the most recent strongly directional character is an Arabic letter (<code><a class="el" href="uchar_8h.html#1669f75d929585eb4c9394153b2adf31">u_charDirection()</a></code> result <code>U_RIGHT_TO_LEFT_ARABIC</code> [AL]).<br>
The direction of "preceding" depends on the direction indicator option. For the first characters, the preceding strongly directional character (initial state) is assumed to be an Arabic letter. <dl compact><dt><b><a class="el" href="stable.html#_stable001603">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00213">213</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="8a09d5e7b1ed9abb24f7e6a661985f8b"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_ALEN2AN_INIT_LR" ref="8a09d5e7b1ed9abb24f7e6a661985f8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_ALEN2AN_INIT_LR 0x60 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit shaping option: Replace European digits (U+0030.
<p>
..) by Arabic-Indic digits if the most recent strongly directional character is an Arabic letter (<code><a class="el" href="uchar_8h.html#1669f75d929585eb4c9394153b2adf31">u_charDirection()</a></code> result <code>U_RIGHT_TO_LEFT_ARABIC</code> [AL]).<br>
The direction of "preceding" depends on the direction indicator option. For the first characters, the preceding strongly directional character (initial state) is assumed to be not an Arabic letter (it is <code>U_LEFT_TO_RIGHT</code> [L] or <code>U_RIGHT_TO_LEFT</code> [R]). <dl compact><dt><b><a class="el" href="stable.html#_stable001602">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00201">201</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="cd8e0e59cd951a98bfa82246817d9e3d"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_AN2EN" ref="cd8e0e59cd951a98bfa82246817d9e3d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_AN2EN 0x40 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit shaping option: Replace Arabic-Indic digits by European digits (U+0030.
<p>
..). <dl compact><dt><b><a class="el" href="stable.html#_stable001601">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00188">188</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="076d430390e29b366899aedf703d28ab"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_EN2AN" ref="076d430390e29b366899aedf703d28ab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_EN2AN 0x20 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit shaping option: Replace European digits (U+0030.
<p>
..) by Arabic-Indic digits. <dl compact><dt><b><a class="el" href="stable.html#_stable001600">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00181">181</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="7c053b32b1b4a2990e34de42a92ad6da"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_MASK" ref="7c053b32b1b4a2990e34de42a92ad6da" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_MASK 0xe0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bit mask for digit shaping options.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001605">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00219">219</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="128ecde6923da39afc4b066452bfb20b"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_NOOP" ref="128ecde6923da39afc4b066452bfb20b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_NOOP 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Digit shaping option: do not perform digit shaping.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001599">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00174">174</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="d55c64656273fe4694da300163cc100e"></a><!-- doxytag: member="ushape.h::U_SHAPE_DIGITS_RESERVED" ref="d55c64656273fe4694da300163cc100e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_DIGITS_RESERVED 0xa0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Not a valid option value.
<p>
May be replaced by a new option.<dl compact><dt><b><a class="el" href="stable.html#_stable001604">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00216">216</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="3bb94df74337f1bbd2793ea3557456fd"></a><!-- doxytag: member="ushape.h::U_SHAPE_LENGTH_FIXED_SPACES_AT_BEGINNING" ref="3bb94df74337f1bbd2793ea3557456fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LENGTH_FIXED_SPACES_AT_BEGINNING 3 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Memory option: the result must have the same length as the source.
<p>
If more room is necessary, then try to consume spaces at the beginning of the text. <dl compact><dt><b><a class="el" href="stable.html#_stable001589">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00130">130</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="4550ccf631d9f6fd45d70bcd3266756d"></a><!-- doxytag: member="ushape.h::U_SHAPE_LENGTH_FIXED_SPACES_AT_END" ref="4550ccf631d9f6fd45d70bcd3266756d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LENGTH_FIXED_SPACES_AT_END 2 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Memory option: the result must have the same length as the source.
<p>
If more room is necessary, then try to consume spaces at the end of the text. <dl compact><dt><b><a class="el" href="stable.html#_stable001588">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00123">123</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="067c06be151af4b0ee00a7a8c0553339"></a><!-- doxytag: member="ushape.h::U_SHAPE_LENGTH_FIXED_SPACES_NEAR" ref="067c06be151af4b0ee00a7a8c0553339" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LENGTH_FIXED_SPACES_NEAR 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Memory option: the result must have the same length as the source.
<p>
If more room is necessary, then try to consume spaces next to modified characters. <dl compact><dt><b><a class="el" href="stable.html#_stable001587">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00116">116</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="6a1f2f7bfdb19a43d3565b9dad22571f"></a><!-- doxytag: member="ushape.h::U_SHAPE_LENGTH_GROW_SHRINK" ref="6a1f2f7bfdb19a43d3565b9dad22571f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LENGTH_GROW_SHRINK 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Memory option: allow the result to have a different length than the source.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001586">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00109">109</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="07a3119784a8db763914cf45f3cfd6bf"></a><!-- doxytag: member="ushape.h::U_SHAPE_LENGTH_MASK" ref="07a3119784a8db763914cf45f3cfd6bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LENGTH_MASK 3 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bit mask for memory options.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001590">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00133">133</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="55165d3210c77071a656b23da6e629d7"></a><!-- doxytag: member="ushape.h::U_SHAPE_LETTERS_MASK" ref="55165d3210c77071a656b23da6e629d7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LETTERS_MASK 0x18 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bit mask for letter shaping options.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001598">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00170">170</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="b2591b984c0a4ee203f44cc6e62f0641"></a><!-- doxytag: member="ushape.h::U_SHAPE_LETTERS_NOOP" ref="b2591b984c0a4ee203f44cc6e62f0641" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LETTERS_NOOP 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Letter shaping option: do not perform letter shaping.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001594">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00152">152</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="35a7060a92740af5059e81e6244501ae"></a><!-- doxytag: member="ushape.h::U_SHAPE_LETTERS_SHAPE" ref="35a7060a92740af5059e81e6244501ae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LETTERS_SHAPE 8 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Letter shaping option: replace abstract letter characters by "shaped" ones.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001595">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00155">155</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="aa252c41f59d8b13aeb19b6c4af703e7"></a><!-- doxytag: member="ushape.h::U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED" ref="aa252c41f59d8b13aeb19b6c4af703e7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED 0x18 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Letter shaping option: replace abstract letter characters by "shaped" ones.
<p>
The only difference with U_SHAPE_LETTERS_SHAPE is that Tashkeel letters are always "shaped" into the isolated form instead of the medial form (selecting code points from the Arabic Presentation Forms-B block). <dl compact><dt><b><a class="el" href="stable.html#_stable001597">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00167">167</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="467ea29597b4afeb621c2eac5b2f8e2e"></a><!-- doxytag: member="ushape.h::U_SHAPE_LETTERS_UNSHAPE" ref="467ea29597b4afeb621c2eac5b2f8e2e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_LETTERS_UNSHAPE 0x10 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Letter shaping option: replace "shaped" letter characters by abstract ones.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001596">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00158">158</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="d36963ac2682d78232fd2838f0d6c4bf"></a><!-- doxytag: member="ushape.h::U_SHAPE_TEXT_DIRECTION_LOGICAL" ref="d36963ac2682d78232fd2838f0d6c4bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_TEXT_DIRECTION_LOGICAL 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Direction indicator: the source is in logical (keyboard) order.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001591">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00137">137</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="2a455afff51ba49cbae8ba8fbded1467"></a><!-- doxytag: member="ushape.h::U_SHAPE_TEXT_DIRECTION_MASK" ref="2a455afff51ba49cbae8ba8fbded1467" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_TEXT_DIRECTION_MASK 4 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bit mask for direction indicators.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001593">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00148">148</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<a class="anchor" name="e379944cf4c71b7d1fc4410dbd7120c6"></a><!-- doxytag: member="ushape.h::U_SHAPE_TEXT_DIRECTION_VISUAL_LTR" ref="e379944cf4c71b7d1fc4410dbd7120c6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_SHAPE_TEXT_DIRECTION_VISUAL_LTR 4 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Direction indicator: the source is in visual LTR order, the leftmost displayed character stored first.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001592">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="ushape_8h-source.html#l00145">145</a> of file <a class="el" href="ushape_8h-source.html">ushape.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="b85f7fe2987a1b2702f455d65013a051"></a><!-- doxytag: member="ushape.h::u_shapeArabic" ref="b85f7fe2987a1b2702f455d65013a051" args="(const UChar *source, int32_t sourceLength, UChar *dest, int32_t destSize, uint32_t options, UErrorCode *pErrorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> u_shapeArabic </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UChar * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>destSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#6dffdaa3be697bee6b7286a8120d3638">uint32_t</a> </td>
<td class="paramname"> <em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> * </td>
<td class="paramname"> <em>pErrorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Shape Arabic text on a character basis.
<p>
This function performs basic operations for "shaping" Arabic text. It is most useful for use with legacy data formats and legacy display technology (simple terminals). All operations are performed on Unicode characters.<p>
Text-based shaping means that some character code points in the text are replaced by others depending on the context. It transforms one kind of text into another. In comparison, modern displays for Arabic text select appropriate, context-dependent font glyphs for each text element, which means that they transform text into a glyph vector.<p>
Text transformations are necessary when modern display technology is not available or when text needs to be transformed to or from legacy formats that use "shaped" characters. Since the Arabic script is cursive, connecting adjacent letters to each other, computers select images for each letter based on the surrounding letters. This usually results in four images per Arabic letter: initial, middle, final, and isolated forms. In Unicode, on the other hand, letters are normally stored abstract, and a display system is expected to select the necessary glyphs. (This makes searching and other text processing easier because the same letter has only one code.) It is possible to mimic this with text transformations because there are characters in Unicode that are rendered as letters with a specific shape (or cursive connectivity). They were included for interoperability with legacy systems and codepages, and for unsophisticated display systems.<p>
A second kind of text transformations is supported for Arabic digits: For compatibility with legacy codepages that only include European digits, it is possible to replace one set of digits by another, changing the character code points. These operations can be performed for either Arabic-Indic Digits (U+0660...U+0669) or Eastern (Extended) Arabic-Indic digits (U+06f0...U+06f9).<p>
Some replacements may result in more or fewer characters (code points). By default, this means that the destination buffer may receive text with a length different from the source length. Some legacy systems rely on the length of the text to be constant. They expect extra spaces to be added or consumed either next to the affected character or at the end of the text.<p>
For details about the available operations, see the description of the <code>U_SHAPE_...</code> options.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The input text.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceLength</em> </td><td>The number of UChars in <code>source</code>.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The destination buffer that will receive the results of the requested operations. It may be <code>NULL</code> only if <code>destSize</code> is 0. The source and destination must not overlap.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>destSize</em> </td><td>The size (capacity) of the destination buffer in UChars. If <code>destSize</code> is 0, then no output is produced, but the necessary buffer size is returned ("preflighting").</td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>This is a 32-bit set of flags that specify the operations that are performed on the input text. If no error occurs, then the result will always be written to the destination buffer.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>pErrorCode</em> </td><td>must be a valid pointer to an error code value, which must not indicate a failure before the function call.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of UChars written to the destination buffer. If an error occured, then no output was written, or it may be incomplete. If <code>U_BUFFER_OVERFLOW_ERROR</code> is set, then the return value indicates the necessary destination buffer size. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001585">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:52 2011 for ICU 3.6 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
