<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::Unicode Namespace 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.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="namespaceXapian_1_1Unicode.html">Unicode</a>
</div>
</div>
<div class="contents">
<h1>Xapian::Unicode Namespace Reference</h1>Functions associated with handling <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> characters.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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#26f1790c2ed8d5bdf92c886ac57a3e75">category</a> </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#26f1790c2ed8d5bdf92c886ac57a3e75">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></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#e10e7195c9c7b854fbd62e6fad433ce7">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="#e10e7195c9c7b854fbd62e6fad433ce7"></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#10a58219f2ed79ddb1ea1d2f3fe8529d">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="#10a58219f2ed79ddb1ea1d2f3fe8529d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c2b6a7eb58789472eb53420d2457168"></a><!-- doxytag: member="Xapian::Unicode::append_utf8" ref="0c2b6a7eb58789472eb53420d2457168" args="(std::string &s, unsigned ch)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#0c2b6a7eb58789472eb53420d2457168">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c72609880fbec74396c588b950e364d8"></a><!-- doxytag: member="Xapian::Unicode::get_category" ref="c72609880fbec74396c588b950e364d8" args="(unsigned ch)" -->
<a class="el" href="namespaceXapian_1_1Unicode.html#26f1790c2ed8d5bdf92c886ac57a3e75">category</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#c72609880fbec74396c588b950e364d8">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63b7b1eb0427b79aa5d21baad3a882f5"></a><!-- doxytag: member="Xapian::Unicode::is_wordchar" ref="63b7b1eb0427b79aa5d21baad3a882f5" args="(unsigned ch)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#63b7b1eb0427b79aa5d21baad3a882f5">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". <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9456f9b7d442107077a26f1ff44f938"></a><!-- doxytag: member="Xapian::Unicode::is_whitespace" ref="d9456f9b7d442107077a26f1ff44f938" args="(unsigned ch)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#d9456f9b7d442107077a26f1ff44f938">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b86de9fd22b27020f12f5ff778feb91"></a><!-- doxytag: member="Xapian::Unicode::is_currency" ref="8b86de9fd22b27020f12f5ff778feb91" args="(unsigned ch)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#8b86de9fd22b27020f12f5ff778feb91">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d21a4489d50179855542c3dce1a2f30"></a><!-- doxytag: member="Xapian::Unicode::tolower" ref="1d21a4489d50179855542c3dce1a2f30" args="(unsigned ch)" -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#1d21a4489d50179855542c3dce1a2f30">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7eceb751850e9a8225260bad5f92df8"></a><!-- doxytag: member="Xapian::Unicode::toupper" ref="a7eceb751850e9a8225260bad5f92df8" args="(unsigned ch)" -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#a7eceb751850e9a8225260bad5f92df8">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f251b26a53a42d396f43669121d11e4"></a><!-- doxytag: member="Xapian::Unicode::tolower" ref="6f251b26a53a42d396f43669121d11e4" args="(const std::string &term)" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#6f251b26a53a42d396f43669121d11e4">tolower</a> (const std::string &term)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-8 std::string to lowercase. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bab2967ed9ef513b4a02bc2c757f3a21"></a><!-- doxytag: member="Xapian::Unicode::toupper" ref="bab2967ed9ef513b4a02bc2c757f3a21" args="(const std::string &term)" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html#bab2967ed9ef513b4a02bc2c757f3a21">toupper</a> (const std::string &term)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-8 std::string to uppercase. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Functions associated with handling <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> characters.
<p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="26f1790c2ed8d5bdf92c886ac57a3e75"></a><!-- doxytag: member="Xapian::Unicode::category" ref="26f1790c2ed8d5bdf92c886ac57a3e75" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceXapian_1_1Unicode.html#26f1790c2ed8d5bdf92c886ac57a3e75">Xapian::Unicode::category</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Each <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character is in exactly one of these categories.
<p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="e10e7195c9c7b854fbd62e6fad433ce7"></a><!-- doxytag: member="Xapian::Unicode::nonascii_to_utf8" ref="e10e7195c9c7b854fbd62e6fad433ce7" args="(unsigned ch, char *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned Xapian::Unicode::nonascii_to_utf8 </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>ch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buf</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<p>
This is intended mainly as a helper method for <a class="el" href="namespaceXapian_1_1Unicode.html#10a58219f2ed79ddb1ea1d2f3fe8529d" title="Convert a single Unicode character to UTF-8.">to_utf8()</a>.<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>ch</em> </td><td>The character (which must be > 128) to write to <em>buf</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The buffer to write the character to - it must have space for (at least) 4 bytes.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the resultant UTF-8 character in bytes. </dd></dl>
<p>Referenced by <a class="el" href="namespaceXapian_1_1Unicode.html#10a58219f2ed79ddb1ea1d2f3fe8529d">to_utf8()</a>.</p>
</div>
</div><p>
<a class="anchor" name="10a58219f2ed79ddb1ea1d2f3fe8529d"></a><!-- doxytag: member="Xapian::Unicode::to_utf8" ref="10a58219f2ed79ddb1ea1d2f3fe8529d" args="(unsigned ch, char *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned Xapian::Unicode::to_utf8 </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>ch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buf</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert a single <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character to UTF-8.
<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>ch</em> </td><td>The character to write to <em>buf</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The buffer to write the character to - it must have space for (at least) 4 bytes.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the resultant UTF-8 character in bytes. </dd></dl>
<p>References <a class="el" href="namespaceXapian_1_1Unicode.html#e10e7195c9c7b854fbd62e6fad433ce7">nonascii_to_utf8()</a>.</p>
<p>Referenced by <a class="el" href="namespaceXapian_1_1Unicode.html#0c2b6a7eb58789472eb53420d2457168">append_utf8()</a>.</p>
</div>
</div><p>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
