<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>c++-gtk-utils: convert.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">c++-gtk-utils
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</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>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_101f02d72531e1268e20029abbed11e1.html">c++-gtk-utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">convert.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="convert_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Copyright (C) 2005 to 2013 Chris Vine</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">The library comprised in this file or of which this file is part is</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">distributed by Chris Vine under the GNU Lesser General Public</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">License as follows:</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1 of</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> Lesser General Public License, version 2.1, for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> License, version 2.1, along with this library (see the file LGPL.TXT</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> which came with this source code package in the src/utils sub-directory);</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">However, it is not intended that the object code of a program whose</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">source code instantiates a template from this file or uses macros or</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">inline functions (of any length) should by reason only of that</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">instantiation or use be subject to the restrictions of use in the GNU</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">Lesser General Public License. With that in mind, the words "and</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">macros, inline functions and instantiations of templates (of any</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">length)" shall be treated as substituted for the words "and small</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">macros and small inline functions (ten lines or less in length)" in</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">the fourth paragraph of section 5 of that licence. This does not</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">affect any other reason why object code may be subject to the</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">restrictions in that licence (nor for the avoidance of doubt does it</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">affect the application of section 2 of that licence to modifications</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">of the source code in this file).</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef CGU_CONVERT_H</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define CGU_CONVERT_H</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include <iterator></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include <exception></span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include <glib.h></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include <<a class="code" href="shared__handle_8h.html">c++-gtk-utils/shared_handle.h</a>></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include <<a class="code" href="cgu__config_8h.html">c++-gtk-utils/cgu_config.h</a>></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">namespace </span>Cgu {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @file convert.h</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @brief This file contains functions for converting between</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * character sets.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * \#include <c++-gtk-utils/convert.h></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * This file contains functions for converting between character sets.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * If you want these functions to work, you will generally have needed</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * to have set the locale in the relevant program with either</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * <em>std::locale::global(std::locale(""))</em> (from the C++</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * standard library) or <em>setlocale(LC_ALL,"")</em> (from the C</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * standard library).</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @namespace Cgu::Utf8</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @brief This namespace contains utilities relevant to the use of</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * UTF-8 in programs.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * \#include <c++-gtk-utils/convert.h> (for conversion and validation</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * functions)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * \#include <c++-gtk-utils/reassembler.h> (for Reassembler class)</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @sa convert.h reassembler.h</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * This namespace contains utilities relevant to the use of UTF-8 in</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * programs. If you want these functions to work, you will generally</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * have needed to have set the locale in the relevant program with</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * either <em>std::locale::global(std::locale(""))</em> (from the C++</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * standard library) or <em>setlocale(LC_ALL,"")</em> (from the C standard</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * library).</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">namespace </span>Utf8 {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html"> 89</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html">ConversionError</a>: <span class="keyword">public</span> std::exception {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classCgu_1_1SharedHandle.html">GcharSharedHandle</a> message;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#a0202558c2a70a18a924bf64f89207406"> 92</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#a0202558c2a70a18a924bf64f89207406">what</a>() <span class="keyword">const</span> throw() {<span class="keywordflow">return</span> (<span class="keyword">const</span> <span class="keywordtype">char</span>*)message.<a class="code" href="classCgu_1_1SharedHandle.html#ae77be2719195188101e976729f2a05e3">get</a>();}</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#a12a7e05bd0efceb27781b61b8904db5a"> 93</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#a12a7e05bd0efceb27781b61b8904db5a">ConversionError</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg):</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  message(g_strdup_printf(<span class="stringliteral">"Utf8::ConversionError: %s"</span>, msg)) {}</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#ae09100dd8e1403f469e2b8a70af1ce2f"> 95</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#ae09100dd8e1403f469e2b8a70af1ce2f">ConversionError</a>(GError* error):</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  message(g_strdup_printf(<span class="stringliteral">"Utf8::ConversionError: %s"</span>, error->message)) {}</div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#aa1f09b15f5a12f64c316da33d02238ef"> 97</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ConversionError.html#aa1f09b15f5a12f64c316da33d02238ef">~ConversionError</a>() throw() {}</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> };</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * Converts text from UTF-8 to the system's Unicode wide character</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * representation, which will be UTF-32/UCS-4 for systems with a wide</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * character size of 4 (almost all unix-like systems), and UTF-16 for</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * systems with a wide character size of 2.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param input Text in valid UTF-8 format.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @return The input text converted to UTF-32 or UTF-16.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-8</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * format or the system does not support wide character Unicode</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * strings.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> std::wstring <a class="code" href="namespaceCgu_1_1Utf8.html#aed9fb2b2c808c3fcc0ced702c0a839f9">uniwide_from_utf8</a>(<span class="keyword">const</span> std::string& input);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * Converts text from the system's Unicode wide character</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * representation, which will be UTF-32/UCS-4 for systems with a wide</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * character size of 4 (almost all unix-like systems) and UTF-16 for</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * systems with a wide character size of 2, to narrow character UTF-8</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * format.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @param input Text in valid UTF-32 or UTF-16 format.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @return The input text converted to UTF-8.</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * if conversion fails because the input string is not in valid</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * UTF-32/UCS-4 or UTF-16 format or the system does not support wide</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * character Unicode strings.</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#aa43759d9eb1b4286ce121b23a85b6652">uniwide_to_utf8</a>(<span class="keyword">const</span> std::wstring& input);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"></span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * Converts text from UTF-8 to UTF-32/USC-4.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @param input Text in valid UTF-8 format.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @return The input text converted to UTF-32.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-8</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * format or the system does not support wide character Unicode</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * strings.</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> std::u32string <a class="code" href="namespaceCgu_1_1Utf8.html#a4cebe424a6695e5815b8eff2f4846a46">utf32_from_utf8</a>(<span class="keyword">const</span> std::string& input);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * Converts text from UTF-32/UCS4 to narrow character UTF-8 format.</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @param input Text in valid UTF-32 format.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @return The input text converted to UTF-8.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * if conversion fails because the input string is not in valid</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * UTF-32/UCS-4 format or the system does not support wide character</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * Unicode strings.</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#ab2d43b8c674af67da49e8a165a11d8bd">utf32_to_utf8</a>(<span class="keyword">const</span> std::u32string& input);</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"></span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * Converts text from UTF-8 to UTF-16.</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * @param input Text in valid UTF-8 format.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @return The input text converted to UTF-16.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-8</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * format or the system does not support wide character Unicode</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * strings.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> std::u16string <a class="code" href="namespaceCgu_1_1Utf8.html#adc00f8ea668cb735411f9703e5cae7d9">utf16_from_utf8</a>(<span class="keyword">const</span> std::string& input);</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * Converts text from UFF-16 to narrow character UTF-8 format.</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @param input Text in valid UTF-16 format.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @return The input text converted to UTF-8.</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-16</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * format or the system does not support wide character Unicode</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * strings.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#aca9e3f963dfb0b3b895ff3e3db7300d5">utf16_to_utf8</a>(<span class="keyword">const</span> std::u16string& input);</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"></span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * Converts text from UTF-8 to the system's wide character locale</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * representation. For this function to work correctly, the system's</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * installed iconv() must support conversion to a generic wchar_t</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * target, but in POSIX whether it does so is implementation defined</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * (GNU's C library implemention does). For most unix-like systems</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * the wide character representation will be Unicode (UCS-4/UTF-32 or</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * UTF-16), and where that is the case use the uniwide_from_utf8()</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * function instead, which will not rely on the generic target being</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * available.</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @param input Text in valid UTF-8 format.</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @return The input text converted to the system's wide character</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * locale representation.</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-8</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * format, or cannot be converted to the system's wide character</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * locale representation (eg because the input characters cannot be</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * represented by that encoding, or the system's installed iconv()</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * function does not support conversion to a generic wchar_t target).</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> std::wstring <a class="code" href="namespaceCgu_1_1Utf8.html#ac5262583864d9f4b1281980318a0f678">wide_from_utf8</a>(<span class="keyword">const</span> std::string& input);</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"></span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * Converts text from the system's wide character locale</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * representation to UTF-8. For this function to work correctly, the</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * system's installed iconv() must support conversion from a generic</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * wchar_t target, but in POSIX whether it does so is implementation</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * defined (GNU's C library implemention does). For most unix-like</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * systems the wide character representation will be Unicode</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * (UCS-4/UTF-32 or UTF-16), and where that is the case use the</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * uniwide_to_utf8() function instead, which will not rely on the</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * generic target being available.</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * @param input Text in a valid wide character locale format.</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @return The input text converted to UTF-8.</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * if conversion fails because the input string is not in a valid wide</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * character locale format, or cannot be converted to UTF-8 (eg</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * because the system's installed iconv() function does not support</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * conversion from a generic wchar_t target).</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#aaf7bd04eac5268ae1272fcb72939549a">wide_to_utf8</a>(<span class="keyword">const</span> std::wstring& input);</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"></span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * Converts text from UTF-8 to the system's filename encoding.</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @param input Text in valid UTF-8 format.</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * @return The input text converted to filename encoding.</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-8</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * format, or cannot be converted to filename encoding (eg because the</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * input characters cannot be represented by that encoding).</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @note glib takes the system's filename encoding from the</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * environmental variables G_FILENAME_ENCODING and G_BROKEN_FILENAMES.</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * If G_BROKEN_FILENAMES is set to 1 and G_FILENAME_ENCODING is not</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * set, it will be assumed that the filename encoding is the same as</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * the locale encoding. If G_FILENAME_ENCODING is set, then</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * G_BROKEN_FILENAMES is ignored, and filename encoding is taken from</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * the value held by G_FILENAME_ENCODING.</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#a7558e9565611e756e36cad823d912075">filename_from_utf8</a>(<span class="keyword">const</span> std::string& input);</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"></span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * Converts text from the system's filename encoding to UTF-8.</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * @param input Text in valid filename encoding.</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * @return The input text converted to UTF-8.</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * if conversion fails because the input string is not in valid</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * filename encoding.</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * @note glib takes the system's filename encoding from the</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * environmental variables G_FILENAME_ENCODING and G_BROKEN_FILENAMES.</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * If G_BROKEN_FILENAMES is set to 1 and G_FILENAME_ENCODING is not</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * set, it will be assumed that the filename encoding is the same as</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * the locale encoding. If G_FILENAME_ENCODING is set, then</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * G_BROKEN_FILENAMES is ignored, and filename encoding is taken from</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * the value held by G_FILENAME_ENCODING.</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#a35d8587d70e19fbad85bb3b424441c6a">filename_to_utf8</a>(<span class="keyword">const</span> std::string& input); </div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"></span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * Converts text from UTF-8 to the system's locale encoding.</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * @param input Text in valid UTF-8 format.</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * @return The input text converted to locale encoding.</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * if conversion fails because the input string is not in valid UTF-8</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * format, or cannot be converted to locale encoding (eg because the</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * input characters cannot be represented by that encoding).</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#a84439123d22c79e7bb62ec729dbb56d2">locale_from_utf8</a>(<span class="keyword">const</span> std::string& input);</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"></span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> * Converts text from the system's locale encoding to UTF-8.</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * @param input Text in valid locale encoding.</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * @return The input text converted to UTF-8.</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * @exception Cgu::Utf8::ConversionError This exception will be thrown</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * if conversion fails because the input string is not in valid locale</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * encoding.</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * if memory is exhausted and the system throws in that case.</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> std::string <a class="code" href="namespaceCgu_1_1Utf8.html#ad53e1d8ed4e6bf9b5566e5cd421876fd">locale_to_utf8</a>(<span class="keyword">const</span> std::string& input); </div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"></span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> * Indicates whether the input text comprises valid UTF-8.</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * @param text The text to be tested.</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * @return true if the input text is in valid UTF-8 format, otherwise</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * false.</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * @exception std::bad_alloc This function might throw std::bad_alloc</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * if std::string::data() might throw when memory is exhausted.</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * @note \#include <c++-gtk-utils/convert.h> for this function.</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a3cb9b1a4ac0f09c70da65fce7613bff6"> 305</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a3cb9b1a4ac0f09c70da65fce7613bff6">validate</a>(<span class="keyword">const</span> std::string& text) {</div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="keywordflow">return</span> g_utf8_validate(text.data(), text.size(), 0);</div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> }</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">/************** Iterator class **************/</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"></span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment">/** </span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * @class Iterator convert.h c++-gtk-utils/convert.h</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * @brief A class which will iterate through a std::string object by</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * reference to unicode characters rather than by bytes.</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * @sa Cgu::Utf8::ReverseIterator</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * The Cgu::Utf8::Iterator class does the same as</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * std::string::const_iterator, except that when iterating through a</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * std::string object using the ++ and - - postfix and prefix</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * operators, it iterates by increments of whole unicode code points</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * rather than by reference to bytes. In addition, the dereferencing</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * operator returns the whole unicode code point (a UCS-4 gunichar</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * type) rather than a char type.</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> * Where, as in practically all unix-like systems, sizeof(wchar_t) ==</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * 4, then the gunichar return value of the dereferencing operator can</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * be converted by a simple static_cast to the wchar_t type. So far</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * as displaying individual code points is concerned however, it</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * should be noted that because unicode allows combining characters, a</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * unicode code point may not contain the whole representation of a</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * character as displayed. This effect can be dealt with for all</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * characters capable of representation by Level 1 unicode (ie by</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * precomposed characters) using g_utf8_normalize() before iterating.</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * There will still however be some non-European scripts, in</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * particular some Chinese/Japanese/Korean ideograms, where</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * description of the ideogram requires more than one code point to be</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * finally resolved. For these, printing individual code points</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * sequentially one by one directly to a display (say with std::wcout)</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * may or not may not have the desired result, depending on how the</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * display device (eg console) deals with that case.</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * A Cgu::Utf8::Iterator only allows reading from and not writing to</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * the std::string object being iterated through. This is because in</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * UTF-8 the representation of any one unicode code point will require</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * between 1 and 6 bytes: accordingly modifying a UTF-8 string may</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * change its length (in bytes) even though the number of unicode</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * characters stays the same. For the same reason, this iterator is a</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * bidirectional iterator but not a random access iterator.</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * The std::string object concerned should contain valid UTF-8 text.</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * If necessary, this should be checked with Cgu::Utf8::validate()</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * first. In addition, before use, the Cgu::Utf8::Iterator object</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * must be initialized by a std::string::const_iterator or</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * std::string::iterator object pointing to the first byte of a valid</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> * UTF-8 character in the string (or by another Cgu::Utf8::Iterator</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * object or by a Cgu::Utf8::ReverseIterator object), and iteration</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * will begin at the point of initialization: therefore, assuming the</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * string contains valid UTF-8 text, passing std::string::begin() to a</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * Cgu::Utf8::Iterator object will always be safe. Initialization by</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * std::string::end() is also valid if the first iteration is</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * backwards with the \-- operator. This initialization can be done</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * either in the constructor or by assignment. Comparison operators</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * ==, !=, <, <=, > and >= are provided enabling the position of</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * Cgu::Utf8::Iterator objects to be compared with each other or with</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> * std::string::const_iterator and std::string::iterator objects.</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * This is an example:</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> * std::wstring wide_str(L"ßøǿón");</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * std::string narrow_str(Utf8::uniwide_to_utf8(wide_str));</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * Utf8::Iterator iter;</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * for (iter = narrow_str.begin();</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * iter != narrow_str.end();</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> * ++iter)</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * std::wcout << static_cast<wchar_t>(*iter) << std::endl;</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> * This class assumes in using g_utf8_next_char(), g_utf8_prev_char()</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * and g_utf8_get_char() that the std::string object keeps its</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * internal string in contiguous storage. This is required by the</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * C++11 standard, but not formally by C++98/C++03. However, known</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> * implementations of std::string in fact store the string</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> * contiguously.</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> */</span> </div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> </div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="keyword">class </span>ReverseIterator;</div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> </div>
<div class="line"><a name="l00391"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html"> 391</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> {</div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00393"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a62ffea4def2ef1100010833fab1267d3"> 393</a></span>  <span class="keyword">typedef</span> gunichar <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a62ffea4def2ef1100010833fab1267d3">value_type</a>;</div>
<div class="line"><a name="l00394"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a4327ea73ba27390fa6ac153c8e317b1c"> 394</a></span>  <span class="keyword">typedef</span> gunichar <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a4327ea73ba27390fa6ac153c8e317b1c">reference</a>; <span class="comment">// read only</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#ab81aae3eca57fdc5a4d62958d184e613"> 395</a></span>  <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#ab81aae3eca57fdc5a4d62958d184e613">pointer</a>; <span class="comment">// read only</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#aad4fd7be4e9a1183cc70f6455dd9a45e"> 396</a></span>  <span class="keyword">typedef</span> std::string::difference_type <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#aad4fd7be4e9a1183cc70f6455dd9a45e">difference_type</a>;</div>
<div class="line"><a name="l00397"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#af558ba5e985dce77a0aae1b8ea01961e"> 397</a></span>  <span class="keyword">typedef</span> std::bidirectional_iterator_tag <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#af558ba5e985dce77a0aae1b8ea01961e">iterator_category</a>;</div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> </div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="keyword">private</span>: </div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  std::string::const_iterator pos;</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"></span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * Increments the iterator so that it moves from the beginning of the</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * current UTF-8 character to the beginning of the next UTF-8</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * character. It is a prefix operator. It will not throw.</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * @return A reference to the iterator in its new position.</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a88ff5bc8ff83ca15d9fff85f0d7af76f">operator++</a>();</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"></span></div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> * Increments the iterator so that it moves from the beginning of the</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * current UTF-8 character to the beginning of the next UTF-8</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * character. It is a postfix operator. It will not throw provided</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * that copy constructing and assigning a std::string::const_iterator</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * object does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * @return A copy of the iterator in its former position.</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a88ff5bc8ff83ca15d9fff85f0d7af76f">operator++</a>(<span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"></span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> * Decrements the iterator so that it moves from the beginning of the</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> * current UTF-8 character to the beginning of the previous UTF-8</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> * character. It is a prefix operator. It will not throw.</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * @return A reference to the iterator in its new position.</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1205c23efa2ac989b4f893cd4b1c7d71">operator--</a>();</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"></span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * Decrements the iterator so that it moves from the beginning of the</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> * current UTF-8 character to the beginning of the previous UTF-8</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> * character. It is a postfix operator. It will not throw provided</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * that copy constructing and assigning a std::string::const_iterator</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * object does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> * @return A copy of the iterator in its former position.</span></div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1205c23efa2ac989b4f893cd4b1c7d71">operator--</a>(<span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"></span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> * Assigns a std::string::const_iterator object to this object. It</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> * should point to the beginning of a UTF-8 character (eg</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * std::string::begin()) or to std::string::end(). It will not throw</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> * provided assigning a std::string::const_iterator object does not</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> * throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> * @param iter The std::string::const_iterator.</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> * @return A reference to this Cgu::Utf8::Iterator object after</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00449"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a068615b7ba3808dca58fb911188ab1d2"> 449</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a068615b7ba3808dca58fb911188ab1d2">operator=</a>(<span class="keyword">const</span> std::string::const_iterator& iter) {pos = iter; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"></span></div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment"> * Assigns a std::string::iterator object to this object. It should</span></div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"> * point to the beginning of a UTF-8 character (eg</span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> * std::string::begin()) or to std::string::end(). It will not throw</span></div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"> * provided assigning a std::string::const_iterator object does not</span></div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> * throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> * @param iter The std::string::iterator.</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> * @return A reference to this Cgu::Utf8::Iterator object after</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00461"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a700fa98c00992c78bd10065165d33f49"> 461</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a700fa98c00992c78bd10065165d33f49">operator=</a>(<span class="keyword">const</span> std::string::iterator& iter) {pos = iter; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"></span></div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> * Assigns a Cgu::Utf8::Iterator object to this object. It will not</span></div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> * throw provided assigning a std::string::const_iterator object does</span></div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> * not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> * @return A reference to this Cgu::Utf8::Iterator object after</span></div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00471"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a54e783e02573252cf2817f3d6e168b09"> 471</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a54e783e02573252cf2817f3d6e168b09">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter) {pos = iter.pos; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"></span></div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> * Assigns a Cgu::Utf8::ReverseIterator object to this object, so that</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> * this iterator adopts the same physical position (but the logical</span></div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> * position will be offset to the following UTF-8 character). It will</span></div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> * not throw provided assigning a std::string::const_iterator object</span></div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> * does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> * @return A reference to this Cgu::Utf8::Iterator object after</span></div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a068615b7ba3808dca58fb911188ab1d2">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter);</div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"></span></div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> * The dereference operator.</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> * @return A 32-bit gunichar object containing the whole unicode code</span></div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> * point which is currently represented by this iterator. It will not</span></div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"> * throw.</span></div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#afeae5c292d8e6b617fbd5881214cc454"> 491</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a62ffea4def2ef1100010833fab1267d3">Iterator::value_type</a> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#afeae5c292d8e6b617fbd5881214cc454">operator*</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> g_utf8_get_char(&(*pos));}</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"></span></div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> * @return The current underlying std::string::const_iterator kept by</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * this iterator. Once this iterator has been correctly initialized,</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> * that will point to the beginning of the UTF-8 character currently</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> * represented by this iterator or to std::string::end(). It will not</span></div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> * throw provided assigning a std::string::const_iterator object does</span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d"> 501</a></span>  std::string::const_iterator <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> pos;}</div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"></span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> * Constructs this iterator and initialises it with a</span></div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * std::string::const_iterator object. It should point to the</span></div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> * beginning of a UTF-8 character (eg std::string::begin()) or to</span></div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> * std::string::end(). It will not throw provided that copy</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> * constructing a std::string::const_iterator object does not throw,</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> * as it will not in any sane implementation. This is a type</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> * conversion constructor (it is not marked explicit) so that it can</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> * be used with Cgu::Utf8::Iterator comparison operators to compare</span></div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> * the position of Cgu::Utf8::Iterator with</span></div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> * std::string::const_iterator objects.</span></div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> * @param iter The std::string::const_iterator.</span></div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a4fcfa8fdb5680b2e3026298cd19cdebc"> 516</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a4fcfa8fdb5680b2e3026298cd19cdebc">Iterator</a>(<span class="keyword">const</span> std::string::const_iterator& iter): pos(iter) {}</div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"></span></div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> * Constructs this iterator and initialises it with a</span></div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> * std::string::iterator object. It should point to the beginning of</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> * a UTF-8 character (eg std::string::begin()) or to</span></div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> * std::string::end(). It will not throw provided that copy</span></div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> * constructing a std::string::const_iterator object does not throw,</span></div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> * as it will not in any sane implementation. This is a type</span></div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> * conversion constructor (it is not marked explicit) so that it can</span></div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> * be used with Cgu::Utf8::Iterator comparison operators to compare</span></div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> * the position of Cgu::Utf8::Iterator with std::string::iterator</span></div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> * objects.</span></div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> * @param iter The std::string::iterator.</span></div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1d072f0df110be4ee72f85d380c6abae"> 531</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1d072f0df110be4ee72f85d380c6abae">Iterator</a>(<span class="keyword">const</span> std::string::iterator& iter): pos(iter) {}</div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"></span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> * Constructs this iterator and initialises it with another</span></div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> * Cgu::Utf8::Iterator object. It will not throw provided that copy</span></div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> * constructing a std::string::const_iterator object does not throw,</span></div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> * as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00540"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a15c8851fb0c4c9bae6eccbf028ced1f1"> 540</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a15c8851fb0c4c9bae6eccbf028ced1f1">Iterator</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter): pos(iter.pos) {}</div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"></span></div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> * Constructs this iterator and initialises it with a</span></div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> * Cgu::Utf8::ReverseIterator object, so that this iterator adopts the</span></div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> * same physical position (but the logical position will be offset to</span></div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> * the following UTF-8 character). It will not throw provided that</span></div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> * copy constructing a std::string::const_iterator object does not</span></div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> * throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#af076c14693c1eb45bbb795f3381ec321">Iterator</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter);</div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"></span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> * The default constructor will not throw.</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00556"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#af076c14693c1eb45bbb795f3381ec321"> 556</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#af076c14693c1eb45bbb795f3381ec321">Iterator</a>() {}</div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> </div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> };</div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> </div>
<div class="line"><a name="l00563"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a88ff5bc8ff83ca15d9fff85f0d7af76f"> 563</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a88ff5bc8ff83ca15d9fff85f0d7af76f">Iterator::operator++</a>() {</div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  <span class="keyword">const</span> std::string::value_type* tmp = &(*pos);</div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  <span class="comment">// using g_utf8_next_char is safe even when pos points to the last character -</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  <span class="comment">// that macro calls up the g_utf8_skip look-up table rather than attempting to</span></div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  <span class="comment">// read the following character, so we can safely iterate to std::string::end()</span></div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  pos += g_utf8_next_char(tmp) - tmp;</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> }</div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> </div>
<div class="line"><a name="l00572"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a85e5ec630aea42c2018dc53719133810"> 572</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a88ff5bc8ff83ca15d9fff85f0d7af76f">Iterator::operator++</a>(<span class="keywordtype">int</span>) {</div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> tmp{*<span class="keyword">this</span>};</div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  ++(*this);</div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  <span class="keywordflow">return</span> tmp;</div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> }</div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>  </div>
<div class="line"><a name="l00578"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1205c23efa2ac989b4f893cd4b1c7d71"> 578</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1205c23efa2ac989b4f893cd4b1c7d71">Iterator::operator--</a>() {</div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>  <span class="comment">// we might be iterating from std::string::end() so we need</span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  <span class="comment">// to decrement before dereferencing and then increment again</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span>  <span class="keyword">const</span> std::string::value_type* tmp = &(*(pos-1));</div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  ++tmp;</div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>  pos -= tmp - g_utf8_prev_char(tmp);</div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> }</div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> </div>
<div class="line"><a name="l00587"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a4e05229e9c17ba043648ca9c664ae7a5"> 587</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a1205c23efa2ac989b4f893cd4b1c7d71">Iterator::operator--</a>(<span class="keywordtype">int</span>) {</div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> tmp{*<span class="keyword">this</span>};</div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span>  --(*this);</div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  <span class="keywordflow">return</span> tmp;</div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> }</div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"></span></div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00598"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a811043c0cb44ff800ae553780b933154"> 598</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a811043c0cb44ff800ae553780b933154">operator==</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter2) {</div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>() == iter2.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>());</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> }</div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  <span class="comment"></span></div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00607"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a4125241118095ab544c2f28972d30368"> 607</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a4125241118095ab544c2f28972d30368">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter2) {</div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>() != iter2.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>());</div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> }</div>
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span>  <span class="comment"></span></div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00616"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a209b6ead3c1b6ab671883d9b43082685"> 616</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a209b6ead3c1b6ab671883d9b43082685">operator<</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter2) {</div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>() < iter2.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>());</div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> }</div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span>  <span class="comment"></span></div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00625"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a557f8e1bde924774efd854b1e896cde2"> 625</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a557f8e1bde924774efd854b1e896cde2">operator<=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter2) {</div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>() <= iter2.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>());</div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> }</div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>  <span class="comment"></span></div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00634"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a77768d68d01ed844b663de2ae49e7076"> 634</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a77768d68d01ed844b663de2ae49e7076">operator></a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter2) {</div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>() > iter2.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>());</div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> }</div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span>  <span class="comment"></span></div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00643"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#af69a9349578e4577f40911d80e99d30b"> 643</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#af69a9349578e4577f40911d80e99d30b">operator>=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter2) {</div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>() >= iter2.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>());</div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> }</div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>  </div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment">/************** ReverseIterator class **************/</span></div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"></span></div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"> * @class ReverseIterator convert.h c++-gtk-utils/convert.h</span></div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> * @brief A class which will iterate in reverse through a std::string</span></div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> * object by reference to unicode characters rather than by bytes.</span></div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> * @sa Cgu::Utf8::Iterator</span></div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> * The Cgu::Utf8::ReverseIterator class does the same as</span></div>
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> * std::string::const_reverse_iterator, except that when iterating</span></div>
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> * through a std::string object using the ++ and - - postfix and</span></div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> * prefix operators, it iterates by increments of whole unicode code</span></div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> * points rather than by reference to bytes. In addition, the</span></div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> * dereferencing operator returns the whole unicode code point (a</span></div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> * UCS-4 gunichar type) rather than a char type.</span></div>
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"> * Before use, the Cgu::Utf8::ReverseIterator object must be</span></div>
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> * initialized by a std::string::const_reverse_iterator or</span></div>
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> * std::string::reverse_iterator object representing the first byte of</span></div>
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> * a valid UTF-8 character in the string (or by another</span></div>
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> * Cgu::Utf8::ReverseIterator object or by a Cgu::Utf8::Iterator</span></div>
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> * object): so assuming the string contains valid UTF-8 text, it is</span></div>
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> * always valid to initialise a Cgu::Utf8::ReverseIterator with</span></div>
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> * std::string::rbegin(). Initialization by std::string::rend() is</span></div>
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> * also valid if the first interation is backwards with the \--</span></div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> * operator. This initialization can be done either in the</span></div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> * constructor or by assignment. Comparison operators ==, !=, <, <=,</span></div>
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> * > and >= are provided enabling the position of</span></div>
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> * Cgu::Utf8::ReverseIterator objects to be compared with each other</span></div>
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> * or with std::string::const_reverse_iterator and</span></div>
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> * std::string::reverse_iterator objects.</span></div>
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment"> * This is an example:</span></div>
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment"> * std::wstring wide_str(L"ßøǿón");</span></div>
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment"> * std::string narrow_str(Utf8::uniwide_to_utf8(wide_str));</span></div>
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> * Utf8::ReverseIterator iter;</span></div>
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> * for (iter = narrow_str.rbegin();</span></div>
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> * iter != narrow_str.rend();</span></div>
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> * ++iter)</span></div>
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> * std::wcout << static_cast<wchar_t>(*iter) << std::endl;</span></div>
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"> * For further information on its use, see the Utf8::Iterator</span></div>
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> * documentation.</span></div>
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> </div>
<div class="line"><a name="l00697"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html"> 697</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> {</div>
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00699"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af7700438dc7c135a79f14dcdd2581cb3"> 699</a></span>  <span class="keyword">typedef</span> gunichar <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af7700438dc7c135a79f14dcdd2581cb3">value_type</a>;</div>
<div class="line"><a name="l00700"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a51b863c9d2c1991a7038f5d3e92be968"> 700</a></span>  <span class="keyword">typedef</span> gunichar <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a51b863c9d2c1991a7038f5d3e92be968">reference</a>; <span class="comment">// read only</span></div>
<div class="line"><a name="l00701"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#adc5e065484f73e209650fa33403acc7f"> 701</a></span>  <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#adc5e065484f73e209650fa33403acc7f">pointer</a>; <span class="comment">// read only</span></div>
<div class="line"><a name="l00702"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a749072cc9ce0a4b156488ec63f5ca1af"> 702</a></span>  <span class="keyword">typedef</span> std::string::difference_type <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a749072cc9ce0a4b156488ec63f5ca1af">difference_type</a>;</div>
<div class="line"><a name="l00703"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2074ba5e9dce60923a4a9dead9ed07f1"> 703</a></span>  <span class="keyword">typedef</span> std::bidirectional_iterator_tag <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2074ba5e9dce60923a4a9dead9ed07f1">iterator_category</a>;</div>
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span> </div>
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="keyword">private</span>: </div>
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span>  std::string::const_iterator pos;</div>
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span>  <span class="comment">// we use cache to make iterating and then dereferencing more efficient</span></div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span>  <span class="keyword">mutable</span> std::string::const_iterator cache;</div>
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"></span></div>
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"> * Increments the iterator in the reverse direction so that it moves</span></div>
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"> * from the beginning of the current UTF-8 character to the beginning</span></div>
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> * of the previous UTF-8 character in the std::string object</span></div>
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment"> * concerned. It is a prefix operator. It will not throw provided</span></div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"> * assigning a std::string::const_iterator object does not throw, as</span></div>
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment"> * it will not in any sane implementation.</span></div>
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment"> * @return A reference to the iterator in its new position</span></div>
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a65598816cf4abe163424ccf6229372c7">operator++</a>();</div>
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment"></span></div>
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> * Increments the iterator in the reverse direction so that it moves</span></div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> * from the beginning of the current UTF-8 character to the beginning</span></div>
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"> * of the previous UTF-8 character in the std::string object</span></div>
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> * concerned. It is a postfix operator. It will not throw provided</span></div>
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment"> * that copy constructing and assigning a std::string::const_iterator</span></div>
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment"> * object does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment"> * @return A copy of the iterator in its former position</span></div>
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a65598816cf4abe163424ccf6229372c7">operator++</a>(<span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment"></span></div>
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> * Decrements the iterator in the reverse direction so that it moves</span></div>
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment"> * from the beginning of the current UTF-8 character to the beginning</span></div>
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"> * of the following UTF-8 character in the std::string object</span></div>
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="comment"> * concerned. It is a prefix operator. It will not throw provided</span></div>
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="comment"> * assigning a std::string::const_iterator object does not throw, as</span></div>
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span> <span class="comment"> * it will not in any sane implementation.</span></div>
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="comment"> * @return A reference to the iterator in its new position</span></div>
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a9a36ec2a958d771bcf4c3cd14631a29c">operator--</a>();</div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="comment"></span></div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="comment"> * Decrements the iterator in the reverse direction so that it moves</span></div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment"> * from the beginning of the current UTF-8 character to the beginning</span></div>
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"> * of the following UTF-8 character in the std::string object</span></div>
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"> * concerned. It is a postfix operator. It will not throw provided</span></div>
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment"> * that copy constructing and assigning a std::string::const_iterator</span></div>
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"> * object does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment"> * @return A copy of the iterator in its former position</span></div>
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a9a36ec2a958d771bcf4c3cd14631a29c">operator--</a>(<span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="comment"></span></div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="comment"> * Assigns a std::string::const_reverse_iterator object to this</span></div>
<div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment"> * object. It should represent the beginning of a UTF-8 character (eg</span></div>
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment"> * std::string::rbegin()) or comprise std::string::rend(). It will</span></div>
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment"> * not throw provided assigning a std::string::const_iterator object</span></div>
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment"> * does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="comment"> * @param iter The const_reverse_iterator.</span></div>
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="comment"> * @return A reference to this Cgu::Utf8::ReverseIterator object after</span></div>
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00765"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af930b85be45bccb5f7a455a47dd3fa69"> 765</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af930b85be45bccb5f7a455a47dd3fa69">operator=</a>(<span class="keyword">const</span> std::string::const_reverse_iterator& iter) {pos = iter.base(); cache = pos; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"></span></div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"> * Assigns a std::string::reverse_iterator object to this object. It</span></div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment"> * should represent the beginning of a UTF-8 character (eg</span></div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment"> * std::string::rbegin()) or comprise std::string::rend(). It will</span></div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment"> * not throw provided assigning a std::string::const_iterator object</span></div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> * does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment"> * @param iter The reverse_iterator.</span></div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment"> * @return A reference to this Cgu::Utf8::ReverseIterator object after</span></div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00777"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a03763750b536546e6d5361183340fee9"> 777</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a03763750b536546e6d5361183340fee9">operator=</a>(<span class="keyword">const</span> std::string::reverse_iterator& iter) {pos = iter.base(); cache = pos; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment"></span></div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment"> * Assigns a Cgu::Utf8::ReverseIterator object to this object. It</span></div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span> <span class="comment"> * will not throw provided assigning a std::string::const_iterator</span></div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="comment"> * object does not throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="comment"> * @return A reference to this Cgu::Utf8::ReverseIterator object after</span></div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00787"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a0ebda89d71b66d000c4be4834b7da012"> 787</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a0ebda89d71b66d000c4be4834b7da012">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter) {pos = iter.pos; cache = iter.cache; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"></span></div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="comment"> * Assigns a Cgu::Utf8::Iterator object to this object, so that this</span></div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment"> * iterator adopts the same physical position (but the logical</span></div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="comment"> * position will be offset to the previous UTF-8 character in the</span></div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment"> * std::string object concerned). It will not throw provided</span></div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="comment"> * assigning a std::string::const_iterator object does not throw, as</span></div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment"> * it will not in any sane implementation.</span></div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="comment"> * @return A reference to this Cgu::Utf8::ReverseIterator object after</span></div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="comment"> * assignment.</span></div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00800"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a78a62f2a80607ca4e79b56251556c78b"> 800</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a78a62f2a80607ca4e79b56251556c78b">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter) {pos = iter.<a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a84233ca3daa5c1cbcb4a39f48745e00d">base</a>(); cache = pos; <span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="comment"></span></div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment"> * The dereference operator. Note that although this method is const,</span></div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"> * it is not thread safe for concurrent reads without external</span></div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> * synchronization because it writes to an internal cache.</span></div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> * @return A 32-bit gunichar object containing the whole unicode code</span></div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment"> * point which is currently represented by this iterator. It will not</span></div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="comment"> * throw.</span></div>
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af7700438dc7c135a79f14dcdd2581cb3">ReverseIterator::value_type</a> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a8aae18768e48d7b3bfa2810e9e4cad3b">operator*</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="comment"></span></div>
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment"> * @return The current underlying std::string::const_iterator kept by</span></div>
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"> * this iterator. Once this iterator has been correctly initialized,</span></div>
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"> * that will point to the beginning of the UTF-8 character after the</span></div>
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment"> * one currently represented by this iterator or to</span></div>
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"> * std::string::end(). It will not throw provided assigning a</span></div>
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00821"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f"> 821</a></span>  std::string::const_iterator <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> pos;}</div>
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment"></span></div>
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment"> * Constructs this iterator and initialises it with a</span></div>
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment"> * std::string::const_reverse_iterator object. It should represent</span></div>
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span> <span class="comment"> * the beginning of a UTF-8 character (eg std::string::rbegin()) or</span></div>
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="comment"> * comprise std::string::rend(). It will not throw provided that copy</span></div>
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="comment"> * constructing a std::string::const_iterator object does not throw,</span></div>
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="comment"> * as it will not in any sane implementation. This is a type</span></div>
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment"> * conversion constructor (it is not marked explicit) so that it can</span></div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="comment"> * be used with Cgu::Utf8::ReverseIterator comparison operators to</span></div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span> <span class="comment"> * compare the position of Cgu::Utf8::ReverseIterator with</span></div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="comment"> * std::string::const_reverse_iterator objects.</span></div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span> <span class="comment"> * @param iter The const_reverse_iterator.</span></div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00836"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#aced40bc6c20dfcbb587ebfab00a54d4f"> 836</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#aced40bc6c20dfcbb587ebfab00a54d4f">ReverseIterator</a>(<span class="keyword">const</span> std::string::const_reverse_iterator& iter): pos(iter.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>()), cache(pos) {}</div>
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"></span></div>
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment"> * Constructs this iterator and initialises it with a</span></div>
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment"> * std::string::reverse_iterator object. It should represent the</span></div>
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment"> * beginning of a UTF-8 character (eg std::string::rbegin()) or</span></div>
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"> * comprise std::string::rend(). It will not throw provided that copy</span></div>
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="comment"> * constructing a std::string::const_iterator object does not throw,</span></div>
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="comment"> * as it will not in any sane implementation. This is a type</span></div>
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span> <span class="comment"> * conversion constructor (it is not marked explicit) so that it can</span></div>
<div class="line"><a name="l00846"></a><span class="lineno"> 846</span> <span class="comment"> * be used with Cgu::Utf8::ReverseIterator comparison operators to</span></div>
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span> <span class="comment"> * compare the position of Cgu::Utf8::ReverseIterator with</span></div>
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span> <span class="comment"> * std::string::reverse_iterator objects.</span></div>
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span> <span class="comment"> * @param iter The reverse_iterator.</span></div>
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00851"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af2f7698d37efc86acaafc87a067f0d3d"> 851</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af2f7698d37efc86acaafc87a067f0d3d">ReverseIterator</a>(<span class="keyword">const</span> std::string::reverse_iterator& iter): pos(iter.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>()), cache(pos) {}</div>
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment"></span></div>
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment"> * Constructs this iterator and initialises it with another</span></div>
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"> * Cgu::Utf8::ReverseIterator object. It will not throw provided that</span></div>
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"> * copy constructing a std::string::const_iterator object does not</span></div>
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"> * throw, as it will not in any sane implementation.</span></div>
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00860"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a1b74b3c8b7be850c9f7affc35010b8ec"> 860</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a1b74b3c8b7be850c9f7affc35010b8ec">ReverseIterator</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter): pos(iter.pos), cache(iter.cache) {}</div>
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment"></span></div>
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment"> * Constructs this iterator and initialises it with a</span></div>
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment"> * Cgu::Utf8::Iterator object, so that this iterator adopts the same</span></div>
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment"> * physical position (but the logical position will be offset to the</span></div>
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span> <span class="comment"> * previous UTF-8 character in the std::string object concerned). It</span></div>
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment"> * will not throw provided that copy constructing a</span></div>
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span> <span class="comment"> * @param iter The iterator.</span></div>
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00872"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a26f1e5ef37433211d94a6526ffb48779"> 872</a></span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a26f1e5ef37433211d94a6526ffb48779">ReverseIterator</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& iter): pos(iter.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>()), cache(pos) {}</div>
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span> <span class="comment"></span></div>
<div class="line"><a name="l00874"></a><span class="lineno"> 874</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span> <span class="comment"> * The default constructor will not throw.</span></div>
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00877"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a205086782af39730ad370fa3816fb9db"> 877</a></span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a205086782af39730ad370fa3816fb9db">ReverseIterator</a>() {}</div>
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span> </div>
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div>
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div>
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span> };</div>
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span> </div>
<div class="line"><a name="l00884"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a65598816cf4abe163424ccf6229372c7"> 884</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a65598816cf4abe163424ccf6229372c7">ReverseIterator::operator++</a>() {</div>
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span> </div>
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span>  <span class="keywordflow">if</span> (pos > cache) pos = cache;</div>
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span> </div>
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span>  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span>  <span class="comment">// we might be iterating from std::string::end()/std::string::rbegin() so</span></div>
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span>  <span class="comment">// we need to decrement before dereferencing and then increment again</span></div>
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span>  <span class="keyword">const</span> std::string::value_type* tmp = &(*(pos-1));</div>
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span>  ++tmp;</div>
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span>  pos -= tmp - g_utf8_prev_char(tmp);</div>
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span>  }</div>
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> }</div>
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> </div>
<div class="line"><a name="l00898"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#ae07881eab300ac4acedb30b8bb20c8a9"> 898</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a65598816cf4abe163424ccf6229372c7">ReverseIterator::operator++</a>(<span class="keywordtype">int</span>) {</div>
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> tmp{*<span class="keyword">this</span>};</div>
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span>  ++(*this);</div>
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span>  <span class="keywordflow">return</span> tmp;</div>
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span> }</div>
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span>  </div>
<div class="line"><a name="l00904"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a9a36ec2a958d771bcf4c3cd14631a29c"> 904</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a9a36ec2a958d771bcf4c3cd14631a29c">ReverseIterator::operator--</a>() {</div>
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span>  cache = pos;</div>
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span>  <span class="keyword">const</span> std::string::value_type* tmp = &(*pos);</div>
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span>  <span class="comment">// using g_utf8_next_char is safe even when pos points to the first character -</span></div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span>  <span class="comment">// that macro calls up the g_utf8_skip look-up table rather than attempting to</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span>  <span class="comment">// read the following character, so we can safely iterate to std::string::rbegin()</span></div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span>  pos += g_utf8_next_char(tmp) - tmp;</div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> }</div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> </div>
<div class="line"><a name="l00914"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#adfafd2d00e72832030cbfb04c74ea4c2"> 914</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a9a36ec2a958d771bcf4c3cd14631a29c">ReverseIterator::operator--</a>(<span class="keywordtype">int</span>) {</div>
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span>  <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a> tmp{*<span class="keyword">this</span>};</div>
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span>  --(*this);</div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span>  <span class="keywordflow">return</span> tmp;</div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span> }</div>
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> </div>
<div class="line"><a name="l00920"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a8aae18768e48d7b3bfa2810e9e4cad3b"> 920</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#af7700438dc7c135a79f14dcdd2581cb3">ReverseIterator::value_type</a> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a8aae18768e48d7b3bfa2810e9e4cad3b">ReverseIterator::operator*</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span>  <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a> tmp{*<span class="keyword">this</span>};</div>
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span>  --tmp;</div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span>  cache = tmp.base();</div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span>  <span class="keywordflow">return</span> g_utf8_get_char(&(*(tmp.base())));</div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> }</div>
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment"></span></div>
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00932"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a644ac807ed10e7ab371b56da2e597549"> 932</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a811043c0cb44ff800ae553780b933154">operator==</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter2) {</div>
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>() == iter2.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>());</div>
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span> }</div>
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span>  <span class="comment"></span></div>
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"> * in any sane implementation.</span></div>
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00941"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a41f9a85f376d4dc130cd1355574e7099"> 941</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a4125241118095ab544c2f28972d30368">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter2) {</div>
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>() != iter2.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>());</div>
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span> }</div>
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span>  <span class="comment"></span></div>
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment"> * in any sane implementation. Ordering is viewed from the</span></div>
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment"> * perspective of the logical operation (reverse iteration), so that</span></div>
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment"> * for example an iterator at position std::string::rbegin() is less</span></div>
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment"> * than an iterator at position std::string::rend().</span></div>
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00953"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a01f2ce213396215c0c27511b75ac4371"> 953</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a209b6ead3c1b6ab671883d9b43082685">operator<</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter2) {</div>
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>() > iter2.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>());</div>
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span> }</div>
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span>  <span class="comment"></span></div>
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span> <span class="comment"> * in any sane implementation. Ordering is viewed from the</span></div>
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span> <span class="comment"> * perspective of the logical operation (reverse iteration), so that</span></div>
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span> <span class="comment"> * for example an iterator at position std::string::rbegin() is less</span></div>
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment"> * than an iterator at position std::string::rend().</span></div>
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00965"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a0aedf502f52cc00866847ce187871cbe"> 965</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a557f8e1bde924774efd854b1e896cde2">operator<=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter2) {</div>
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>() >= iter2.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>());</div>
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span> }</div>
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span>  <span class="comment"></span></div>
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment"> * in any sane implementation. Ordering is viewed from the</span></div>
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"> * perspective of the logical operation (reverse iteration), so that</span></div>
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"> * for example an iterator at position std::string::rbegin() is less</span></div>
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"> * than an iterator at position std::string::rend().</span></div>
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00977"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#a27e80db9f1a4dd1fdbee50958f7080bf"> 977</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#a77768d68d01ed844b663de2ae49e7076">operator></a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter2) {</div>
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>() < iter2.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>());</div>
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span> }</div>
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"></span></div>
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> * The comparison operators will not throw provided assigning a</span></div>
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment"> * std::string::const_iterator object does not throw, as it will not</span></div>
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment"> * in any sane implementation. Ordering is viewed from the</span></div>
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment"> * perspective of the logical operation (reverse iteration), so that</span></div>
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="comment"> * for example an iterator at position std::string::rbegin() is less</span></div>
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span> <span class="comment"> * than an iterator at position std::string::rend().</span></div>
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00989"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1Utf8.html#abbb5652105f9ebb49643e471fbd4fec9"> 989</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceCgu_1_1Utf8.html#af69a9349578e4577f40911d80e99d30b">operator>=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter2) {</div>
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span>  <span class="keywordflow">return</span> (iter1.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>() <= iter2.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>());</div>
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span> }</div>
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span>  </div>
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span> <span class="comment">/*** Iterator class methods which require ReverseIterator as a complete type ***/</span></div>
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span> </div>
<div class="line"><a name="l00995"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#ac34a4c061614ca1582960e3de6c52814"> 995</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html" title="A class which will iterate through a std::string object by reference to unicode characters rather tha...">Iterator</a>& <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a068615b7ba3808dca58fb911188ab1d2">Iterator::operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter) {</div>
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span>  pos = iter.<a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html#a2dd9bf521d79c0c69c16870726f62d0f">base</a>();</div>
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span> }</div>
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span> </div>
<div class="line"><a name="l01000"></a><span class="lineno"><a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#a484edb631e37db19c1c8021320650760"> 1000</a></span> <span class="keyword">inline</span> <a class="code" href="classCgu_1_1Utf8_1_1Iterator.html#af076c14693c1eb45bbb795f3381ec321">Iterator::Iterator</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1Utf8_1_1ReverseIterator.html" title="A class which will iterate in reverse through a std::string object by reference to unicode characters...">ReverseIterator</a>& iter): pos(iter.base()) {}</div>
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> </div>
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span> } <span class="comment">// namespace Utf8</span></div>
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> </div>
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> } <span class="comment">// namespace Cgu</span></div>
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> </div>
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 16 2013 20:45:30 for c++-gtk-utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
