<!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>libthai: /builddir/build/BUILD/libthai-0.1.14/libdatrie/datrie/alpha-map.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<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">libthai <span id="projectnumber">0.1.14</span></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="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>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>/builddir/build/BUILD/libthai-0.1.14/libdatrie/datrie/alpha-map.h File Reference</h1> </div>
</div>
<div class="contents">
<p>AlphaMap data type and functions.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab369cb9c893b9f233b97173e0c63d25e"></a><!-- doxytag: member="alpha-map.h::AlphaMap" ref="ab369cb9c893b9f233b97173e0c63d25e" args="" -->
typedef struct _AlphaMap </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">AlphaMap data type. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a3c7d749d7030fd9313852423db6c66e7">alpha_map_new</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new alphabet map. <a href="#a3c7d749d7030fd9313852423db6c66e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#acac189971e2655fa767bc65549e30e1e">alpha_map_clone</a> (const <a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> *a_map)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a clone of alphabet map. <a href="#acac189971e2655fa767bc65549e30e1e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87">alpha_map_free</a> (<a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> *alpha_map)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free an alphabet map object. <a href="#a8fc1275b8136f5195100b6c9c15c9c87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a984d912ebcbc73c9b43d23233138bdcf">alpha_map_add_range</a> (<a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> *alpha_map, <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> begin, <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a range to alphabet map. <a href="#a984d912ebcbc73c9b43d23233138bdcf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a7bc0fcfaffa2c92ebd28b4b2ed4dcf20">alpha_char_strlen</a> (const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alphabet string length. <a href="#a7bc0fcfaffa2c92ebd28b4b2ed4dcf20"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>AlphaMap data type and functions. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7bc0fcfaffa2c92ebd28b4b2ed4dcf20"></a><!-- doxytag: member="alpha-map.h::alpha_char_strlen" ref="a7bc0fcfaffa2c92ebd28b4b2ed4dcf20" args="(const AlphaChar *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int alpha_char_strlen </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alphabet string length. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>: the array of null-terminated AlphaChar string to measure</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the total characters in <em>str</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a984d912ebcbc73c9b43d23233138bdcf"></a><!-- doxytag: member="alpha-map.h::alpha_map_add_range" ref="a984d912ebcbc73c9b43d23233138bdcf" args="(AlphaMap *alpha_map, AlphaChar begin, AlphaChar end)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int alpha_map_add_range </td>
<td>(</td>
<td class="paramtype"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td>
<td class="paramname"><em>alpha_map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a range to alphabet map. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">alpha_map</td><td>: the alphabet map object </td></tr>
<tr><td class="paramname">begin</td><td>: the first character of the range </td></tr>
<tr><td class="paramname">end</td><td>: the last character of the range</td></tr>
</table>
</dd>
</dl>
<p>Add a range of character codes from <em>begin</em> to <em>end</em> to the alphabet set. </p>
</div>
</div>
<a class="anchor" id="acac189971e2655fa767bc65549e30e1e"></a><!-- doxytag: member="alpha-map.h::alpha_map_clone" ref="acac189971e2655fa767bc65549e30e1e" args="(const AlphaMap *a_map)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a>* alpha_map_clone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td>
<td class="paramname"><em>a_map</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a clone of alphabet map. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a_map</td><td>: the source alphabet map to clone</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the alphabet map clone, NULL on failure</dd></dl>
<p>The created object must be freed with <a class="el" href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87" title="Free an alphabet map object.">alpha_map_free()</a>. </p>
</div>
</div>
<a class="anchor" id="a8fc1275b8136f5195100b6c9c15c9c87"></a><!-- doxytag: member="alpha-map.h::alpha_map_free" ref="a8fc1275b8136f5195100b6c9c15c9c87" args="(AlphaMap *alpha_map)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void alpha_map_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td>
<td class="paramname"><em>alpha_map</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free an alphabet map object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">alpha_map</td><td>: the alphabet map object to free</td></tr>
</table>
</dd>
</dl>
<p>Destruct the <em>alpha_map</em> and free its allocated memory. </p>
</div>
</div>
<a class="anchor" id="a3c7d749d7030fd9313852423db6c66e7"></a><!-- doxytag: member="alpha-map.h::alpha_map_new" ref="a3c7d749d7030fd9313852423db6c66e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a>* alpha_map_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new alphabet map. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the newly created alphabet map, NULL on failure</dd></dl>
<p>Create a new empty alphabet map. The map contents can then be added with <a class="el" href="alpha-map_8h.html#a984d912ebcbc73c9b43d23233138bdcf" title="Add a range to alphabet map.">alpha_map_add_range()</a>.</p>
<p>The created object must be freed with <a class="el" href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87" title="Free an alphabet map object.">alpha_map_free()</a>. </p>
</div>
</div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for libthai by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address>
</body>
</html>
