| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 |
<meta name="generator" content="Doxygen 1.15.0"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>Xapian: API Documentation: Xapian::Utf8Iterator Class Reference</title> |
| 9 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 |
<script type="text/javascript" src="jquery.js"></script> |
| 11 |
<script type="text/javascript" src="dynsections.js"></script> |
| 12 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 13 |
</head> |
| 14 |
<body> |
| 15 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 16 |
<div id="titlearea"> |
| 17 |
<table cellspacing="0" cellpadding="0"> |
| 18 |
<tbody> |
| 19 |
<tr style="height: 56px;"> |
| 20 |
<td id="projectalign" style="padding-left: 0.5em;"> |
| 21 |
<div id="projectname">xapian-core |
| 22 |
 <span id="projectnumber">1.4.31</span> |
| 23 |
</div> |
| 24 |
</td> |
| 25 |
</tr> |
| 26 |
</tbody> |
| 27 |
</table> |
| 28 |
</div> |
| 29 |
<!-- end header part --> |
| 30 |
<!-- Generated by Doxygen 1.15.0 --> |
| 31 |
<script type="text/javascript"> |
| 32 |
$(function() { codefold.init(); }); |
| 33 |
</script> |
| 34 |
<script type="text/javascript" src="menudata.js"></script> |
| 35 |
<script type="text/javascript" src="menu.js"></script> |
| 36 |
<script type="text/javascript"> |
| 37 |
$(function() { |
| 38 |
initMenu('',false,false,'search.php','Search',false); |
| 39 |
}); |
| 40 |
</script> |
| 41 |
<div id="main-nav"></div> |
| 42 |
<div id="nav-path" class="navpath"> |
| 43 |
<ul> |
| 44 |
<li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a></li> </ul> |
| 45 |
</div> |
| 46 |
</div><!-- top --> |
| 47 |
<div id="doc-content"> |
| 48 |
<div class="header"> |
| 49 |
<div class="summary"> |
| 50 |
<a href="#pub-types">Public Types</a> | |
| 51 |
<a href="#pub-methods">Public Member Functions</a> | |
| 52 |
<a href="classXapian_1_1Utf8Iterator-members.html">List of all members</a> </div> |
| 53 |
<div class="headertitle"><div class="title">Xapian::Utf8Iterator Class Reference</div></div> |
| 54 |
</div><!--header--> |
| 55 |
<div class="contents"> |
| 56 |
|
| 57 |
<p>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. |
| 58 |
<a href="#details">More...</a></p> |
| 59 |
|
| 60 |
<p><code>#include <unicode.h></code></p> |
| 61 |
<table class="memberdecls"> |
| 62 |
<tr class="heading"><td colspan="2"><h2 id="header-pub-types" class="groupheader"><a id="pub-types" name="pub-types"></a> |
| 63 |
Public Types</h2></td></tr> |
| 64 |
<tr class="memitem:a27b2ddc86e0ffa2e5238108af8db86c0" id="r_a27b2ddc86e0ffa2e5238108af8db86c0"><td class="memItemLeft" align="right" valign="top"><a id="a27b2ddc86e0ffa2e5238108af8db86c0" name="a27b2ddc86e0ffa2e5238108af8db86c0"></a> |
| 65 |
typedef std::input_iterator_tag </td><td class="memItemRight" valign="bottom"><b>iterator_category</b></td></tr> |
| 66 |
<tr class="memdesc:a27b2ddc86e0ffa2e5238108af8db86c0"><td class="mdescLeft"> </td><td class="mdescRight">We implement the semantics of an STL input_iterator. <br /></td></tr> |
| 67 |
<tr class="memitem:a86058d0f4d10857af59328157387fd50" id="r_a86058d0f4d10857af59328157387fd50"><td class="memItemLeft" align="right" valign="top"><a id="a86058d0f4d10857af59328157387fd50" name="a86058d0f4d10857af59328157387fd50"></a> |
| 68 |
typedef unsigned </td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr> |
| 69 |
<tr class="memitem:a80a0468ad034f3d6012072a16a3308b2" id="r_a80a0468ad034f3d6012072a16a3308b2"><td class="memItemLeft" align="right" valign="top"><a id="a80a0468ad034f3d6012072a16a3308b2" name="a80a0468ad034f3d6012072a16a3308b2"></a> |
| 70 |
typedef size_t </td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr> |
| 71 |
<tr class="memitem:a78aeb80538fbc18f36be8c93018bd96e" id="r_a78aeb80538fbc18f36be8c93018bd96e"><td class="memItemLeft" align="right" valign="top"><a id="a78aeb80538fbc18f36be8c93018bd96e" name="a78aeb80538fbc18f36be8c93018bd96e"></a> |
| 72 |
typedef value_type * </td><td class="memItemRight" valign="bottom"><b>pointer</b></td></tr> |
| 73 |
<tr class="memitem:a7187020da51e024726d01b31addae4e1" id="r_a7187020da51e024726d01b31addae4e1"><td class="memItemLeft" align="right" valign="top"><a id="a7187020da51e024726d01b31addae4e1" name="a7187020da51e024726d01b31addae4e1"></a> |
| 74 |
typedef value_type </td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr> |
| 75 |
</table><table class="memberdecls"> |
| 76 |
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| 77 |
Public Member Functions</h2></td></tr> |
| 78 |
<tr class="memitem:ac56748bafb61310e7f82b807fa29bc46" id="r_ac56748bafb61310e7f82b807fa29bc46"><td class="memItemLeft" align="right" valign="top"><a id="ac56748bafb61310e7f82b807fa29bc46" name="ac56748bafb61310e7f82b807fa29bc46"></a> |
| 79 |
const char * </td><td class="memItemRight" valign="bottom"><b>raw</b> () const</td></tr> |
| 80 |
<tr class="memdesc:ac56748bafb61310e7f82b807fa29bc46"><td class="mdescLeft"> </td><td class="mdescRight">Return the raw const char* pointer for the current position. <br /></td></tr> |
| 81 |
<tr class="memitem:a2804f5b8c28a027b265f37b275a083d9" id="r_a2804f5b8c28a027b265f37b275a083d9"><td class="memItemLeft" align="right" valign="top"><a id="a2804f5b8c28a027b265f37b275a083d9" name="a2804f5b8c28a027b265f37b275a083d9"></a> |
| 82 |
size_t </td><td class="memItemRight" valign="bottom"><b>left</b> () const</td></tr> |
| 83 |
<tr class="memdesc:a2804f5b8c28a027b265f37b275a083d9"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bytes left in the iterator's buffer. <br /></td></tr> |
| 84 |
<tr class="memitem:a29608f4bbfdae0e6da41ed9f7879c410" id="r_a29608f4bbfdae0e6da41ed9f7879c410"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a29608f4bbfdae0e6da41ed9f7879c410">assign</a> (const char *p_, size_t len)</td></tr> |
| 85 |
<tr class="memdesc:a29608f4bbfdae0e6da41ed9f7879c410"><td class="mdescLeft"> </td><td class="mdescRight">Assign a new string to the iterator. <br /></td></tr> |
| 86 |
<tr class="memitem:a5e9337753766c9a3a0202e86a0016293" id="r_a5e9337753766c9a3a0202e86a0016293"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e9337753766c9a3a0202e86a0016293">assign</a> (const std::string &s)</td></tr> |
| 87 |
<tr class="memdesc:a5e9337753766c9a3a0202e86a0016293"><td class="mdescLeft"> </td><td class="mdescRight">Assign a new string to the iterator. <br /></td></tr> |
| 88 |
<tr class="memitem:a2bde57da5096615033f2d4e36043ce26" id="r_a2bde57da5096615033f2d4e36043ce26"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bde57da5096615033f2d4e36043ce26">Utf8Iterator</a> (const char *p_)</td></tr> |
| 89 |
<tr class="memdesc:a2bde57da5096615033f2d4e36043ce26"><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator given a pointer to a null terminated string. <br /></td></tr> |
| 90 |
<tr class="memitem:a686c7e0883132abe1992904c89d2a51c" id="r_a686c7e0883132abe1992904c89d2a51c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a686c7e0883132abe1992904c89d2a51c">Utf8Iterator</a> (const char *p_, size_t len)</td></tr> |
| 91 |
<tr class="memdesc:a686c7e0883132abe1992904c89d2a51c"><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator given a pointer and a length. <br /></td></tr> |
| 92 |
<tr class="memitem:a18743b895d83019d549b7c032499465f" id="r_a18743b895d83019d549b7c032499465f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a18743b895d83019d549b7c032499465f">Utf8Iterator</a> (const std::string &s)</td></tr> |
| 93 |
<tr class="memdesc:a18743b895d83019d549b7c032499465f"><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator given a string. <br /></td></tr> |
| 94 |
<tr class="memitem:ad02aaed2afa0cf3d41878590faf1175e" id="r_ad02aaed2afa0cf3d41878590faf1175e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad02aaed2afa0cf3d41878590faf1175e">Utf8Iterator</a> ()</td></tr> |
| 95 |
<tr class="memdesc:ad02aaed2afa0cf3d41878590faf1175e"><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator which is at the end of its iteration. <br /></td></tr> |
| 96 |
<tr class="memitem:a498672c0551619110eadd15b029ae326" id="r_a498672c0551619110eadd15b029ae326"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#a498672c0551619110eadd15b029ae326">operator*</a> () const</td></tr> |
| 97 |
<tr class="memdesc:a498672c0551619110eadd15b029ae326"><td class="mdescLeft"> </td><td class="mdescRight">Get the current <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character value pointed to by the iterator. <br /></td></tr> |
| 98 |
<tr class="memitem:a25aaaef59d9e273af9a4372c2e1e7e65" id="r_a25aaaef59d9e273af9a4372c2e1e7e65"><td class="memItemLeft" align="right" valign="top">Utf8Iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="#a25aaaef59d9e273af9a4372c2e1e7e65">operator++</a> (int)</td></tr> |
| 99 |
<tr class="memdesc:a25aaaef59d9e273af9a4372c2e1e7e65"><td class="mdescLeft"> </td><td class="mdescRight">Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character. <br /></td></tr> |
| 100 |
<tr class="memitem:a7e4a34881638a2f9b6861834c10787a0" id="r_a7e4a34881638a2f9b6861834c10787a0"><td class="memItemLeft" align="right" valign="top">Utf8Iterator & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e4a34881638a2f9b6861834c10787a0">operator++</a> ()</td></tr> |
| 101 |
<tr class="memdesc:a7e4a34881638a2f9b6861834c10787a0"><td class="mdescLeft"> </td><td class="mdescRight">Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character. <br /></td></tr> |
| 102 |
<tr class="memitem:abeb283a7436f0a41e6c676cd3e2161c6" id="r_abeb283a7436f0a41e6c676cd3e2161c6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#abeb283a7436f0a41e6c676cd3e2161c6">operator==</a> (const Utf8Iterator &other) const</td></tr> |
| 103 |
<tr class="memdesc:abeb283a7436f0a41e6c676cd3e2161c6"><td class="mdescLeft"> </td><td class="mdescRight">Test two Utf8Iterators for equality. <br /></td></tr> |
| 104 |
<tr class="memitem:a1dbf1ced82a216ccec247cecb9f3227e" id="r_a1dbf1ced82a216ccec247cecb9f3227e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1dbf1ced82a216ccec247cecb9f3227e">operator!=</a> (const Utf8Iterator &other) const</td></tr> |
| 105 |
<tr class="memdesc:a1dbf1ced82a216ccec247cecb9f3227e"><td class="mdescLeft"> </td><td class="mdescRight">Test two Utf8Iterators for inequality. <br /></td></tr> |
| 106 |
</table> |
| 107 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 108 |
<div class="textblock"><p>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. </p> |
| 109 |
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor & Destructor Documentation</h2> |
| 110 |
<a id="a2bde57da5096615033f2d4e36043ce26" name="a2bde57da5096615033f2d4e36043ce26"></a> |
| 111 |
<h2 class="memtitle"><span class="permalink"><a href="#a2bde57da5096615033f2d4e36043ce26">◆ </a></span>Utf8Iterator() <span class="overload">[1/4]</span></h2> |
| 112 |
|
| 113 |
<div class="memitem"> |
| 114 |
<div class="memproto"> |
| 115 |
<table class="mlabels"> |
| 116 |
<tr> |
| 117 |
<td class="mlabels-left"> |
| 118 |
<table class="memname"> |
| 119 |
<tr> |
| 120 |
<td class="memname">Xapian::Utf8Iterator::Utf8Iterator </td> |
| 121 |
<td>(</td> |
| 122 |
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>p_</em></span></td><td>)</td> |
| 123 |
<td></td> |
| 124 |
</tr> |
| 125 |
</table> |
| 126 |
</td> |
| 127 |
<td class="mlabels-right"> |
| 128 |
<span class="mlabels"><span class="mlabel explicit">explicit</span></span> </td> |
| 129 |
</tr> |
| 130 |
</table> |
| 131 |
</div><div class="memdoc"> |
| 132 |
|
| 133 |
<p>Create an iterator given a pointer to a null terminated string. </p> |
| 134 |
<p>The iterator will return characters from the start of the string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.</p> |
| 135 |
<dl class="params"><dt>Parameters</dt><dd> |
| 136 |
<table class="params"> |
| 137 |
<tr><td class="paramname">p_</td><td>A pointer to the start of the null terminated string to read. </td></tr> |
| 138 |
</table> |
| 139 |
</dd> |
| 140 |
</dl> |
| 141 |
|
| 142 |
</div> |
| 143 |
</div> |
| 144 |
<a id="a686c7e0883132abe1992904c89d2a51c" name="a686c7e0883132abe1992904c89d2a51c"></a> |
| 145 |
<h2 class="memtitle"><span class="permalink"><a href="#a686c7e0883132abe1992904c89d2a51c">◆ </a></span>Utf8Iterator() <span class="overload">[2/4]</span></h2> |
| 146 |
|
| 147 |
<div class="memitem"> |
| 148 |
<div class="memproto"> |
| 149 |
<table class="mlabels"> |
| 150 |
<tr> |
| 151 |
<td class="mlabels-left"> |
| 152 |
<table class="memname"> |
| 153 |
<tr> |
| 154 |
<td class="memname">Xapian::Utf8Iterator::Utf8Iterator </td> |
| 155 |
<td>(</td> |
| 156 |
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>p_</em></span>, </td> |
| 157 |
</tr> |
| 158 |
<tr> |
| 159 |
<td class="paramkey"></td> |
| 160 |
<td></td> |
| 161 |
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td> |
| 162 |
</tr> |
| 163 |
</table> |
| 164 |
</td> |
| 165 |
<td class="mlabels-right"> |
| 166 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 167 |
</tr> |
| 168 |
</table> |
| 169 |
</div><div class="memdoc"> |
| 170 |
|
| 171 |
<p>Create an iterator given a pointer and a length. </p> |
| 172 |
<p>The iterator will return characters from the start of the string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.</p> |
| 173 |
<dl class="params"><dt>Parameters</dt><dd> |
| 174 |
<table class="params"> |
| 175 |
<tr><td class="paramname">p_</td><td>A pointer to the start of the string to read.</td></tr> |
| 176 |
<tr><td class="paramname">len</td><td>The length of the string to read. </td></tr> |
| 177 |
</table> |
| 178 |
</dd> |
| 179 |
</dl> |
| 180 |
|
| 181 |
<p class="reference">References <a class="el" href="#a29608f4bbfdae0e6da41ed9f7879c410">assign()</a>.</p> |
| 182 |
|
| 183 |
</div> |
| 184 |
</div> |
| 185 |
<a id="a18743b895d83019d549b7c032499465f" name="a18743b895d83019d549b7c032499465f"></a> |
| 186 |
<h2 class="memtitle"><span class="permalink"><a href="#a18743b895d83019d549b7c032499465f">◆ </a></span>Utf8Iterator() <span class="overload">[3/4]</span></h2> |
| 187 |
|
| 188 |
<div class="memitem"> |
| 189 |
<div class="memproto"> |
| 190 |
<table class="mlabels"> |
| 191 |
<tr> |
| 192 |
<td class="mlabels-left"> |
| 193 |
<table class="memname"> |
| 194 |
<tr> |
| 195 |
<td class="memname">Xapian::Utf8Iterator::Utf8Iterator </td> |
| 196 |
<td>(</td> |
| 197 |
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td> |
| 198 |
<td></td> |
| 199 |
</tr> |
| 200 |
</table> |
| 201 |
</td> |
| 202 |
<td class="mlabels-right"> |
| 203 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 204 |
</tr> |
| 205 |
</table> |
| 206 |
</div><div class="memdoc"> |
| 207 |
|
| 208 |
<p>Create an iterator given a string. </p> |
| 209 |
<p>The iterator will return characters from the start of the string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.</p> |
| 210 |
<dl class="params"><dt>Parameters</dt><dd> |
| 211 |
<table class="params"> |
| 212 |
<tr><td class="paramname">s</td><td>The string to read. Must not be modified while the iteration is in progress. </td></tr> |
| 213 |
</table> |
| 214 |
</dd> |
| 215 |
</dl> |
| 216 |
|
| 217 |
<p class="reference">References <a class="el" href="#a29608f4bbfdae0e6da41ed9f7879c410">assign()</a>.</p> |
| 218 |
|
| 219 |
</div> |
| 220 |
</div> |
| 221 |
<a id="ad02aaed2afa0cf3d41878590faf1175e" name="ad02aaed2afa0cf3d41878590faf1175e"></a> |
| 222 |
<h2 class="memtitle"><span class="permalink"><a href="#ad02aaed2afa0cf3d41878590faf1175e">◆ </a></span>Utf8Iterator() <span class="overload">[4/4]</span></h2> |
| 223 |
|
| 224 |
<div class="memitem"> |
| 225 |
<div class="memproto"> |
| 226 |
<table class="mlabels"> |
| 227 |
<tr> |
| 228 |
<td class="mlabels-left"> |
| 229 |
<table class="memname"> |
| 230 |
<tr> |
| 231 |
<td class="memname">Xapian::Utf8Iterator::Utf8Iterator </td> |
| 232 |
<td>(</td> |
| 233 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 234 |
<td></td> |
| 235 |
</tr> |
| 236 |
</table> |
| 237 |
</td> |
| 238 |
<td class="mlabels-right"> |
| 239 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 240 |
</tr> |
| 241 |
</table> |
| 242 |
</div><div class="memdoc"> |
| 243 |
|
| 244 |
<p>Create an iterator which is at the end of its iteration. </p> |
| 245 |
<p>This can be compared to another iterator to check if the other iterator has reached its end. </p> |
| 246 |
|
| 247 |
</div> |
| 248 |
</div> |
| 249 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2> |
| 250 |
<a id="a29608f4bbfdae0e6da41ed9f7879c410" name="a29608f4bbfdae0e6da41ed9f7879c410"></a> |
| 251 |
<h2 class="memtitle"><span class="permalink"><a href="#a29608f4bbfdae0e6da41ed9f7879c410">◆ </a></span>assign() <span class="overload">[1/2]</span></h2> |
| 252 |
|
| 253 |
<div class="memitem"> |
| 254 |
<div class="memproto"> |
| 255 |
<table class="mlabels"> |
| 256 |
<tr> |
| 257 |
<td class="mlabels-left"> |
| 258 |
<table class="memname"> |
| 259 |
<tr> |
| 260 |
<td class="memname">void Xapian::Utf8Iterator::assign </td> |
| 261 |
<td>(</td> |
| 262 |
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>p_</em></span>, </td> |
| 263 |
</tr> |
| 264 |
<tr> |
| 265 |
<td class="paramkey"></td> |
| 266 |
<td></td> |
| 267 |
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>len</em></span> )</td> |
| 268 |
</tr> |
| 269 |
</table> |
| 270 |
</td> |
| 271 |
<td class="mlabels-right"> |
| 272 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 273 |
</tr> |
| 274 |
</table> |
| 275 |
</div><div class="memdoc"> |
| 276 |
|
| 277 |
<p>Assign a new string to the iterator. </p> |
| 278 |
<p>The iterator will forget the string it was iterating through, and return characters from the start of the new string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.</p> |
| 279 |
<dl class="params"><dt>Parameters</dt><dd> |
| 280 |
<table class="params"> |
| 281 |
<tr><td class="paramname">p_</td><td>A pointer to the start of the string to read.</td></tr> |
| 282 |
<tr><td class="paramname">len</td><td>The length of the string to read. </td></tr> |
| 283 |
</table> |
| 284 |
</dd> |
| 285 |
</dl> |
| 286 |
|
| 287 |
<p class="reference">Referenced by <a class="el" href="#a686c7e0883132abe1992904c89d2a51c">Utf8Iterator()</a>, and <a class="el" href="#a18743b895d83019d549b7c032499465f">Utf8Iterator()</a>.</p> |
| 288 |
|
| 289 |
</div> |
| 290 |
</div> |
| 291 |
<a id="a5e9337753766c9a3a0202e86a0016293" name="a5e9337753766c9a3a0202e86a0016293"></a> |
| 292 |
<h2 class="memtitle"><span class="permalink"><a href="#a5e9337753766c9a3a0202e86a0016293">◆ </a></span>assign() <span class="overload">[2/2]</span></h2> |
| 293 |
|
| 294 |
<div class="memitem"> |
| 295 |
<div class="memproto"> |
| 296 |
<table class="mlabels"> |
| 297 |
<tr> |
| 298 |
<td class="mlabels-left"> |
| 299 |
<table class="memname"> |
| 300 |
<tr> |
| 301 |
<td class="memname">void Xapian::Utf8Iterator::assign </td> |
| 302 |
<td>(</td> |
| 303 |
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td> |
| 304 |
<td></td> |
| 305 |
</tr> |
| 306 |
</table> |
| 307 |
</td> |
| 308 |
<td class="mlabels-right"> |
| 309 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 310 |
</tr> |
| 311 |
</table> |
| 312 |
</div><div class="memdoc"> |
| 313 |
|
| 314 |
<p>Assign a new string to the iterator. </p> |
| 315 |
<p>The iterator will forget the string it was iterating through, and return characters from the start of the new string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.</p> |
| 316 |
<dl class="params"><dt>Parameters</dt><dd> |
| 317 |
<table class="params"> |
| 318 |
<tr><td class="paramname">s</td><td>The string to read. Must not be modified while the iteration is in progress. </td></tr> |
| 319 |
</table> |
| 320 |
</dd> |
| 321 |
</dl> |
| 322 |
|
| 323 |
<p class="reference">References <a class="el" href="#a5e9337753766c9a3a0202e86a0016293">assign()</a>.</p> |
| 324 |
|
| 325 |
<p class="reference">Referenced by <a class="el" href="#a5e9337753766c9a3a0202e86a0016293">assign()</a>.</p> |
| 326 |
|
| 327 |
</div> |
| 328 |
</div> |
| 329 |
<a id="a1dbf1ced82a216ccec247cecb9f3227e" name="a1dbf1ced82a216ccec247cecb9f3227e"></a> |
| 330 |
<h2 class="memtitle"><span class="permalink"><a href="#a1dbf1ced82a216ccec247cecb9f3227e">◆ </a></span>operator!=()</h2> |
| 331 |
|
| 332 |
<div class="memitem"> |
| 333 |
<div class="memproto"> |
| 334 |
<table class="mlabels"> |
| 335 |
<tr> |
| 336 |
<td class="mlabels-left"> |
| 337 |
<table class="memname"> |
| 338 |
<tr> |
| 339 |
<td class="memname">bool Xapian::Utf8Iterator::operator!= </td> |
| 340 |
<td>(</td> |
| 341 |
<td class="paramtype">const Utf8Iterator &</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td> |
| 342 |
<td> const</td> |
| 343 |
</tr> |
| 344 |
</table> |
| 345 |
</td> |
| 346 |
<td class="mlabels-right"> |
| 347 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 348 |
</tr> |
| 349 |
</table> |
| 350 |
</div><div class="memdoc"> |
| 351 |
|
| 352 |
<p>Test two Utf8Iterators for inequality. </p> |
| 353 |
<dl class="params"><dt>Parameters</dt><dd> |
| 354 |
<table class="params"> |
| 355 |
<tr><td class="paramname">other</td><td>The <a class="el" href="classXapian_1_1Utf8Iterator.html" title="An iterator which returns Unicode character values from a UTF-8 encoded string.">Utf8Iterator</a> to compare this one with. </td></tr> |
| 356 |
</table> |
| 357 |
</dd> |
| 358 |
</dl> |
| 359 |
<dl class="section return"><dt>Returns</dt><dd>true iff the iterators do not point to the same position. </dd></dl> |
| 360 |
|
| 361 |
</div> |
| 362 |
</div> |
| 363 |
<a id="a498672c0551619110eadd15b029ae326" name="a498672c0551619110eadd15b029ae326"></a> |
| 364 |
<h2 class="memtitle"><span class="permalink"><a href="#a498672c0551619110eadd15b029ae326">◆ </a></span>operator*()</h2> |
| 365 |
|
| 366 |
<div class="memitem"> |
| 367 |
<div class="memproto"> |
| 368 |
<table class="memname"> |
| 369 |
<tr> |
| 370 |
<td class="memname">unsigned Xapian::Utf8Iterator::operator* </td> |
| 371 |
<td>(</td> |
| 372 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 373 |
<td> const</td> |
| 374 |
</tr> |
| 375 |
</table> |
| 376 |
</div><div class="memdoc"> |
| 377 |
|
| 378 |
<p>Get the current <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character value pointed to by the iterator. </p> |
| 379 |
<p>If an invalid UTF-8 sequence is encountered, then the byte values comprising it are returned until valid UTF-8 or the end of the input is reached.</p> |
| 380 |
<p>Returns unsigned(-1) if the iterator has reached the end of its buffer. </p> |
| 381 |
|
| 382 |
</div> |
| 383 |
</div> |
| 384 |
<a id="a7e4a34881638a2f9b6861834c10787a0" name="a7e4a34881638a2f9b6861834c10787a0"></a> |
| 385 |
<h2 class="memtitle"><span class="permalink"><a href="#a7e4a34881638a2f9b6861834c10787a0">◆ </a></span>operator++() <span class="overload">[1/2]</span></h2> |
| 386 |
|
| 387 |
<div class="memitem"> |
| 388 |
<div class="memproto"> |
| 389 |
<table class="mlabels"> |
| 390 |
<tr> |
| 391 |
<td class="mlabels-left"> |
| 392 |
<table class="memname"> |
| 393 |
<tr> |
| 394 |
<td class="memname">Utf8Iterator & Xapian::Utf8Iterator::operator++ </td> |
| 395 |
<td>(</td> |
| 396 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 397 |
<td></td> |
| 398 |
</tr> |
| 399 |
</table> |
| 400 |
</td> |
| 401 |
<td class="mlabels-right"> |
| 402 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 403 |
</tr> |
| 404 |
</table> |
| 405 |
</div><div class="memdoc"> |
| 406 |
|
| 407 |
<p>Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character. </p> |
| 408 |
<dl class="section return"><dt>Returns</dt><dd>A reference to this object. </dd></dl> |
| 409 |
|
| 410 |
</div> |
| 411 |
</div> |
| 412 |
<a id="a25aaaef59d9e273af9a4372c2e1e7e65" name="a25aaaef59d9e273af9a4372c2e1e7e65"></a> |
| 413 |
<h2 class="memtitle"><span class="permalink"><a href="#a25aaaef59d9e273af9a4372c2e1e7e65">◆ </a></span>operator++() <span class="overload">[2/2]</span></h2> |
| 414 |
|
| 415 |
<div class="memitem"> |
| 416 |
<div class="memproto"> |
| 417 |
<table class="mlabels"> |
| 418 |
<tr> |
| 419 |
<td class="mlabels-left"> |
| 420 |
<table class="memname"> |
| 421 |
<tr> |
| 422 |
<td class="memname">Utf8Iterator Xapian::Utf8Iterator::operator++ </td> |
| 423 |
<td>(</td> |
| 424 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 425 |
<td></td> |
| 426 |
</tr> |
| 427 |
</table> |
| 428 |
</td> |
| 429 |
<td class="mlabels-right"> |
| 430 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 431 |
</tr> |
| 432 |
</table> |
| 433 |
</div><div class="memdoc"> |
| 434 |
|
| 435 |
<p>Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character. </p> |
| 436 |
<dl class="section return"><dt>Returns</dt><dd>An iterator pointing to the position before the move. </dd></dl> |
| 437 |
|
| 438 |
</div> |
| 439 |
</div> |
| 440 |
<a id="abeb283a7436f0a41e6c676cd3e2161c6" name="abeb283a7436f0a41e6c676cd3e2161c6"></a> |
| 441 |
<h2 class="memtitle"><span class="permalink"><a href="#abeb283a7436f0a41e6c676cd3e2161c6">◆ </a></span>operator==()</h2> |
| 442 |
|
| 443 |
<div class="memitem"> |
| 444 |
<div class="memproto"> |
| 445 |
<table class="mlabels"> |
| 446 |
<tr> |
| 447 |
<td class="mlabels-left"> |
| 448 |
<table class="memname"> |
| 449 |
<tr> |
| 450 |
<td class="memname">bool Xapian::Utf8Iterator::operator== </td> |
| 451 |
<td>(</td> |
| 452 |
<td class="paramtype">const Utf8Iterator &</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td> |
| 453 |
<td> const</td> |
| 454 |
</tr> |
| 455 |
</table> |
| 456 |
</td> |
| 457 |
<td class="mlabels-right"> |
| 458 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 459 |
</tr> |
| 460 |
</table> |
| 461 |
</div><div class="memdoc"> |
| 462 |
|
| 463 |
<p>Test two Utf8Iterators for equality. </p> |
| 464 |
<dl class="params"><dt>Parameters</dt><dd> |
| 465 |
<table class="params"> |
| 466 |
<tr><td class="paramname">other</td><td>The <a class="el" href="classXapian_1_1Utf8Iterator.html" title="An iterator which returns Unicode character values from a UTF-8 encoded string.">Utf8Iterator</a> to compare this one with. </td></tr> |
| 467 |
</table> |
| 468 |
</dd> |
| 469 |
</dl> |
| 470 |
<dl class="section return"><dt>Returns</dt><dd>true iff the iterators point to the same position. </dd></dl> |
| 471 |
|
| 472 |
</div> |
| 473 |
</div> |
| 474 |
<hr/>The documentation for this class was generated from the following file:<ul> |
| 475 |
<li>xapian/<a class="el" href="unicode_8h.html">unicode.h</a></li> |
| 476 |
</ul> |
| 477 |
</div><!-- contents --> |
| 478 |
<!-- start footer part --> |
| 479 |
<hr class="footer"/><address class="footer"><small> |
| 480 |
Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a> |
| 481 |
</small></address> |
| 482 |
</body> |
| 483 |
</html> |