<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Xapian: API Documentation: xapian-core: xapian/unicode.h File Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head> <body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.5.2 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <h1>xapian/unicode.h File Reference</h1>Unicode and UTF-8 related classes and functions. <a href="#_details">More...</a> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Namespaces</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html">Xapian</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html">Xapian::Unicode</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><b>Xapian::Unicode::Internal</b></td></tr> <tr><td colspan="2"><br><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character values from a UTF-8 encoded string. <a href="classXapian_1_1Utf8Iterator.html#_details">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#da747a5a7a514391409b8982fe634703">Xapian::Unicode::category</a> { <br> <b>UNASSIGNED</b>, <b>UPPERCASE_LETTER</b>, <b>LOWERCASE_LETTER</b>, <b>TITLECASE_LETTER</b>, <br> <b>MODIFIER_LETTER</b>, <b>OTHER_LETTER</b>, <b>NON_SPACING_MARK</b>, <b>ENCLOSING_MARK</b>, <br> <b>COMBINING_SPACING_MARK</b>, <b>DECIMAL_DIGIT_NUMBER</b>, <b>LETTER_NUMBER</b>, <b>OTHER_NUMBER</b>, <br> <b>SPACE_SEPARATOR</b>, <b>LINE_SEPARATOR</b>, <b>PARAGRAPH_SEPARATOR</b>, <b>CONTROL</b>, <br> <b>FORMAT</b>, <b>PRIVATE_USE</b>, <b>SURROGATE</b>, <b>CONNECTOR_PUNCTUATION</b>, <br> <b>DASH_PUNCTUATION</b>, <b>OPEN_PUNCTUATION</b>, <b>CLOSE_PUNCTUATION</b>, <b>INITIAL_QUOTE_PUNCTUATION</b>, <br> <b>FINAL_QUOTE_PUNCTUATION</b>, <b>OTHER_PUNCTUATION</b>, <b>MATH_SYMBOL</b>, <b>CURRENCY_SYMBOL</b>, <br> <b>MODIFIER_SYMBOL</b>, <b>OTHER_SYMBOL</b> <br> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Each Unicode character is in exactly one of these categories. <a href="namespaceXapian_1_1Unicode.html#da747a5a7a514391409b8982fe634703">More...</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="anchor" name="a4c4bd67bf345b1e2acba7897322a37a"></a><!-- doxytag: member="unicode.h::get_character_info" ref="a4c4bd67bf345b1e2acba7897322a37a" args="(unsigned ch)" --> int </td><td class="memItemRight" valign="bottom"><b>Xapian::Unicode::Internal::get_character_info</b> (unsigned ch)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e389a4eff7120fabeb9def5bfeb71d0"></a><!-- doxytag: member="unicode.h::get_case_type" ref="7e389a4eff7120fabeb9def5bfeb71d0" args="(int info)" --> int </td><td class="memItemRight" valign="bottom"><b>Xapian::Unicode::Internal::get_case_type</b> (int info)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b0f2cdc47b8125e98061763321786c3"></a><!-- doxytag: member="unicode.h::get_category" ref="1b0f2cdc47b8125e98061763321786c3" args="(int info)" --> category </td><td class="memItemRight" valign="bottom"><b>Xapian::Unicode::Internal::get_category</b> (int info)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bcba9f243c833548a9d0a04577a228b"></a><!-- doxytag: member="unicode.h::get_delta" ref="1bcba9f243c833548a9d0a04577a228b" args="(int info)" --> int </td><td class="memItemRight" valign="bottom"><b>Xapian::Unicode::Internal::get_delta</b> (int info)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#f61a359a559c8ce809d3938ac6c5af06">Xapian::Unicode::nonascii_to_utf8</a> (unsigned ch, char *buf)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a single non-ASCII <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character to UTF-8. <a href="#f61a359a559c8ce809d3938ac6c5af06"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#3dcb2713d7086bad3252c8e9148af02b">Xapian::Unicode::to_utf8</a> (unsigned ch, char *buf)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a single <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character to UTF-8. <a href="#3dcb2713d7086bad3252c8e9148af02b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#2afbd5350189f031de85302cdd7037cf">Xapian::Unicode::append_utf8</a> (std::string &s, unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Append the UTF-8 representation of a single <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character to a std::string. <a href="#2afbd5350189f031de85302cdd7037cf"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">category </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#6bc3072fc94b883a33f514fee1d1e80f">Xapian::Unicode::get_category</a> (unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the category which a given <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character falls into. <a href="#6bc3072fc94b883a33f514fee1d1e80f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#2d750a2783da768811f6812c9a9271a7">Xapian::Unicode::is_wordchar</a> (unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a given <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character is "word character". <a href="#2d750a2783da768811f6812c9a9271a7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#bb8b17adbc3462ed885ddda28283cca1">Xapian::Unicode::is_whitespace</a> (unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a given <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character is a whitespace character. <a href="#bb8b17adbc3462ed885ddda28283cca1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#38353860d79fcb3d5732e983af6105ae">Xapian::Unicode::is_currency</a> (unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a given <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character is a currency symbol. <a href="#38353860d79fcb3d5732e983af6105ae"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#704bae20859bc0121bd8b0bd2d6159b9">Xapian::Unicode::tolower</a> (unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character to lowercase. <a href="#704bae20859bc0121bd8b0bd2d6159b9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#d5e9478d01094c8efd20c439d7495431">Xapian::Unicode::toupper</a> (unsigned ch)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character to uppercase. <a href="#d5e9478d01094c8efd20c439d7495431"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#7ea60af6150df950a59dcb7a362d4478">Xapian::Unicode::tolower</a> (const std::string &term)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-8 std::string to lowercase. <a href="#7ea60af6150df950a59dcb7a362d4478"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#a77704625c95d2b4efc51423ce8ba504">Xapian::Unicode::toupper</a> (const std::string &term)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-8 std::string to uppercase. <a href="#a77704625c95d2b4efc51423ce8ba504"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Unicode and UTF-8 related classes and functions. <p> <hr> <address><small> Documentation for Xapian (version 1.0.21).<br> Generated on 18 Jun 2010 by <a href="http://www.doxygen.org/">Doxygen 1.5.2</a>. </small></address> </body> </html>