<!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: gstream.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">gstream.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gstream_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) 2010 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"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</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="l00005"></a><span class="lineno"> 5</span> <span class="comment">distributed by Chris Vine under the GNU Lesser General Public</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">License as follows:</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1 of</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> License, version 2.1, along with this library (see the file LGPL.TXT</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> which came with this source code package in the c++-gtk-utils</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> sub-directory); if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">However, it is not intended that the object code of a program whose</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">source code instantiates a template from this file or uses macros or</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">inline functions (of any length) should by reason only of that</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">instantiation or use be subject to the restrictions of use in the GNU</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">Lesser General Public License. With that in mind, the words "and</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">macros, inline functions and instantiations of templates (of any</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">length)" shall be treated as substituted for the words "and small</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">macros and small inline functions (ten lines or less in length)" in</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">the fourth paragraph of section 5 of that licence. This does not</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">affect any other reason why object code may be subject to the</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">restrictions in that licence (nor for the avoidance of doubt does it</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">affect the application of section 2 of that licence to modifications</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">of the source code in this file).</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> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @defgroup gstreams gstreams</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * \#include <c++-gtk-utils/gstream.h></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * The c++-gtk-utils library contains C++ classes providing a</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * streambuffer and stream objects interfacing with GIO streams.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * Normally 'true' would be passed as the second (manage) argument of</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * the gostream/gistream/giostream constructors or of the attach()</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * methods, so that the destructors of these classes close the GIO</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * streams concerned, which helps exception safety (the attach()</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * method will also close any previous GIO stream). If this behaviour</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * is not wanted, pass 'false' instead to that argument.</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"> * C++ stream objects are not suitable for asynchronous input and</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * output. On sockets and pipes or other special devices, they may</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * block on a read or write until the read or write request has been</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * satisfied. In circumstances where asynchronous input and output is</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * wanted, it will be necessary to start a new thread in which to</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * carry out the input and output operations (which is what GIO does</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * behind the scenes on its asynchronous operations) or use the GIO</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * interfaces directly.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * Here are some examples of use:</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * // open file for input, another for output, and make the</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * // output file a gzipped copy of the input (gzipping a</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * // file doesn't get much easier than this)</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * Cgu::gistream input;</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * Cgu::gostream output;</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * Cgu::GobjHandle<GFile> file_in(g_file_new_for_path("filename"));</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * GFileInputStream* is = g_file_read(file_in, 0, 0);</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * if (is) </span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * input.attach(Cgu::GobjHandle<GInputStream>(G_INPUT_STREAM(is)), // takes ownership of 'is'</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * true);</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * else {</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * std::cerr << "Can't open file 'filename'" << std::endl;</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * return;</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Cgu::GobjHandle<GFile> file_out(g_file_new_for_path("filename.gz"));</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * GFileOutputStream* os = g_file_replace(file_out, 0, false,</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * G_FILE_CREATE_REPLACE_DESTINATION,</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * 0, 0);</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * if (os) {</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * output.attach(Cgu::GobjHandle<GOutputStream>(G_OUTPUT_STREAM(os)), // takes ownership of 'os'</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * true,</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * Cgu::GobjHandle<GConverter>(</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * G_CONVERTER(g_zlib_compressor_new(G_ZLIB_COMPRESSOR_FORMAT_GZIP, -1)))</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * );</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * else {</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * std::cerr << "Can't create file 'filename.gz'" << std::endl;</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * return;</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * // this does the copying, and is shorthand for creating your own buffer</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * // and calling std::istream::read() and std::ostream::write() on it</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * output << input.rdbuf();</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> *</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"> * // establish a TCP socket on localhost, listen for connections on port</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * // 1200 and receive whitespace-separated words for processing</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * using Cgu::GobjHandle;</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * GobjHandle<GInetAddress> i(g_inet_address_new_loopback(G_SOCKET_FAMILY_IPV4));</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * GobjHandle<GSocketAddress> a(g_inet_socket_address_new(i, 1200));</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * GobjHandle<GSocketListener> l(g_socket_listener_new());</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * gboolean success = g_socket_listener_add_address(l,</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * a,</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * G_SOCKET_TYPE_STREAM,</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * G_SOCKET_PROTOCOL_TCP,</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * 0, 0, 0);</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * if (!success) {</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * std::cerr << "Can't bind socket on localhost" << std::endl;</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * return;</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"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * GSocketConnection* c = g_socket_listener_accept(l, 0, 0, 0);</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * if (!c) {</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * std::cerr << "Can't listen on localhost" << std::endl;</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * return;</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * Cgu::giostream sock_strm(GobjHandle<GIOStream>(G_IO_STREAM(c)), true); // takes ownership of c</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * sock_strm.set_output_buffered(false);</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * std::cout << "Connection accepted" << std::endl;</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * std::string str;</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * while (sock_strm >> str) {</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * [ ... do something with the word in str ... ]</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * // acknowledge the client</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * sock_strm << "ACK\n";</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"> *</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * --------------------------------------------------------------------</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * // read line delimited text from a pipe until it is closed by the</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * // writer: assume 'fd' is the read file descriptor of the pipe</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * // (in real life you would probably want to use a Cgu::fdistream</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * // object in this usage and bypass GIO)</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * Cgu::gistream istrm(Cgu::GobjHandle<GInputStream>(g_unix_input_stream_new(fd, true)), true);</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * if (!istrm.get_gio_stream().get()) {</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * std::cerr << "Can't create gio file-descriptor input stream" << std::endl;</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * return;</span></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"> * std::string line;</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * while (std::getline(istrm, line)) {</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * [ ... do something with the read text ... ]</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @note 1. Users cannot (except by derivation) use the virtual</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * protected methods of the streambuffer classes, including xsgetn()</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * and xsputn(). Instead, if they want direct access to the</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * streambuffer other than through the gostream/gistream/giostream</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * methods (or their wide stream equivalents), they should use the</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * public forwarding functions provided by std::streambuf base class.</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @note 2. These streambuffers and stream objects are not copiable.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @note 3. The base glib requirement for the c++-gtk-utils library is</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * glib >= 2.10.0, but the gstreams component will only be available</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * if glib >= 2.16.0 is installed.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * Buffering</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * ---------</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * The classes implement buffering on input streams and (unless output</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * buffering is switched off) on output streams. They implement the</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * buffering internally and do not use GBufferedInputStream and</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * GBufferedOutputStream. This has a number of efficiency advantages</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * and also retains random access, on devices that support it, for</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * buffered streams (GBufferedInputStream and GBufferedOutputStream do</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * not do so). So far as concerns random access on GIOStream objects,</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * which are opened for both read and write, see</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @ref GioRandomAccessAnchor "giostream and random access"</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * The streambuf class provides a block read and write in xsgetn() and</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * xsputn(), which will be called by the read() and write() methods</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * (and some other output operators) inherited by (w)gistream,</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * (w)gostream and (w)giostream from std::basic_istream and</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * std::basic_ostream. They operate (after appropriately vacating and</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * resetting the buffers) by doing a block read and write directly to</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * and from the target, and are very efficient for large block reads</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * (those significantly exceeding the buffer size). If users want all</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * reads and writes to go through the buffers, by using</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * std::basic_streambuf<>::xsputn() and</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * std::basic_streambuf<>::xsgetn() then the symbol</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * CGU_GSTREAM_USE_STD_N_READ_WRITE can be defined. (libstdc++-3</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * provides efficient inbuilt versions of these std::basic_streambuf</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * functions for block reads not significantly larger than the buffer</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * size, provided output buffering has not been turned off by the</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * set_output_buffered() method of these classes.)</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * @b Note @b however that if CGU_GSTREAM_USE_STD_N_READ_WRITE is to</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * be defined, it is best to do this by textually amending the</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * installed gstream.h header file rather than by defining the symbol</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * in user code before that file is included. This will ensure that</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * all source files in a program which include the gstream.h header</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * are guaranteed to see the same definitions so that the C++</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * standard's one-definition-rule is complied with.</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * One possible case for defining that symbol is where the user wants</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * to use the tie() method of (w)gistream or (w)giostream (inherited</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * from std::basic_ios) to procure flushing of an output stream before</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * extraction from an input stream is made by (w)gistream::read() or</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * (w)giostream::read(). Such flushing might not occur where a call</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * to read() is made unless CGU_GSTREAM_USE_STD_N_READ_WRITE is</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * defined, because an implementation is permitted to defer such</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * flushing until underflow() occurs, and the block read by read(), as</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * forwarded to xsgetn(), will never invoke underflow() if that symbol</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * is not defined. (Having said that, any basic_istream</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * implementation which does defer output flushing until underflow()</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * is called makes tie() unusable anyway for a number of purposes,</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * because the time of flushing would become dependent on whether a</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * read request can be satisfied by what is already in the buffers.)</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * 4 characters are stored and available for putback. However, if the</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * symbol CGU_GSTREAM_USE_STD_N_READ_WRITE is not defined, then a call</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * to (w)gstreambuf::xsgetn() via (w)gistream::read() or</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * (w)giostream::read() with a request for less than 4 characters will</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * result in less than 4 characters available for putback (if these</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * block read methods obtain some characters but less than 4, only the</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * number of characters obtained by them is guaranteed to be available</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * for putback).</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * @anchor GioRandomAccessAnchor</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * giostream and random access</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * ---------------------------</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> <span class="comment"> * For GIO objects which implement GSeekable (which are GFileIOStream,</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * GFileInputStream, GFileOutputStream, GMemoryInputStream and</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * GMemoryOutputStream), the classes in this c++-gtk-utils library</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * implement the tellg(), tellp(), seekg() and seekp() random access</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * methods.</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * The presence of buffering does not impede this where a stream is</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * only opened for reading or only opened for writing. However, it</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * presents complications if the giostream or wgiostream classes are</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * used with a GFIleIOStream object (GFileIOStream objects are opened</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * for both read and write). Because the classes employ buffering of</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * input, and optional buffering of output, the logical file position</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * (the file position expected by the user from the reads and writes</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * she has made) will usually differ from the actual file position</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * seen by the underlying operating system. The gstreambuf class</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * provided by this library implements intelligent tying between input</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * and output streams for GFileIOStream objects which means that if</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * output has been made unbuffered by a call to</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * set_output_buffered(false) and no converter has been attached, all</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * reads and writes onto the file system from the same giostream</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * object will be made at the expected logical position.</span></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"> * This cannot be done by the gstreambuf class where the output stream</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * is set as buffered (the default). In that case, if the last</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * operation on a giostream or wgiostream object 'strm' was a read,</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * before the first write operation thereafter is made on it, the user</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * should call strm.seekg(strm.tellg()) or strm.seekp(strm.tellp())</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * (the two have the same effect), in order to synchronise the logical</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * and actual file positions, or if the user does not want to maintain</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * the current logical file position, make some other call to seekg()</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * or seekp() which does not comprise only seekg(0,</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * std::ios_base::cur) or seekp(0, std::ios_base::cur). Many</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * std::basic_iostream implementations, as inherited by</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * Cgu::giostream, will synchronise positions automatically on</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * seekable streams via their sentry objects in order to provide</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * support for buffered random access on their std::basic_fstream</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * class (gcc's libstdc++ library does this, for example), making</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * these steps unnecessary, but following these steps will provide</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * maximum portability. The same applies to the equivalent wide</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * stream classes.</span></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"> * If a GFileIOStream object attached to a giostream or wgiostream</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * object is not seekable (that is, can_seek() returns false), say</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * because an input or output converter has been attached or the</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * filesystem is a network file system, no random access may be</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * attempted. In particular, the tellg(), tellp(), seekg() and</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * seekp() methods will not work (they will return</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * pos_type(off_type(-1))). Furthermore, if a giostream or wgiostream</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * object which manages a GFileIOStream object (as opposed to a</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * socket) has a converter attached or is not seekable for some other</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * reason, then after a read has been made no further write may be</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * made using the same GFileIOStream object, so the use of converters</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * with giostream or wgiostream objects should generally be restricted</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * to use with sockets (GSocketConnection objects) only. Where</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * converters are used with files on a filesystem, it is best to use</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> * the gostream and gistream classes (or their wide stream</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * equivalents), and to close one stream before opening the other</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * where they address the same file.</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * None of these restrictions applies to GSocketConnection objects</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * obtained by a call to g_socket_listener_accept() or</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * g_socket_client_connect(), or obtained in some other way, as these</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * do not maintain file pointers. They can be attached to a giostream</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * or wgiostream object (with or without a converter) without any</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> * special precautions being taken, other than the normal step of</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * calling giostream::flush() (or using the std::flush manipulator) to</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * flush the output buffer to the socket if the user needs to know</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> * that that has happened (or setting output buffering off with the</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * set_output_buffered() method). In summary, on a socket, a read</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * does not automatically flush the output buffer: it is for the user</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * to do that.</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * Wide streams and endianness</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * ---------------------------</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"> 305</span> <span class="comment"> * This library provides typedef'ed instances of the template classes</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * for wchar_t, char16_t and char32_t characters. Unless a converter</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * is attached (for, say, UTF-32LE to UTF-32BE, or vice versa), with</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * these wide character classes wide characters are written out in the</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * native endian format of the writing machine. Whether or not a</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * converter from one endianness to another is attached, special steps</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * need to be taken if the text which is sent for output might be read</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * by machines of unknown endianness.</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * No such special steps are required where the wide character classes</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * are used with temporary files, pipes, fifos, unix domain sockets</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * and network sockets on localhost, because in those cases they will</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * be read by the same machine that writes; but they are required</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * where sockets communicate with other computers over a network or</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * when writing to files which may be distributed to and read by other</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * computers with different endianness.</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * Where wide characters are to be exported to other machines, one</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * useful approach is to convert to and from UTF-8 with</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * Utf8::uniwide_from_utf8(), Utf8::uniwide_to_utf8(),</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> * Utf8::wide_from_utf8() or Utf8::wide_to_utf8(), and to use</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * gostream/gistream/giostream with the converted text, or to attach a</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * converter for UTF-8, generated by GIO's g_charset_converter_new(),</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * directly to a wgostream, wgistream or wgiostream object (or their</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * char16_t and char32_t equivalents).</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * Instead of converting exported text to UTF-8, another approach is</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * to use a byte order marker (BOM) as the first character of the wide</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * stream output. UCS permits a BOM character to be inserted,</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * comprising static_cast<wchar_t>(0xfeff),</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * static_cast<char16_t>(0xfeff) or static_cast<char32_t>(0xfeff), at</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * the beginning of the output to the wide character stream. At the</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * receiving end, this will appear as 0xfffe (UTF-16) or 0xfffe0000</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * (UTF-32) to a big endian machine with 8 bit char type if the text</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * is little endian, or to a little endian machine with big endian</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * text, so signaling a need to undertake byte swapping of text read</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * from the stream. Another alternative is to label the physical</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * medium conveying the file as UTF-16LE, UTF-16BE, UTF-32LE or</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * UTF-32BE, as the case may be, in which case a BOM character should</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * not be prepended.</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * Where it is established by either means that the input stream</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * requires byte swapping, the wide character input stream and wide</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * character input streambuffer classes have a set_byteswap() member</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> * function which should be called on opening the input stream as soon</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * as it has been established that byte swapping is required. Once</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * this function has been called with an argument of 'true', all</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * further calls to stream functions which provide characters will</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * provide those characters with the correct native endianness.</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * Calling set_byteswap() on the narrow stream gistream, giostream and</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> * gstreambuf objects has no effect (byte order is irrelevant to</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * narrow streams).</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * Here is an example of such use in a case where sizeof(wchar_t) is</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * 4:</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * using Cgu::GobjHandle;</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * Cgu::wgistream input;</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * GobjHandle<GFile> file_in(g_file_new_for_path("filename"));</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> * GFileInputStream* is = g_file_read(file_in, 0, 0);</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> * if (is) </span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * input.attach(GobjHandle<GInputStream>(G_INPUT_STREAM(is)), true); // takes ownership of 'is'</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * else {</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * std::cerr << "Can't open file 'filename'"</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> * << std::endl;</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> * return;</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * wchar_t item;</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * input.get(item);</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * if (!input) {</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * std::cerr << "File 'filename' is empty" << std::endl;</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> * return;</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * if (item == static_cast<wchar_t>(0xfffe0000))</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * input.set_byteswap(true);</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> * else if (item != static_cast<wchar_t>(0xfeff)) {</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * // calling set_byteswap() will manipulate the buffers, so</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * // either call putback() before we call set_byteswap(), or</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * // call unget() instead</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> * input.putback(item);</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> * // the first character is not a BOM character so assume big endian</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> * // format, and byte swap if the local machine is little endian</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> * #if G_BYTE_ORDER == G_LITTLE_ENDIAN</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> * input.set_byteswap(true);</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * #endif</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> * [ ... do something with the input file ... ]</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> * Other wide stream issues</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> * ------------------------</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * basic_gostream, basic_gistream, basic_giostream and</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * basic_gstreambuf objects can be instantiated for any integer type</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * which has an appropriate traits class provided for it which has the</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * copy(), eof(), eq_int_type(), move(), not_eof() and to_int_type()</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * static member functions. The integer type could in fact have any</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * size, but the set_byteswap() methods for basic_gistream,</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * basic_giostream and basic_gstreambuf will only have an effect if</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * its size is either 2 or 4. Typedef'ed instances of the classes are</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * provided by the library for characters of type wchar_t, char16_t</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * and char32_t.</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> <span class="comment"> * gtkmm users</span></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"> * gtkmm/giomm does not provide C++ streams for GIO objects: instead,</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * it provides a literal function-for-function wrapping. However,</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * giomm users can use the stream classes provided by this library by</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * converting the relevant Glib::RefPtr object to a Cgu::GobjHandle</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * object. This can be done as follows:</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> * // Glib::RefPtr<Gio::InputStream> to Cgu::GobjHandle<GInputStream></span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> * inline</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> * Cgu::GobjHandle<GInputStream> giomm_input_convert(const Glib::RefPtr<Gio::InputStream>& in) {</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> * return Cgu::GobjHandle<GInputStream>(static_cast<GInputStream*>(g_object_ref(in.operator->()->gobj())));</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * // Glib::RefPtr<Gio::OutputStream> to Cgu::GobjHandle<GOutputStream></span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> * inline</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> * Cgu::GobjHandle<GOutputStream> giomm_output_convert(const Glib::RefPtr<Gio::OutputStream>& out) {</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * return Cgu::GobjHandle<GOutputStream>(static_cast<GOutputStream*>(g_object_ref(out.operator->()->gobj())));</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"> *</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> * // Glib::RefPtr<Gio::IOStream> to Cgu::GobjHandle<GIOStream></span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> * inline</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * Cgu::GobjHandle<GIOStream> giomm_io_convert(const Glib::RefPtr<Gio::IOStream>& io) {</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * return Cgu::GobjHandle<GIOStream>(static_cast<GIOStream*>(g_object_ref(io.operator->()->gobj())));</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> * }</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> <span class="comment"> * // example printing a text file to stdout with file opened with giomm</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> * Glib::RefPtr<Gio::File> file = Gio::File::create_for_path("filename");</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> * Glib::RefPtr<Gio::InputStream> is = file->read();</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> * Cgu::gistream filein(giomm_input_convert(is), true);</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> * std::string line;</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> * while (std::getline(filein, line)) {</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> * std::cout << line << '\n';</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> * @endcode</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"> 449</span> </div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="preprocessor">#ifndef CGU_GSTREAM_H</span></div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="preprocessor"></span><span class="preprocessor">#define CGU_GSTREAM_H</span></div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor">#include <glib.h></span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> </div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="preprocessor">#if defined(DOXYGEN_PARSING) || GLIB_CHECK_VERSION(2,16,0)</span></div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment">// see above for what this does</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment">//#define CGU_GSTREAM_USE_STD_N_READ_WRITE 1</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> </div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor">#include <istream></span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="preprocessor">#include <ostream></span></div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="preprocessor">#include <streambuf></span></div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="preprocessor">#include <algorithm></span></div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor">#include <cstddef></span></div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> </div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="preprocessor">#include <glib.h></span></div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="preprocessor">#include <glib-object.h></span></div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="preprocessor">#include <gio/gio.h></span></div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> </div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="preprocessor">#include <<a class="code" href="gobj__handle_8h.html">c++-gtk-utils/gobj_handle.h</a>></span></div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</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="l00473"></a><span class="lineno"> 473</span> <span class="preprocessor">#include <<a class="code" href="gerror__handle_8h.html">c++-gtk-utils/gerror_handle.h</a>></span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</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="l00475"></a><span class="lineno"> 475</span> </div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="keyword">namespace </span>Cgu {</div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> </div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment">The following convenience typedefs appear at the end of this file:</span></div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment">typedef basic_gstreambuf<char> gstreambuf;</span></div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment">typedef basic_gistream<char> gistream;</span></div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment">typedef basic_gostream<char> gostream;</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment">typedef basic_giostream<char> giostream;</span></div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment">typedef basic_gstreambuf<wchar_t> wgstreambuf;</span></div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment">typedef basic_gistream<wchar_t> wgistream;</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment">typedef basic_gostream<wchar_t> wgostream;</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment">typedef basic_giostream<wchar_t> wgiostream;</span></div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment">typedef basic_gstreambuf<char16_t> u16gstreambuf;</span></div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment">typedef basic_gistream<char16_t> u16gistream;</span></div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment">typedef basic_gostream<char16_t> u16gostream;</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment">typedef basic_giostream<char16_t> u16giostream;</span></div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment">typedef basic_gstreambuf<char32_t> u32gstreambuf;</span></div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment">typedef basic_gistream<char32_t> u32gistream;</span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment">typedef basic_gostream<char32_t> u32gostream;</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment">typedef basic_giostream<char32_t> u32giostream;</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> </div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"></span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * @headerfile gstream.h c++-gtk-utils/gstream.h</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> * @brief C++ stream buffer for GIO streams</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> * @sa gstreams</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * This class provides a stream buffer for interfacing with GIO</span></div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> * streams. It does the buffering for the basic_gostream,</span></div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> * basic_gistream and basic_giostream stream classes.</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> </div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="keyword">template</span> <<span class="keyword">class</span> <span class="keywordtype">char</span>T , <span class="keyword">class</span> Traits = std::<span class="keywordtype">char</span>_traits<<span class="keywordtype">char</span>T> ></div>
<div class="line"><a name="l00511"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html"> 511</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf</a>: <span class="keyword">public</span> std::basic_streambuf<charT, Traits> {</div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> </div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00514"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5"> 514</a></span>  <span class="keyword">typedef</span> charT <a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5">char_type</a>;</div>
<div class="line"><a name="l00515"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html#a668f181272138753188c64f20f1ce048"> 515</a></span>  <span class="keyword">typedef</span> Traits <a class="code" href="classCgu_1_1basic__gstreambuf.html#a668f181272138753188c64f20f1ce048">traits_type</a>;</div>
<div class="line"><a name="l00516"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html#ad04fb88f9512a5c665a5301b1b5abcca"> 516</a></span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> traits_type::int_type <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad04fb88f9512a5c665a5301b1b5abcca">int_type</a>;</div>
<div class="line"><a name="l00517"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html#a207b0c4fa70dd8baf433b2acc028f70b"> 517</a></span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> traits_type::pos_type <a class="code" href="classCgu_1_1basic__gstreambuf.html#a207b0c4fa70dd8baf433b2acc028f70b">pos_type</a>;</div>
<div class="line"><a name="l00518"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html#a322b80d2e098c4c6d1b337f0dbdd8ca2"> 518</a></span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> traits_type::off_type <a class="code" href="classCgu_1_1basic__gstreambuf.html#a322b80d2e098c4c6d1b337f0dbdd8ca2">off_type</a>;</div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> </div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a> input_stream;</div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a> output_stream;</div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a> io_stream;</div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> </div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  <span class="keywordtype">bool</span> manage;</div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  <span class="keywordtype">bool</span> byteswap;</div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  <span class="keywordtype">bool</span> seek_mismatch;</div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <span class="keywordtype">bool</span> seekable;</div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> </div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> output_buf_size = 1024; <span class="comment">// size of the data write buffer</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> putback_size = 4; <span class="comment">// size of read putback area</span></div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> input_buf_size = 1024; <span class="comment">// size of the data read buffer</span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> </div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="preprocessor">#if defined(CGU_USE_GLIB_MEMORY_SLICES_COMPAT) || defined(CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT)</span></div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="preprocessor"></span> <a class="code" href="classCgu_1_1ScopedHandle.html" title="This is a generic scoped class for managing the lifetime of objects allocated on freestore. ">ScopedHandle</a><<a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5">char_type</a>*,</div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <a class="code" href="classCgu_1_1GSliceFreeSize.html" title="A deleter functor for use as the second (Dealloc) template parameter of the SharedHandle, SharedLockHandle or ScopedHandle template classes, which calls glib's g_slice_free1(). ">GSliceFreeSize<(input_buf_size + putback_size) * sizeof(char_type)></a>> input_buffer;</div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  <a class="code" href="classCgu_1_1ScopedHandle.html" title="This is a generic scoped class for managing the lifetime of objects allocated on freestore. ">ScopedHandle</a><<a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5">char_type</a>*,</div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span>  <a class="code" href="classCgu_1_1GSliceFreeSize.html" title="A deleter functor for use as the second (Dealloc) template parameter of the SharedHandle, SharedLockHandle or ScopedHandle template classes, which calls glib's g_slice_free1(). ">GSliceFreeSize<output_buf_size * sizeof(char_type)></a>> output_buffer;</div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="preprocessor"></span> <a class="code" href="classCgu_1_1ScopedHandle.html">ScopedHandle<char_type*></a> input_buffer;</div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  <a class="code" href="classCgu_1_1ScopedHandle.html">ScopedHandle<char_type*></a> output_buffer;</div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> swap_element(<a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5">char_type</a>&);</div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a> find_base_input_stream(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a>&);</div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a> find_base_output_stream(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a>&);</div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  <span class="keywordtype">void</span> reset_input_buffer_pointers();</div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  <span class="keywordtype">int</span> flush_buffer();</div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  <span class="keywordtype">bool</span> wind_back_input_buffer();</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  <span class="keywordtype">bool</span> is_input_stored();</div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  <span class="keywordtype">bool</span> is_output_stored();</div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  <span class="keywordtype">void</span> set_input_error(GError*);</div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keywordtype">void</span> set_output_error(GError*);</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> </div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> * This method will not throw. This means that the input functions of</span></div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> * stream objects which have this streambuffer as a member will not</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> * throw unless the underlying functions of the std::basic_istream</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> * class throw, which they would not normally do unless they have been</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> * required to do so on failbit, badbit or eofbit being set by an</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> * explicit call to the exceptions() method of that class. This class</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> * does not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  <span class="keyword">virtual</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad04fb88f9512a5c665a5301b1b5abcca">int_type</a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#af3bda34750c3361db102cbf3e7ecfd72">underflow</a>();</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"></span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> * This method will not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> * access from multiple threads to the same stream object, and if that</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a9bbf35be20fe333f42b6e814ea337acd">sync</a>();</div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"></span></div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> * This method will not throw unless std::basic_streambuf<>::sputc()</span></div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> * throws, which it would not do on any sane implementation. This</span></div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> * means that the output functions of stream objects which have this</span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> * streambuffer as a member will not throw unless the underlying</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> * functions of the std::basic_ostream class throw, which they would</span></div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> * not normally do unless they have been required to do so on failbit,</span></div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> * badbit or eofbit being set by an explicit call to the exceptions()</span></div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> * method of that class. This class does not offer concurrent access</span></div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  <span class="keyword">virtual</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad04fb88f9512a5c665a5301b1b5abcca">int_type</a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a073b62514533f0a8f7907913f2f81c4f">overflow</a>(<a class="code" href="classCgu_1_1basic__gstreambuf.html#ad04fb88f9512a5c665a5301b1b5abcca">int_type</a>);</div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="preprocessor">#ifndef CGU_GSTREAM_USE_STD_N_READ_WRITE</span></div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="preprocessor"></span><span class="comment">/**</span></div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> * This method will not throw. This means that the input functions of</span></div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> * stream objects which have this streambuffer as a member will not</span></div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> * throw unless the underlying functions of the std::basic_istream</span></div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> * class throw, which they would not normally do unless they have been</span></div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> * required to do so on failbit, badbit or eofbit being set by an</span></div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> * explicit call to the exceptions() method of that class. This class</span></div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> * does not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  <span class="keyword">virtual</span> std::streamsize <a class="code" href="classCgu_1_1basic__gstreambuf.html#a96432cdad1e3a27cf5279f550ab1b50b">xsgetn</a>(<a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5">char_type</a>*, std::streamsize);</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">/**</span></div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> * This method will not throw. This means that the output functions</span></div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> * of stream objects which have this streambuffer as a member will not</span></div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> * throw unless the underlying functions of the std::basic_ostream</span></div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> * class throw, which they would not normally do unless they have been</span></div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> * required to do so on failbit, badbit or eofbit being set by an</span></div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> * explicit call to the exceptions() method of that class. This class</span></div>
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> * does not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  <span class="keyword">virtual</span> std::streamsize <a class="code" href="classCgu_1_1basic__gstreambuf.html#aa12a679d46bc81783204a56c64ba1af7">xsputn</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a1f989f68901ada47507464d4f9b99af5">char_type</a>*, std::streamsize);</div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="preprocessor"></span><span class="comment">/**</span></div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> * This method provides random access on GIO streams that implement</span></div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"> * GSeekable, so supporting the tellg(), tellp(), seekg() and seekp()</span></div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> * methods of the basic_gostream, basic_gistream and basic_giostream</span></div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> * classes. Any output buffers will be flushed and if the seek</span></div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> * succeeds any input buffers will be reset. This method does not</span></div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> * throw, but if it returns pos_type(off_type(-1)) to indicate</span></div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> * failure, it will cause the tellg(), tellp(), seekg() or seekp()</span></div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> * methods of the relevant stream class to throw</span></div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> * std::ios_base::failure if such an exception has been required by an</span></div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> * explicit call to the exceptions() method of that class (but not</span></div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> * otherwise). This class does not offer concurrent access from</span></div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> * multiple threads to the same stream object, and if that is required</span></div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> * users should provide their own synchronisation.</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="comment"> * @param off The offset to be applied to the 'way' argument when</span></div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="comment"> * seeking. It is a signed integer type, and on wide character</span></div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"> * streams is dimensioned as the number of wchar_t/char32_t/char16_t</span></div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment"> * units not the number of bytes (that is, it is</span></div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment"> * bytes/sizeof(char_type)).</span></div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"> * @param way The file position to which the 'off' argument is to be</span></div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"> * applied (either std::ios_base::beg, std::ios_base::cur or</span></div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> * std::ios_base::end).</span></div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> * @param m The type of GIO stream which must have been attached to</span></div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> * this streambuffer for this method to attempt a seek. For</span></div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"> * GInputStream the argument should have the std::ios_base::in bit</span></div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment"> * set, for GOutputStream it should have the std::ios_base::out bit</span></div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> * set and for GIOStream it should have either (or both) set.</span></div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"> * Provided the relevant bit is set, it doesn't matter if others are</span></div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"> * also set. However if, with a GIOStream object, both the</span></div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"> * std::ios_base::in and std::ios_base::out bits are set, a seek on</span></div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"> * both input and output streams will be attempted, unless the 'way'</span></div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"> * argument is std::ios_base::cur, in which case a seek on the output</span></div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> * stream only will be attempted. (Note that the only GIOStream which</span></div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> * at present supports seeking is GFileIOStream, and because</span></div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> * filesystem files only have one file pointer, which is used for both</span></div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> * input and output, both input seeking and output seeking have the</span></div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> * same result and affect both streams.) As the tellg() and seekg()</span></div>
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> * stream methods only pass std::ios_base::in, and the tellp() and</span></div>
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> * seekp() methods only std::ios_base::out, these will always produce</span></div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> * the expected result, and for GIOStream streams tellg() will be</span></div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> * indistinguishable in effect from tellp(), and seekg() from seekp().</span></div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> * @return If the seek succeeds, a std::char_traits<T>::pos_type</span></div>
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> * object representing the new stream position of the streambuffer</span></div>
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"> * after the seek. (This type is std::streampos for narrow character</span></div>
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> * (char) streams, std::wstreampos for wide character (wchar_t)</span></div>
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> * streams, std::u16streampos for the char16_t type and</span></div>
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> * std::u32streampos for the char32_t type.) If the seek failed,</span></div>
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> * pos_type(off_type(-1)) is returned. If a seek is made on a</span></div>
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> * GIOStream object with both std::ios_base::in and std::ios_base::out</span></div>
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> * set and a 'way' argument of std::ios_base::beg or</span></div>
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> * std::ios_base::end, the result of the seek which succeeds is</span></div>
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> * returned, or if both succeed, the result of the output seek is</span></div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> * returned. (Note that the only GIOStream which at present supports</span></div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> * seeking is GFileIOStream, and because files only have one file</span></div>
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> * pointer, which is used for both input and output, both input</span></div>
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> * seeking and output seeking have the same result and affect both</span></div>
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> * streams.)</span></div>
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>  <span class="keyword">virtual</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a207b0c4fa70dd8baf433b2acc028f70b">pos_type</a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a38e6571e08ca1a4e5986a435c80c1e68">seekoff</a>(<a class="code" href="classCgu_1_1basic__gstreambuf.html#a322b80d2e098c4c6d1b337f0dbdd8ca2">off_type</a> off,</div>
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>  std::ios_base::seekdir way,</div>
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  std::ios_base::openmode m = std::ios_base::in | std::ios_base::out);</div>
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment"></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"> * This method provides random access on GIO streams that implement</span></div>
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment"> * GSeekable, so supporting the seekg() and seekp() methods of the</span></div>
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"> * basic_gostream, basic_gistream and basic_giostream classes. It is</span></div>
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> * equivalent to seekoff(off_type(p), std::ios_base::beg, m). Any</span></div>
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> * output buffers will be flushed and if the seek succeeds any input</span></div>
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> * buffers will be reset. This method does not throw, but if it</span></div>
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> * returns pos_type(off_type(-1)) to indicate failure, it will cause</span></div>
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> * the seekg() or seekp() methods of the relevant stream class to</span></div>
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> * throw std::ios_base::failure if such an exception has been required</span></div>
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> * by an explicit call to the exceptions() method of that class (but</span></div>
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"> * not otherwise). This class does not offer concurrent access from</span></div>
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> * multiple threads to the same stream object, and if that is required</span></div>
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> * users should provide their own synchronisation.</span></div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment"> * @param p The absolute position to which the seek is to be made,</span></div>
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment"> * obtained by a previous call to seekoff() or to this method.</span></div>
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment"> * @param m The type of GIO stream which must have been attached to</span></div>
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> * this streambuffer for this method to attempt a seek. For</span></div>
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment"> * GInputStream the argument should have the std::ios_base::in bit</span></div>
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"> * set, for GOutputStream it should have the std::ios_base::out bit</span></div>
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"> * set and for GIOStream it should have either (or both) set.</span></div>
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> * Provided the relevant bit is set, it doesn't matter if others are</span></div>
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> * also set. However if, with a GIOStream object, both the</span></div>
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> * std::ios_base::in and std::ios_base::out bits are set, a seek on</span></div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment"> * both input and output streams will be attempted. (Note that the</span></div>
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment"> * only GIOStream which at present supports seeking is GFileIOStream,</span></div>
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"> * and because filesystem files only have one file pointer, which is</span></div>
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment"> * used for both input and output, both input seeking and output</span></div>
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"> * seeking have the same result and affect both streams.) As the</span></div>
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"> * seekg() stream method only passes std::ios_base::in, and the</span></div>
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> * seekp() method only std::ios_base::out, these will always produce</span></div>
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment"> * the expected result, and seekg() will be indistinguishable in</span></div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"> * effect from seekp().</span></div>
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment"> * @return If the seek succeeds, a std::char_traits<T>::pos_type</span></div>
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment"> * object representing the new stream position of the streambuffer</span></div>
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment"> * after the seek. (This type is std::streampos for narrow character</span></div>
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment"> * (char) streams, std::wstreampos for wide character (wchar_t)</span></div>
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"> * streams, std::u16streampos for the char16_t type and</span></div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> * std::u32streampos for the char32_t type.) If the seek failed,</span></div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> * pos_type(off_type(-1)) is returned.</span></div>
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span>  <span class="keyword">virtual</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a207b0c4fa70dd8baf433b2acc028f70b">pos_type</a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a8de720e5d02118aac0b669a259d1270f">seekpos</a>(<a class="code" href="classCgu_1_1basic__gstreambuf.html#a207b0c4fa70dd8baf433b2acc028f70b">pos_type</a> p,</div>
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span>  std::ios_base::openmode m = std::ios_base::in | std::ios_base::out);</div>
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span> </div>
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="keyword">public</span>:<span class="comment"></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> <span class="comment"> * This class cannot be copied. The copy constructor is deleted.</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>  <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad88a6c2ad4470e7a888fbf7609b613d8">basic_gstreambuf</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"></span></div>
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"> * This class cannot be copied. The copy assignment operator is</span></div>
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="comment"> * deleted.</span></div>
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf</a>& <a class="code" href="classCgu_1_1basic__gstreambuf.html#a5b3e310dd8935072cac4c469853007da">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="comment"></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> <span class="comment"> * The default constructor: the GIO stream is attached later using the</span></div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="comment"> * attach_stream() method. It will not throw unless the default</span></div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="comment"> * constructor of std::basic_streambuf throws. This class does not</span></div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad88a6c2ad4470e7a888fbf7609b613d8">basic_gstreambuf</a>();</div>
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"></span></div>
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment"> * The constructor taking a GIO input stream. This class does not</span></div>
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment"> * @param input_stream_ A GIO input stream to be attached to the</span></div>
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment"> * streambuffer. If the caller wants the input stream to survive</span></div>
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment"> * this class's destruction or a call to close_stream() or</span></div>
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment"> * attach_stream(), the caller should keep a separate GobjHandle</span></div>
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="comment"> * object which references the stream (obtained by, say, calling</span></div>
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="comment"> * get_istream()) and pass 'manage_' as false. If this is a</span></div>
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment"> * GFilterInputStream object (that is, a GBufferedInputStream or</span></div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment"> * GConverterInputStream stream), only the underlying base input</span></div>
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"> * stream will be attached and the other higher level streams will be</span></div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"> * closed (buffering of input streams is always provided by this C++</span></div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment"> * streambuffer, and converting is controlled solely by the</span></div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"> * 'converter_' argument).</span></div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment"> * @param manage_ Whether the streambuffer should call</span></div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment"> * g_input_stream_close() on the stream in its destructor or when</span></div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> * another stream is attached. Passing 'true' is usually what is</span></div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment"> * wanted - 'false' only makes sense if the caller keeps a separate</span></div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment"> * GobjHandle object which references the stream to keep it alive</span></div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment"> * (obtained by, say, calling get_istream()). Unlike its fdstreams</span></div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="comment"> * equivalent, this parameter does not have a default value of</span></div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="comment"> * 'true': this is partly to make it less likely that a converter is</span></div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment"> * passed to this argument by mistake (that would not normally cause</span></div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment"> * a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="comment"> * partly because, given a GInputStream* p, the construction</span></div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="comment"> * \"Cgu::gstreambuf str(Cgu::GobjHandle<GInputStream>(p));\"</span></div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment"> * without an additional argument or additional parentheses (or the</span></div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment"> * use of uniform initializer syntax using braces) would cause a</span></div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> * compiler error as it would be interpreted as a function</span></div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"> * declaration.</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"> * @param converter_ A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment"> * @exception std::bad_alloc This constructor will throw</span></div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws on</span></div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="comment"> * such exhaustion (unless the library has been installed using the</span></div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="comment"> * obtain memory from the operating system). No other exception will</span></div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment"> * be thrown unless the constructor of std::basic_streambuf throws.</span></div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> * seekable even if it otherwise would be, so tellg() and seekg()</span></div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad88a6c2ad4470e7a888fbf7609b613d8">basic_gstreambuf</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a>& input_stream_,</div>
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span>  <span class="keywordtype">bool</span> manage_,</div>
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>());</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"> * The constructor taking a GIO output stream. This class does not</span></div>
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> * @param output_stream_ A GIO output stream to be attached to the</span></div>
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment"> * streambuffer. If the caller wants the output stream to survive</span></div>
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment"> * this class's destruction or a call to close_stream() or</span></div>
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span> <span class="comment"> * attach_stream(), the caller should keep a separate GobjHandle</span></div>
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment"> * object which references the stream (obtained by, say, calling</span></div>
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment"> * get_ostream()) and pass 'manage_' as false. If this is a</span></div>
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment"> * GFilterOutputStream object (that is, a GBufferedOutputStream,</span></div>
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment"> * GConverterOutputStream or GDataOutputStream stream), only the</span></div>
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span> <span class="comment"> * underlying base output stream will be attached and the other</span></div>
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="comment"> * higher level streams will be closed (buffering and converting are</span></div>
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="comment"> * controlled solely by the set_output_buffered() method and</span></div>
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="comment"> * 'converter_' argument).</span></div>
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="comment"> * @param manage_ Whether the streambuffer should call</span></div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span> <span class="comment"> * g_output_stream_close() on the stream in its destructor or when</span></div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="comment"> * another stream is attached. Passing 'true' is usually what is</span></div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span> <span class="comment"> * wanted, and is particularly relevant on output streams because</span></div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment"> * unless g_output_stream_close() is called, GIO may not commit to</span></div>
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment"> * disk - 'false' only makes sense if the caller keeps a separate</span></div>
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"> * GobjHandle object which references the stream to keep it alive</span></div>
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="comment"> * (obtained by, say, calling get_ostream()). Unlike its fdstreams</span></div>
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment"> * equivalent, this parameter does not have a default value of</span></div>
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment"> * 'true': this is partly to make it less likely that a converter is</span></div>
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment"> * passed to this argument by mistake (that would not normally cause</span></div>
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"> * a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l00846"></a><span class="lineno"> 846</span> <span class="comment"> * partly because, given a GOutputStream* p, the construction</span></div>
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span> <span class="comment"> * \"Cgu::gstreambuf str(Cgu::GobjHandle<GOutputStream>(p));\"</span></div>
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span> <span class="comment"> * without an additional argument or additional parentheses (or the</span></div>
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span> <span class="comment"> * use of uniform initializer syntax using braces) would cause a</span></div>
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment"> * compiler error as it would be interpreted as a function</span></div>
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span> <span class="comment"> * declaration.</span></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"> * @param converter_ A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"> * @exception std::bad_alloc This constructor will throw</span></div>
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws on</span></div>
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment"> * such exhaustion (unless the library has been installed using the</span></div>
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment"> * obtain memory from the operating system). No other exception will</span></div>
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment"> * be thrown unless the constructor of std::basic_streambuf throws.</span></div>
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment"> * seekable even if it otherwise would be, so tellp() and seekp()</span></div>
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad88a6c2ad4470e7a888fbf7609b613d8">basic_gstreambuf</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a>& output_stream_,</div>
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span>  <span class="keywordtype">bool</span> manage_,</div>
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>());</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 constructor taking a GIO input-output stream. This class does</span></div>
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="comment"> * not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment"> * @param io_stream_ A GIO input-output stream to be attached to the</span></div>
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment"> * streambuffer. If the caller wants the stream to survive this</span></div>
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment"> * class's destruction or a call to close_stream() or</span></div>
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment"> * attach_stream(), the caller should keep a separate GobjHandle</span></div>
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment"> * object which references the stream (obtained by, say, calling</span></div>
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="comment"> * get_iostream()) and pass 'manage_' as false.</span></div>
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span> <span class="comment"> * @param manage_ Whether the streambuffer should call</span></div>
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="comment"> * g_io_stream_close() on the stream in its destructor or when</span></div>
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="comment"> * another stream is attached. Passing 'true' is usually what is</span></div>
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="comment"> * wanted, and is particularly relevant on output streams because</span></div>
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="comment"> * unless g_io_stream_close() is called, GIO may not commit to disk -</span></div>
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment"> * 'false' only makes sense if the caller keeps a separate GobjHandle</span></div>
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment"> * object which references the stream to keep it alive (obtained by,</span></div>
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="comment"> * say, calling get_iostream()). Unlike its fdstreams equivalent,</span></div>
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="comment"> * this parameter does not have a default value of 'true': this is</span></div>
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="comment"> * partly to make it less likely that a converter is passed to this</span></div>
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="comment"> * argument by mistake (that would not normally cause a compiler</span></div>
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="comment"> * warning because GobjHandle has a type conversion operator</span></div>
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="comment"> * providing the underlying C object by pointer, so GobjHandles are</span></div>
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="comment"> * type convertible to pointers, and such a pointer will in turn</span></div>
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span> <span class="comment"> * provide a type match with a bool argument); and partly because,</span></div>
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span> <span class="comment"> * given a GIOStream* p, the construction \"Cgu::gstreambuf</span></div>
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span> <span class="comment"> * str(Cgu::GobjHandle<GIOStream>(p));\" without an additional</span></div>
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="comment"> * argument or additional parentheses (or the use of uniform</span></div>
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="comment"> * initializer syntax using braces) would cause a compiler error as</span></div>
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="comment"> * it would be interpreted as a function declaration.</span></div>
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="comment"> * @param input_converter_ A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="comment"> * @param output_converter_ A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span> <span class="comment"> * @exception std::bad_alloc This constructor will throw</span></div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws on</span></div>
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="comment"> * such exhaustion (unless the library has been installed using the</span></div>
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="comment"> * obtain memory from the operating system). No other exception will</span></div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="comment"> * be thrown unless the constructor of std::basic_streambuf throws.</span></div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment"> * seekable even if it otherwise would be, so tellg(), tellp(),</span></div>
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment"> * seekg() and seekp() will no longer work (they will return</span></div>
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment"> * pos_type(off_type(-1)). If the stream to which a converter has</span></div>
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment"> * been attached represents a file on the file system (rather than a</span></div>
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment"> * socket), after a read has been made, no further write may be made</span></div>
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment"> * using the same GFileIOStream object. These restrictions do not</span></div>
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment"> * apply to sockets (which are not seekable) so the use of converters</span></div>
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment"> * with input-output streams (GIOStream) should generally be</span></div>
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment"> * restricted to sockets.</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>  <a class="code" href="classCgu_1_1basic__gstreambuf.html#ad88a6c2ad4470e7a888fbf7609b613d8">basic_gstreambuf</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a>& io_stream_,</div>
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span>  <span class="keywordtype">bool</span> manage_,</div>
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& input_converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>(),</div>
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& output_converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>());</div>
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span>  <span class="comment"></span></div>
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span> <span class="comment"> * The destructor does not throw.</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="keyword">virtual</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a1b4bd802439988f6cecb0c610f1190c5">~basic_gstreambuf</a>();</div>
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment"></span></div>
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment"> * Attach a new GIO input stream to the streambuffer (and close any</span></div>
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment"> * GIO stream at present managed by it). In the case of wide</span></div>
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment"> * character input streams, it also switches off byte swapping, if it</span></div>
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment"> * was previously on. This class does not offer concurrent access</span></div>
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span> <span class="comment"> * @param input_stream_ The GIO input stream to be attached to the</span></div>
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span> <span class="comment"> * streambuffer. If the caller wants the input stream to survive a</span></div>
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span> <span class="comment"> * subsequent call to close_stream() or attach_stream() or this</span></div>
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span> <span class="comment"> * class's destruction, the caller should keep a separate GobjHandle</span></div>
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span> <span class="comment"> * object which references the stream (obtained by, say, calling</span></div>
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span> <span class="comment"> * get_istream()) and pass 'manage_' as false. If this is a</span></div>
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span> <span class="comment"> * GFilterInputStream object (that is, a GBufferedInputStream or</span></div>
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span> <span class="comment"> * GConverterInputStream stream), only the underlying base input</span></div>
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment"> * stream will be attached and the other higher level streams will be</span></div>
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment"> * closed (buffering of input streams is always provided by this C++</span></div>
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment"> * streambuffer, and converting is controlled solely by the</span></div>
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span> <span class="comment"> * 'converter_' argument).</span></div>
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span> <span class="comment"> * @param manage_ Whether the streambuffer should call</span></div>
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="comment"> * g_input_stream_close() on the stream in its destructor or when</span></div>
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span> <span class="comment"> * another stream is attached. Passing 'true' is usually what is</span></div>
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span> <span class="comment"> * wanted - 'false' only makes sense if the caller keeps a separate</span></div>
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment"> * GobjHandle object which references the stream to keep it alive</span></div>
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"> * (obtained by, say, calling get_istream()). Unlike its fdstreams</span></div>
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"> * equivalent, this parameter does not have a default value of</span></div>
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"> * 'true': this is partly to make it less likely that a converter is</span></div>
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"> * passed to this argument by mistake (that would not normally cause</span></div>
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span> <span class="comment"> * a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment"> * partly to maintain compatibility with the constructor's interface,</span></div>
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> * which has separate syntactic constraints.</span></div>
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment"> * @param converter_ A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</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"> 989</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span> <span class="comment"> * memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span> <span class="comment"> * obtain memory from the operating system).</span></div>
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span> <span class="comment"> * seekable even if it otherwise would be, so tellg() and seekg()</span></div>
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a64dac63a5dada97ebf9774d68e4aa41c">attach_stream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a>& input_stream_,</div>
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>  <span class="keywordtype">bool</span> manage_,</div>
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>());</div>
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="comment"></span></div>
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="comment"> * Attach a new GIO output stream to the streambuffer (and close any</span></div>
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span> <span class="comment"> * GIO stream at present managed by it). If output buffering was</span></div>
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span> <span class="comment"> * previously switched off, it is switched back on again. This class</span></div>
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span> <span class="comment"> * does not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span> <span class="comment"> * @param output_stream_ The GIO output stream to be attached to the</span></div>
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span> <span class="comment"> * streambuffer. If the caller wants the output stream to survive a</span></div>
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span> <span class="comment"> * subsequent call to close_stream() or attach_stream() or this</span></div>
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span> <span class="comment"> * class's destruction, the caller should keep a separate GobjHandle</span></div>
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span> <span class="comment"> * object which references the stream (obtained by, say, calling</span></div>
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span> <span class="comment"> * get_ostream()) and pass 'manage_' as false. If this is a</span></div>
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span> <span class="comment"> * GFilterOutputStream object (that is, a GBufferedOutputStream,</span></div>
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span> <span class="comment"> * GConverterOutputStream or GDataOutputStream stream), only the</span></div>
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span> <span class="comment"> * underlying base output stream will be attached and the other</span></div>
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span> <span class="comment"> * higher level streams will be closed (buffering and converting are</span></div>
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment"> * controlled solely by the set_output_buffered() method and</span></div>
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> <span class="comment"> * 'converter_' argument).</span></div>
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span> <span class="comment"> * @param manage_ Whether the streambuffer should call</span></div>
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span> <span class="comment"> * g_output_stream_close() on the stream in its destructor or when</span></div>
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span> <span class="comment"> * another stream is attached. Passing 'true' is usually what is</span></div>
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span> <span class="comment"> * wanted, and is particularly relevant on output streams because</span></div>
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span> <span class="comment"> * unless g_output_stream_close() is called, GIO may not commit to</span></div>
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> <span class="comment"> * disk - 'false' only makes sense if the caller keeps a separate</span></div>
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span> <span class="comment"> * GobjHandle object which references the stream to keep it alive</span></div>
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span> <span class="comment"> * (obtained by, say, calling get_ostream()). Unlike its fdstreams</span></div>
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span> <span class="comment"> * equivalent, this parameter does not have a default value of</span></div>
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span> <span class="comment"> * 'true': this is partly to make it less likely that a converter is</span></div>
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span> <span class="comment"> * passed to this argument by mistake (that would not normally cause</span></div>
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span> <span class="comment"> * a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span> <span class="comment"> * partly to maintain compatibility with the constructor's interface,</span></div>
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment"> * which has separate syntactic constraints.</span></div>
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment"> * @param converter_ A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01048"></a><span class="lineno"> 1048</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span> <span class="comment"> * memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01052"></a><span class="lineno"> 1052</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span> <span class="comment"> * obtain memory from the operating system).</span></div>
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span> <span class="comment"> * seekable even if it otherwise would be, so tellp() and seekp()</span></div>
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a64dac63a5dada97ebf9774d68e4aa41c">attach_stream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a>& output_stream_,</div>
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>  <span class="keywordtype">bool</span> manage_,</div>
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>());</div>
<div class="line"><a name="l01063"></a><span class="lineno"> 1063</span> <span class="comment"></span></div>
<div class="line"><a name="l01064"></a><span class="lineno"> 1064</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01065"></a><span class="lineno"> 1065</span> <span class="comment"> * Attach a new GIO input-output stream to the streambuffer (and</span></div>
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span> <span class="comment"> * close any GIO stream at present managed by it). If output</span></div>
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span> <span class="comment"> * buffering was previously switched off, it is switched back on</span></div>
<div class="line"><a name="l01068"></a><span class="lineno"> 1068</span> <span class="comment"> * again. In the case of wide character input-output streams, it</span></div>
<div class="line"><a name="l01069"></a><span class="lineno"> 1069</span> <span class="comment"> * also switches off byte swapping on input, if it was previously on.</span></div>
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span> <span class="comment"> * This class does not offer concurrent access from multiple threads</span></div>
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span> <span class="comment"> * to the same stream object, and if that is required users should</span></div>
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span> <span class="comment"> * provide their own synchronisation.</span></div>
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01074"></a><span class="lineno"> 1074</span> <span class="comment"> * @param io_stream_ The GIO input-output stream to be attached to</span></div>
<div class="line"><a name="l01075"></a><span class="lineno"> 1075</span> <span class="comment"> * the streambuffer. If the caller wants the stream to survive a</span></div>
<div class="line"><a name="l01076"></a><span class="lineno"> 1076</span> <span class="comment"> * subsequent call to close_stream() or attach_stream() or this</span></div>
<div class="line"><a name="l01077"></a><span class="lineno"> 1077</span> <span class="comment"> * class's destruction, the caller should keep a separate GobjHandle</span></div>
<div class="line"><a name="l01078"></a><span class="lineno"> 1078</span> <span class="comment"> * object which references the stream (obtained by, say, calling</span></div>
<div class="line"><a name="l01079"></a><span class="lineno"> 1079</span> <span class="comment"> * get_iostream()) and pass 'manage_' as false.</span></div>
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01081"></a><span class="lineno"> 1081</span> <span class="comment"> * @param manage_ Whether the streambuffer should call</span></div>
<div class="line"><a name="l01082"></a><span class="lineno"> 1082</span> <span class="comment"> * g_io_stream_close() on the stream in its destructor or when</span></div>
<div class="line"><a name="l01083"></a><span class="lineno"> 1083</span> <span class="comment"> * another stream is attached. Passing 'true' is usually what is</span></div>
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span> <span class="comment"> * wanted, and is particularly relevant on output streams because</span></div>
<div class="line"><a name="l01085"></a><span class="lineno"> 1085</span> <span class="comment"> * unless g_io_stream_close() is called, GIO may not commit to disk -</span></div>
<div class="line"><a name="l01086"></a><span class="lineno"> 1086</span> <span class="comment"> * 'false' only makes sense if the caller keeps a separate GobjHandle</span></div>
<div class="line"><a name="l01087"></a><span class="lineno"> 1087</span> <span class="comment"> * object which references the stream to keep it alive (obtained by,</span></div>
<div class="line"><a name="l01088"></a><span class="lineno"> 1088</span> <span class="comment"> * say, calling get_iostream()). Unlike its fdstreams equivalent,</span></div>
<div class="line"><a name="l01089"></a><span class="lineno"> 1089</span> <span class="comment"> * this parameter does not have a default value of 'true': this is</span></div>
<div class="line"><a name="l01090"></a><span class="lineno"> 1090</span> <span class="comment"> * partly to make it less likely that a converter is passed to this</span></div>
<div class="line"><a name="l01091"></a><span class="lineno"> 1091</span> <span class="comment"> * argument by mistake (that would not normally cause a compiler</span></div>
<div class="line"><a name="l01092"></a><span class="lineno"> 1092</span> <span class="comment"> * warning because GobjHandle has a type conversion operator</span></div>
<div class="line"><a name="l01093"></a><span class="lineno"> 1093</span> <span class="comment"> * providing the underlying C object by pointer, so GobjHandles are</span></div>
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="comment"> * type convertible to pointers, and such a pointer will in turn</span></div>
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> <span class="comment"> * provide a type match with a bool argument); and partly to maintain</span></div>
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="comment"> * compatibility with the constructor's interface, which has separate</span></div>
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> <span class="comment"> * syntactic constraints.</span></div>
<div class="line"><a name="l01098"></a><span class="lineno"> 1098</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01099"></a><span class="lineno"> 1099</span> <span class="comment"> * @param input_converter_ A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l01100"></a><span class="lineno"> 1100</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l01101"></a><span class="lineno"> 1101</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l01102"></a><span class="lineno"> 1102</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01103"></a><span class="lineno"> 1103</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span> <span class="comment"> * @param output_converter_ A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l01105"></a><span class="lineno"> 1105</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span> <span class="comment"> * memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> <span class="comment"> * obtain memory from the operating system).</span></div>
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> <span class="comment"> * seekable even if it otherwise would be, so tellg(), tellp(),</span></div>
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span> <span class="comment"> * seekg() and seekp() will no longer work (they will return</span></div>
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span> <span class="comment"> * pos_type(off_type(-1)). If the stream to which a converter has</span></div>
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span> <span class="comment"> * been attached represents a file on the file system (rather than a</span></div>
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> <span class="comment"> * socket), after a read has been made, no further write may be made</span></div>
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span> <span class="comment"> * using the same GFileIOStream object. These restrictions do not</span></div>
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> <span class="comment"> * apply to sockets (which are not seekable) so the use of converters</span></div>
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span> <span class="comment"> * with input-output streams (GIOStream) should generally be</span></div>
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span> <span class="comment"> * restricted to sockets.</span></div>
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a64dac63a5dada97ebf9774d68e4aa41c">attach_stream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a>& io_stream_,</div>
<div class="line"><a name="l01128"></a><span class="lineno"> 1128</span>  <span class="keywordtype">bool</span> manage_,</div>
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& input_converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>(),</div>
<div class="line"><a name="l01130"></a><span class="lineno"> 1130</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& output_converter_ = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>());</div>
<div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> </div>
<div class="line"><a name="l01132"></a><span class="lineno"> 1132</span> <span class="comment"></span></div>
<div class="line"><a name="l01133"></a><span class="lineno"> 1133</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01134"></a><span class="lineno"> 1134</span> <span class="comment"> * Call g_input_stream_close(), g_output_stream_close() or</span></div>
<div class="line"><a name="l01135"></a><span class="lineno"> 1135</span> <span class="comment"> * g_io_stream_close(), as the case may be, on the GIO stream at</span></div>
<div class="line"><a name="l01136"></a><span class="lineno"> 1136</span> <span class="comment"> * present attached to the streambuffer (if any), and release the</span></div>
<div class="line"><a name="l01137"></a><span class="lineno"> 1137</span> <span class="comment"> * streambuffer's reference to that stream (the reference will be</span></div>
<div class="line"><a name="l01138"></a><span class="lineno"> 1138</span> <span class="comment"> * released even if an error arose in closing the stream). If the</span></div>
<div class="line"><a name="l01139"></a><span class="lineno"> 1139</span> <span class="comment"> * caller wants the GIO stream to survive the call to this method</span></div>
<div class="line"><a name="l01140"></a><span class="lineno"> 1140</span> <span class="comment"> * (albeit in a closed state), the caller should, before the call is</span></div>
<div class="line"><a name="l01141"></a><span class="lineno"> 1141</span> <span class="comment"> * made, keep a separate GobjHandle object which references the</span></div>
<div class="line"><a name="l01142"></a><span class="lineno"> 1142</span> <span class="comment"> * stream. This method does not throw. This class does not offer</span></div>
<div class="line"><a name="l01143"></a><span class="lineno"> 1143</span> <span class="comment"> * concurrent access from multiple threads to the same stream object,</span></div>
<div class="line"><a name="l01144"></a><span class="lineno"> 1144</span> <span class="comment"> * and if that is required users should provide their own</span></div>
<div class="line"><a name="l01145"></a><span class="lineno"> 1145</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01146"></a><span class="lineno"> 1146</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01147"></a><span class="lineno"> 1147</span> <span class="comment"> * @return true if the close succeeded, false if an error arose</span></div>
<div class="line"><a name="l01148"></a><span class="lineno"> 1148</span> <span class="comment"> * (including in a case where no GIO stream has been attached or it</span></div>
<div class="line"><a name="l01149"></a><span class="lineno"> 1149</span> <span class="comment"> * has already been closed).</span></div>
<div class="line"><a name="l01150"></a><span class="lineno"> 1150</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01151"></a><span class="lineno"> 1151</span>  <span class="keywordtype">bool</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#af88a11e4103c82ccb5aad9c88e46529b">close_stream</a>();</div>
<div class="line"><a name="l01152"></a><span class="lineno"> 1152</span> <span class="comment"></span></div>
<div class="line"><a name="l01153"></a><span class="lineno"> 1153</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01154"></a><span class="lineno"> 1154</span> <span class="comment"> * Get the GIO input stream at present attached to the streambuffer</span></div>
<div class="line"><a name="l01155"></a><span class="lineno"> 1155</span> <span class="comment"> * (if any), by GobjHandle. If a GOutputStream object rather than a</span></div>
<div class="line"><a name="l01156"></a><span class="lineno"> 1156</span> <span class="comment"> * GInputStream or GIOStream object has been attached (or no stream</span></div>
<div class="line"><a name="l01157"></a><span class="lineno"> 1157</span> <span class="comment"> * has been attached) or it has been closed, then this method will</span></div>
<div class="line"><a name="l01158"></a><span class="lineno"> 1158</span> <span class="comment"> * return an empty GobjHandle object. If a GIOStream object has been</span></div>
<div class="line"><a name="l01159"></a><span class="lineno"> 1159</span> <span class="comment"> * attached, this streambuffer's maintained GInputStream object will</span></div>
<div class="line"><a name="l01160"></a><span class="lineno"> 1160</span> <span class="comment"> * be returned, which may be a converting stream manufactured from</span></div>
<div class="line"><a name="l01161"></a><span class="lineno"> 1161</span> <span class="comment"> * the GInputStream object maintained by the GIOStream object.</span></div>
<div class="line"><a name="l01162"></a><span class="lineno"> 1162</span> <span class="comment"> * Retaining the return value will cause the stream to survive a</span></div>
<div class="line"><a name="l01163"></a><span class="lineno"> 1163</span> <span class="comment"> * subsequent call to attach_stream() or the destruction of this</span></div>
<div class="line"><a name="l01164"></a><span class="lineno"> 1164</span> <span class="comment"> * object. The return value may be a different stream from the one</span></div>
<div class="line"><a name="l01165"></a><span class="lineno"> 1165</span> <span class="comment"> * originally passed to this object's constructor or to attach(). It</span></div>
<div class="line"><a name="l01166"></a><span class="lineno"> 1166</span> <span class="comment"> * will be different if a converter has been attached to it. This</span></div>
<div class="line"><a name="l01167"></a><span class="lineno"> 1167</span> <span class="comment"> * method does not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l01168"></a><span class="lineno"> 1168</span> <span class="comment"> * access from multiple threads to the same stream object, and if</span></div>
<div class="line"><a name="l01169"></a><span class="lineno"> 1169</span> <span class="comment"> * that is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01170"></a><span class="lineno"> 1170</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01171"></a><span class="lineno"> 1171</span> <span class="comment"> * @return The GIO input stream at present attached to the</span></div>
<div class="line"><a name="l01172"></a><span class="lineno"> 1172</span> <span class="comment"> * streambuffer, or an empty GobjHandle object if none has been</span></div>
<div class="line"><a name="l01173"></a><span class="lineno"> 1173</span> <span class="comment"> * attached</span></div>
<div class="line"><a name="l01174"></a><span class="lineno"> 1174</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01175"></a><span class="lineno"> 1175</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a9dd1d2d9e046b5f8b97df7e7e6566c3d">get_istream</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l01176"></a><span class="lineno"> 1176</span> <span class="comment"></span></div>
<div class="line"><a name="l01177"></a><span class="lineno"> 1177</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01178"></a><span class="lineno"> 1178</span> <span class="comment"> * Get the GIO output stream at present attached to the streambuffer</span></div>
<div class="line"><a name="l01179"></a><span class="lineno"> 1179</span> <span class="comment"> * (if any), by GobjHandle. If a GInputStream object rather than a</span></div>
<div class="line"><a name="l01180"></a><span class="lineno"> 1180</span> <span class="comment"> * GOutputStream or GIOStream object has been attached (or no stream</span></div>
<div class="line"><a name="l01181"></a><span class="lineno"> 1181</span> <span class="comment"> * has been attached) or it has been closed, then this method will</span></div>
<div class="line"><a name="l01182"></a><span class="lineno"> 1182</span> <span class="comment"> * return an empty GobjHandle object. If a GIOStream object has been</span></div>
<div class="line"><a name="l01183"></a><span class="lineno"> 1183</span> <span class="comment"> * attached, this streambuffer's maintained GOutputStream object will</span></div>
<div class="line"><a name="l01184"></a><span class="lineno"> 1184</span> <span class="comment"> * be returned, which may be a converting stream manufactured from</span></div>
<div class="line"><a name="l01185"></a><span class="lineno"> 1185</span> <span class="comment"> * the GOutputStream object maintained by the GIOStream object.</span></div>
<div class="line"><a name="l01186"></a><span class="lineno"> 1186</span> <span class="comment"> * Retaining the return value will cause the stream to survive a</span></div>
<div class="line"><a name="l01187"></a><span class="lineno"> 1187</span> <span class="comment"> * subsequent call to attach_stream() or the destruction of this</span></div>
<div class="line"><a name="l01188"></a><span class="lineno"> 1188</span> <span class="comment"> * object. The return value may be a different stream from the one</span></div>
<div class="line"><a name="l01189"></a><span class="lineno"> 1189</span> <span class="comment"> * originally passed to this object's constructor or to attach(). It</span></div>
<div class="line"><a name="l01190"></a><span class="lineno"> 1190</span> <span class="comment"> * will be different if a converter has been attached to it. This</span></div>
<div class="line"><a name="l01191"></a><span class="lineno"> 1191</span> <span class="comment"> * method does not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l01192"></a><span class="lineno"> 1192</span> <span class="comment"> * access from multiple threads to the same stream object, and if</span></div>
<div class="line"><a name="l01193"></a><span class="lineno"> 1193</span> <span class="comment"> * that is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01194"></a><span class="lineno"> 1194</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01195"></a><span class="lineno"> 1195</span> <span class="comment"> * @return The GIO output stream at present attached to the</span></div>
<div class="line"><a name="l01196"></a><span class="lineno"> 1196</span> <span class="comment"> * streambuffer, or an empty GobjHandle object if none has been</span></div>
<div class="line"><a name="l01197"></a><span class="lineno"> 1197</span> <span class="comment"> * attached</span></div>
<div class="line"><a name="l01198"></a><span class="lineno"> 1198</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01199"></a><span class="lineno"> 1199</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#ab2fccc9672aac748690ddbf5f2f6e420">get_ostream</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l01200"></a><span class="lineno"> 1200</span> <span class="comment"></span></div>
<div class="line"><a name="l01201"></a><span class="lineno"> 1201</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01202"></a><span class="lineno"> 1202</span> <span class="comment"> * Get the GIOStream input-output stream at present attached to the</span></div>
<div class="line"><a name="l01203"></a><span class="lineno"> 1203</span> <span class="comment"> * streambuffer (if any), by GobjHandle. If a GInputStream or</span></div>
<div class="line"><a name="l01204"></a><span class="lineno"> 1204</span> <span class="comment"> * GOutputStream object rather than a GIOStream object has been</span></div>
<div class="line"><a name="l01205"></a><span class="lineno"> 1205</span> <span class="comment"> * attached (or no stream has been attached) or it has been closed,</span></div>
<div class="line"><a name="l01206"></a><span class="lineno"> 1206</span> <span class="comment"> * then this method will return an empty GobjHandle object.</span></div>
<div class="line"><a name="l01207"></a><span class="lineno"> 1207</span> <span class="comment"> * Retaining the return value will cause the stream to survive a</span></div>
<div class="line"><a name="l01208"></a><span class="lineno"> 1208</span> <span class="comment"> * subsequent call to attach_stream() or the destruction of this</span></div>
<div class="line"><a name="l01209"></a><span class="lineno"> 1209</span> <span class="comment"> * object. This method does not throw. This class does not offer</span></div>
<div class="line"><a name="l01210"></a><span class="lineno"> 1210</span> <span class="comment"> * concurrent access from multiple threads to the same stream object,</span></div>
<div class="line"><a name="l01211"></a><span class="lineno"> 1211</span> <span class="comment"> * and if that is required users should provide their own</span></div>
<div class="line"><a name="l01212"></a><span class="lineno"> 1212</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01213"></a><span class="lineno"> 1213</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01214"></a><span class="lineno"> 1214</span> <span class="comment"> * @return The GIOStream stream at present attached to the</span></div>
<div class="line"><a name="l01215"></a><span class="lineno"> 1215</span> <span class="comment"> * streambuffer, or an empty GobjHandle object if none has been</span></div>
<div class="line"><a name="l01216"></a><span class="lineno"> 1216</span> <span class="comment"> * attached</span></div>
<div class="line"><a name="l01217"></a><span class="lineno"> 1217</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01218"></a><span class="lineno"> 1218</span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a44f485e4493d92cf0de5a8f3a89a4053">get_iostream</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l01219"></a><span class="lineno"> 1219</span> <span class="comment"></span></div>
<div class="line"><a name="l01220"></a><span class="lineno"> 1220</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01221"></a><span class="lineno"> 1221</span> <span class="comment"> * Causes the streambuffer to swap bytes in incoming text, so as to</span></div>
<div class="line"><a name="l01222"></a><span class="lineno"> 1222</span> <span class="comment"> * convert big endian text to little endian text, or little endian</span></div>
<div class="line"><a name="l01223"></a><span class="lineno"> 1223</span> <span class="comment"> * text to big endian text. It is called by the user in response to</span></div>
<div class="line"><a name="l01224"></a><span class="lineno"> 1224</span> <span class="comment"> * finding a byte order marker (BOM) 0xfffe (UTF-16) or 0xfffe0000</span></div>
<div class="line"><a name="l01225"></a><span class="lineno"> 1225</span> <span class="comment"> * (UTF-32) as the first character of a newly opened file/stream, or</span></div>
<div class="line"><a name="l01226"></a><span class="lineno"> 1226</span> <span class="comment"> * if the user knows by some other means that the native endianness</span></div>
<div class="line"><a name="l01227"></a><span class="lineno"> 1227</span> <span class="comment"> * of the machine doing the reading differs from the endianness of</span></div>
<div class="line"><a name="l01228"></a><span class="lineno"> 1228</span> <span class="comment"> * the file/stream being read. This only has effect on wide</span></div>
<div class="line"><a name="l01229"></a><span class="lineno"> 1229</span> <span class="comment"> * character streambuffers for input (for example, a wgstreambuf to</span></div>
<div class="line"><a name="l01230"></a><span class="lineno"> 1230</span> <span class="comment"> * which a GInputStream or GIOStream object has been attached), and</span></div>
<div class="line"><a name="l01231"></a><span class="lineno"> 1231</span> <span class="comment"> * not the gstreambuf narrow character stream buffer. Note that</span></div>
<div class="line"><a name="l01232"></a><span class="lineno"> 1232</span> <span class="comment"> * characters held for output are always outputted in native endian</span></div>
<div class="line"><a name="l01233"></a><span class="lineno"> 1233</span> <span class="comment"> * format unless a GConverter object has been attached, and this</span></div>
<div class="line"><a name="l01234"></a><span class="lineno"> 1234</span> <span class="comment"> * method does not affect that. This method does not throw. This</span></div>
<div class="line"><a name="l01235"></a><span class="lineno"> 1235</span> <span class="comment"> * class does not offer concurrent access from multiple threads to</span></div>
<div class="line"><a name="l01236"></a><span class="lineno"> 1236</span> <span class="comment"> * the same stream object, and if that is required users should</span></div>
<div class="line"><a name="l01237"></a><span class="lineno"> 1237</span> <span class="comment"> * provide their own synchronisation.</span></div>
<div class="line"><a name="l01238"></a><span class="lineno"> 1238</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01239"></a><span class="lineno"> 1239</span> <span class="comment"> * @param swap 'true' if byte swapping for input is to be turned on,</span></div>
<div class="line"><a name="l01240"></a><span class="lineno"> 1240</span> <span class="comment"> * 'false' if it is to be turned off. This will affect all</span></div>
<div class="line"><a name="l01241"></a><span class="lineno"> 1241</span> <span class="comment"> * characters extracted from the underlying streambuffer after this</span></div>
<div class="line"><a name="l01242"></a><span class="lineno"> 1242</span> <span class="comment"> * call is made. If a previously extracted character is to be</span></div>
<div class="line"><a name="l01243"></a><span class="lineno"> 1243</span> <span class="comment"> * putback(), it must be put back before this function is called (or</span></div>
<div class="line"><a name="l01244"></a><span class="lineno"> 1244</span> <span class="comment"> * unget() should be called instead) to avoid a putback mismatch,</span></div>
<div class="line"><a name="l01245"></a><span class="lineno"> 1245</span> <span class="comment"> * because this call will byte-swap anything already in the buffers.</span></div>
<div class="line"><a name="l01246"></a><span class="lineno"> 1246</span> <span class="comment"> * (Characters extracted after the call to this method may be putback</span></div>
<div class="line"><a name="l01247"></a><span class="lineno"> 1247</span> <span class="comment"> * normally.)</span></div>
<div class="line"><a name="l01248"></a><span class="lineno"> 1248</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01249"></a><span class="lineno"> 1249</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a32e26cdd55742d6e0a12e43f25119831">set_byteswap</a>(<span class="keywordtype">bool</span> <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">swap</a>);</div>
<div class="line"><a name="l01250"></a><span class="lineno"> 1250</span> <span class="comment"></span></div>
<div class="line"><a name="l01251"></a><span class="lineno"> 1251</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01252"></a><span class="lineno"> 1252</span> <span class="comment"> * If the GIO stream attached to this object is GOutputStream or</span></div>
<div class="line"><a name="l01253"></a><span class="lineno"> 1253</span> <span class="comment"> * GIOStream, this method converts it to an unbuffered stream for</span></div>
<div class="line"><a name="l01254"></a><span class="lineno"> 1254</span> <span class="comment"> * output if 'buffered' is false, or back to a buffered stream if</span></div>
<div class="line"><a name="l01255"></a><span class="lineno"> 1255</span> <span class="comment"> * buffering has previously been switched off and 'buffered' is true.</span></div>
<div class="line"><a name="l01256"></a><span class="lineno"> 1256</span> <span class="comment"> * Buffering is on by default for any newly created gstreambuf object</span></div>
<div class="line"><a name="l01257"></a><span class="lineno"> 1257</span> <span class="comment"> * and any newly attached GIO output stream or input-output stream.</span></div>
<div class="line"><a name="l01258"></a><span class="lineno"> 1258</span> <span class="comment"> * If buffering is turned off, all characters at present in the</span></div>
<div class="line"><a name="l01259"></a><span class="lineno"> 1259</span> <span class="comment"> * buffers which are stored for output are flushed (but if writing to</span></div>
<div class="line"><a name="l01260"></a><span class="lineno"> 1260</span> <span class="comment"> * a file which is being written over/replaced, output from this</span></div>
<div class="line"><a name="l01261"></a><span class="lineno"> 1261</span> <span class="comment"> * streambuffer may not appear in the destination until the GIO stream</span></div>
<div class="line"><a name="l01262"></a><span class="lineno"> 1262</span> <span class="comment"> * is closed). This method has no effect if no GIO output stream or</span></div>
<div class="line"><a name="l01263"></a><span class="lineno"> 1263</span> <span class="comment"> * input-output stream has yet been attached to this streambuffer.</span></div>
<div class="line"><a name="l01264"></a><span class="lineno"> 1264</span> <span class="comment"> * Switching output buffering off is similar in effect to setting the</span></div>
<div class="line"><a name="l01265"></a><span class="lineno"> 1265</span> <span class="comment"> * std::ios_base::unitbuf flag in the relevant gostream or giostream</span></div>
<div class="line"><a name="l01266"></a><span class="lineno"> 1266</span> <span class="comment"> * object, except that switching buffering off is slightly more</span></div>
<div class="line"><a name="l01267"></a><span class="lineno"> 1267</span> <span class="comment"> * efficient, and setting the std::ios_base::unitbuf flag will not</span></div>
<div class="line"><a name="l01268"></a><span class="lineno"> 1268</span> <span class="comment"> * retain the automatic tying of logical and actual file positions</span></div>
<div class="line"><a name="l01269"></a><span class="lineno"> 1269</span> <span class="comment"> * that occurs when output buffering is switched off, as explained</span></div>
<div class="line"><a name="l01270"></a><span class="lineno"> 1270</span> <span class="comment"> * @ref GioRandomAccessAnchor "here". This class does not offer</span></div>
<div class="line"><a name="l01271"></a><span class="lineno"> 1271</span> <span class="comment"> * concurrent access from multiple threads to the same stream object,</span></div>
<div class="line"><a name="l01272"></a><span class="lineno"> 1272</span> <span class="comment"> * and if that is required users should provide their own</span></div>
<div class="line"><a name="l01273"></a><span class="lineno"> 1273</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01274"></a><span class="lineno"> 1274</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01275"></a><span class="lineno"> 1275</span> <span class="comment"> * @param buffered 'false' if buffering is to be turned off, 'true' if</span></div>
<div class="line"><a name="l01276"></a><span class="lineno"> 1276</span> <span class="comment"> * it is to be turned back on.</span></div>
<div class="line"><a name="l01277"></a><span class="lineno"> 1277</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01278"></a><span class="lineno"> 1278</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l01279"></a><span class="lineno"> 1279</span> <span class="comment"> * 'buffered' is true, output buffering had previously been switched</span></div>
<div class="line"><a name="l01280"></a><span class="lineno"> 1280</span> <span class="comment"> * off, memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l01281"></a><span class="lineno"> 1281</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l01282"></a><span class="lineno"> 1282</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01283"></a><span class="lineno"> 1283</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in which</span></div>
<div class="line"><a name="l01284"></a><span class="lineno"> 1284</span> <span class="comment"> * case glib will terminate the program if it is unable to obtain</span></div>
<div class="line"><a name="l01285"></a><span class="lineno"> 1285</span> <span class="comment"> * memory from the operating system).</span></div>
<div class="line"><a name="l01286"></a><span class="lineno"> 1286</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01287"></a><span class="lineno"> 1287</span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#a1ac106bbb1a958ccd1ab5cebe65c9a81">set_output_buffered</a>(<span class="keywordtype">bool</span> buffered);</div>
<div class="line"><a name="l01288"></a><span class="lineno"> 1288</span> <span class="comment"></span></div>
<div class="line"><a name="l01289"></a><span class="lineno"> 1289</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01290"></a><span class="lineno"> 1290</span> <span class="comment"> * This method indicates whether the attached GIO stream implements</span></div>
<div class="line"><a name="l01291"></a><span class="lineno"> 1291</span> <span class="comment"> * GSeekable, so that a call to seekoff() or seekpos() can succeed.</span></div>
<div class="line"><a name="l01292"></a><span class="lineno"> 1292</span> <span class="comment"> * This method does not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l01293"></a><span class="lineno"> 1293</span> <span class="comment"> * access from multiple threads to the same stream object, and if that</span></div>
<div class="line"><a name="l01294"></a><span class="lineno"> 1294</span> <span class="comment"> * is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01295"></a><span class="lineno"> 1295</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01296"></a><span class="lineno"> 1296</span> <span class="comment"> * @return true if random access is supported, otherwise false. The</span></div>
<div class="line"><a name="l01297"></a><span class="lineno"> 1297</span> <span class="comment"> * result is only meaningful if a GIO stream has been attached to this</span></div>
<div class="line"><a name="l01298"></a><span class="lineno"> 1298</span> <span class="comment"> * streambuffer.</span></div>
<div class="line"><a name="l01299"></a><span class="lineno"> 1299</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01300"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gstreambuf.html#aa54a69695170c1b06b9058cf0870c42d"> 1300</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html#aa54a69695170c1b06b9058cf0870c42d">can_seek</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> seekable;}</div>
<div class="line"><a name="l01301"></a><span class="lineno"> 1301</span> <span class="comment"></span></div>
<div class="line"><a name="l01302"></a><span class="lineno"> 1302</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01303"></a><span class="lineno"> 1303</span> <span class="comment"> * This method indicates whether any attached GIO input stream is in</span></div>
<div class="line"><a name="l01304"></a><span class="lineno"> 1304</span> <span class="comment"> * an error state. It can be useful for detecting conversion errors</span></div>
<div class="line"><a name="l01305"></a><span class="lineno"> 1305</span> <span class="comment"> * on converting streams. This class does not offer concurrent access</span></div>
<div class="line"><a name="l01306"></a><span class="lineno"> 1306</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l01307"></a><span class="lineno"> 1307</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01308"></a><span class="lineno"> 1308</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01309"></a><span class="lineno"> 1309</span> <span class="comment"> * @return NULL if no input stream is attached, or it is not in an</span></div>
<div class="line"><a name="l01310"></a><span class="lineno"> 1310</span> <span class="comment"> * error state. If an attached input stream is in an error state, say</span></div>
<div class="line"><a name="l01311"></a><span class="lineno"> 1311</span> <span class="comment"> * because it is a converting input stream which has encountered a</span></div>
<div class="line"><a name="l01312"></a><span class="lineno"> 1312</span> <span class="comment"> * conversion error, the most recent GError object emitted by a read</span></div>
<div class="line"><a name="l01313"></a><span class="lineno"> 1313</span> <span class="comment"> * operation on it is returned. Ownership of the return value is</span></div>
<div class="line"><a name="l01314"></a><span class="lineno"> 1314</span> <span class="comment"> * retained, so if it is intended to be used after the next read</span></div>
<div class="line"><a name="l01315"></a><span class="lineno"> 1315</span> <span class="comment"> * operation, it should be copied using g_error_copy().</span></div>
<div class="line"><a name="l01316"></a><span class="lineno"> 1316</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01317"></a><span class="lineno"> 1317</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l01318"></a><span class="lineno"> 1318</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01319"></a><span class="lineno"> 1319</span>  GError* <a class="code" href="classCgu_1_1basic__gstreambuf.html#a45a8e789de0f3b26841e50efcd84eb49">is_input_error</a>();</div>
<div class="line"><a name="l01320"></a><span class="lineno"> 1320</span> <span class="comment"></span></div>
<div class="line"><a name="l01321"></a><span class="lineno"> 1321</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01322"></a><span class="lineno"> 1322</span> <span class="comment"> * This method indicates whether any attached GIO output stream is in</span></div>
<div class="line"><a name="l01323"></a><span class="lineno"> 1323</span> <span class="comment"> * an error state. It can be useful for detecting conversion errors</span></div>
<div class="line"><a name="l01324"></a><span class="lineno"> 1324</span> <span class="comment"> * on converting streams. This class does not offer concurrent access</span></div>
<div class="line"><a name="l01325"></a><span class="lineno"> 1325</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l01326"></a><span class="lineno"> 1326</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01327"></a><span class="lineno"> 1327</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01328"></a><span class="lineno"> 1328</span> <span class="comment"> * @return NULL if no output stream is attached, or it is not in an</span></div>
<div class="line"><a name="l01329"></a><span class="lineno"> 1329</span> <span class="comment"> * error state. If an attached output stream is in an error state,</span></div>
<div class="line"><a name="l01330"></a><span class="lineno"> 1330</span> <span class="comment"> * say because it is a converting output stream which has encountered</span></div>
<div class="line"><a name="l01331"></a><span class="lineno"> 1331</span> <span class="comment"> * a conversion error, the most recent GError object emitted by a</span></div>
<div class="line"><a name="l01332"></a><span class="lineno"> 1332</span> <span class="comment"> * write operation on it is returned. Ownership of the return value</span></div>
<div class="line"><a name="l01333"></a><span class="lineno"> 1333</span> <span class="comment"> * is retained, so if it is intended to be used after the next write</span></div>
<div class="line"><a name="l01334"></a><span class="lineno"> 1334</span> <span class="comment"> * operation, it should be copied using g_error_copy().</span></div>
<div class="line"><a name="l01335"></a><span class="lineno"> 1335</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01336"></a><span class="lineno"> 1336</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l01337"></a><span class="lineno"> 1337</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01338"></a><span class="lineno"> 1338</span>  GError* <a class="code" href="classCgu_1_1basic__gstreambuf.html#a805b596cb37d7812dacde4719284172e">is_output_error</a>();</div>
<div class="line"><a name="l01339"></a><span class="lineno"> 1339</span> </div>
<div class="line"><a name="l01340"></a><span class="lineno"> 1340</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01341"></a><span class="lineno"> 1341</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div>
<div class="line"><a name="l01342"></a><span class="lineno"> 1342</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div>
<div class="line"><a name="l01343"></a><span class="lineno"> 1343</span> };</div>
<div class="line"><a name="l01344"></a><span class="lineno"> 1344</span> <span class="comment"></span></div>
<div class="line"><a name="l01345"></a><span class="lineno"> 1345</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01346"></a><span class="lineno"> 1346</span> <span class="comment"> * @headerfile gstream.h c++-gtk-utils/gstream.h</span></div>
<div class="line"><a name="l01347"></a><span class="lineno"> 1347</span> <span class="comment"> * @brief C++ output stream for GIO streams</span></div>
<div class="line"><a name="l01348"></a><span class="lineno"> 1348</span> <span class="comment"> * @sa gstreams</span></div>
<div class="line"><a name="l01349"></a><span class="lineno"> 1349</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l01350"></a><span class="lineno"> 1350</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01351"></a><span class="lineno"> 1351</span> <span class="comment"> * This class provides standard ostream services for GIO output</span></div>
<div class="line"><a name="l01352"></a><span class="lineno"> 1352</span> <span class="comment"> * streams.</span></div>
<div class="line"><a name="l01353"></a><span class="lineno"> 1353</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01354"></a><span class="lineno"> 1354</span> <span class="keyword">template</span> <<span class="keyword">class</span> <span class="keywordtype">char</span>T , <span class="keyword">class</span> Traits = std::<span class="keywordtype">char</span>_traits<<span class="keywordtype">char</span>T> ></div>
<div class="line"><a name="l01355"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html"> 1355</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream</a>: <span class="keyword">public</span> std::basic_ostream<charT, Traits> {</div>
<div class="line"><a name="l01356"></a><span class="lineno"> 1356</span> </div>
<div class="line"><a name="l01357"></a><span class="lineno"> 1357</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<charT, Traits></a> buf;</div>
<div class="line"><a name="l01358"></a><span class="lineno"> 1358</span> </div>
<div class="line"><a name="l01359"></a><span class="lineno"> 1359</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l01360"></a><span class="lineno"> 1360</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01361"></a><span class="lineno"> 1361</span> <span class="comment"> * This class cannot be copied. The copy constructor is deleted.</span></div>
<div class="line"><a name="l01362"></a><span class="lineno"> 1362</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01363"></a><span class="lineno"> 1363</span>  <a class="code" href="classCgu_1_1basic__gostream.html#a46a09cec55fe8aed182044525298b86c">basic_gostream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l01364"></a><span class="lineno"> 1364</span> <span class="comment"></span></div>
<div class="line"><a name="l01365"></a><span class="lineno"> 1365</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01366"></a><span class="lineno"> 1366</span> <span class="comment"> * This class cannot be copied. The copy assignment operator is</span></div>
<div class="line"><a name="l01367"></a><span class="lineno"> 1367</span> <span class="comment"> * deleted.</span></div>
<div class="line"><a name="l01368"></a><span class="lineno"> 1368</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01369"></a><span class="lineno"> 1369</span>  <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream</a>& <a class="code" href="classCgu_1_1basic__gostream.html#a688997290f4881402110b236e92d43dc">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l01370"></a><span class="lineno"> 1370</span> <span class="comment"></span></div>
<div class="line"><a name="l01371"></a><span class="lineno"> 1371</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01372"></a><span class="lineno"> 1372</span> <span class="comment"> * The constructor taking a GIO output stream. This class does not</span></div>
<div class="line"><a name="l01373"></a><span class="lineno"> 1373</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l01374"></a><span class="lineno"> 1374</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l01375"></a><span class="lineno"> 1375</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01376"></a><span class="lineno"> 1376</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01377"></a><span class="lineno"> 1377</span> <span class="comment"> * @param stream A GIO output stream to be attached. If the caller</span></div>
<div class="line"><a name="l01378"></a><span class="lineno"> 1378</span> <span class="comment"> * wants the output stream to survive this class's destruction or a</span></div>
<div class="line"><a name="l01379"></a><span class="lineno"> 1379</span> <span class="comment"> * call to close() or attach(), the caller should keep a separate</span></div>
<div class="line"><a name="l01380"></a><span class="lineno"> 1380</span> <span class="comment"> * GobjHandle object which references the stream (obtained by, say,</span></div>
<div class="line"><a name="l01381"></a><span class="lineno"> 1381</span> <span class="comment"> * calling get_gio_stream()) and pass 'manage' as false. If this is</span></div>
<div class="line"><a name="l01382"></a><span class="lineno"> 1382</span> <span class="comment"> * a GFilterOutputStream object (that is, a GBufferedOutputStream,</span></div>
<div class="line"><a name="l01383"></a><span class="lineno"> 1383</span> <span class="comment"> * GConverterOutputStream or GDataOutputStream stream), only the</span></div>
<div class="line"><a name="l01384"></a><span class="lineno"> 1384</span> <span class="comment"> * underlying base output stream will be attached and the other</span></div>
<div class="line"><a name="l01385"></a><span class="lineno"> 1385</span> <span class="comment"> * higher level streams will be closed (buffering and converting are</span></div>
<div class="line"><a name="l01386"></a><span class="lineno"> 1386</span> <span class="comment"> * controlled solely by the set_buffered() method and 'converter'</span></div>
<div class="line"><a name="l01387"></a><span class="lineno"> 1387</span> <span class="comment"> * argument).</span></div>
<div class="line"><a name="l01388"></a><span class="lineno"> 1388</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01389"></a><span class="lineno"> 1389</span> <span class="comment"> * @param manage Whether the underlying streambuffer should call</span></div>
<div class="line"><a name="l01390"></a><span class="lineno"> 1390</span> <span class="comment"> * g_output_stream_close() on the GIO stream in the streambuffer's</span></div>
<div class="line"><a name="l01391"></a><span class="lineno"> 1391</span> <span class="comment"> * destructor or when another stream is attached. Passing 'true' is</span></div>
<div class="line"><a name="l01392"></a><span class="lineno"> 1392</span> <span class="comment"> * usually what is wanted, and is particularly relevant on output</span></div>
<div class="line"><a name="l01393"></a><span class="lineno"> 1393</span> <span class="comment"> * streams because unless g_output_stream_close() is called, GIO may</span></div>
<div class="line"><a name="l01394"></a><span class="lineno"> 1394</span> <span class="comment"> * not commit to disk - 'false' only makes sense if the caller keeps</span></div>
<div class="line"><a name="l01395"></a><span class="lineno"> 1395</span> <span class="comment"> * a separate GobjHandle object which references the stream to keep</span></div>
<div class="line"><a name="l01396"></a><span class="lineno"> 1396</span> <span class="comment"> * it alive (obtained by, say, calling get_gio_stream()). Unlike its</span></div>
<div class="line"><a name="l01397"></a><span class="lineno"> 1397</span> <span class="comment"> * fdstreams equivalent, this parameter does not have a default value</span></div>
<div class="line"><a name="l01398"></a><span class="lineno"> 1398</span> <span class="comment"> * of 'true': this is partly to make it less likely that a converter</span></div>
<div class="line"><a name="l01399"></a><span class="lineno"> 1399</span> <span class="comment"> * is passed to this argument by mistake (that would not normally</span></div>
<div class="line"><a name="l01400"></a><span class="lineno"> 1400</span> <span class="comment"> * cause a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l01401"></a><span class="lineno"> 1401</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l01402"></a><span class="lineno"> 1402</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l01403"></a><span class="lineno"> 1403</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l01404"></a><span class="lineno"> 1404</span> <span class="comment"> * partly because, given a GOutputStream* p, the construction</span></div>
<div class="line"><a name="l01405"></a><span class="lineno"> 1405</span> <span class="comment"> * \"Cgu::gostream str(Cgu::GobjHandle<GOutputStream>(p));\"</span></div>
<div class="line"><a name="l01406"></a><span class="lineno"> 1406</span> <span class="comment"> * without an additional argument or additional parentheses (or the</span></div>
<div class="line"><a name="l01407"></a><span class="lineno"> 1407</span> <span class="comment"> * use of uniform initializer syntax using braces) would cause a</span></div>
<div class="line"><a name="l01408"></a><span class="lineno"> 1408</span> <span class="comment"> * compiler error as it would be interpreted as a function</span></div>
<div class="line"><a name="l01409"></a><span class="lineno"> 1409</span> <span class="comment"> * declaration.</span></div>
<div class="line"><a name="l01410"></a><span class="lineno"> 1410</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01411"></a><span class="lineno"> 1411</span> <span class="comment"> * @param converter A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l01412"></a><span class="lineno"> 1412</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l01413"></a><span class="lineno"> 1413</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01414"></a><span class="lineno"> 1414</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01415"></a><span class="lineno"> 1415</span> <span class="comment"> * @exception std::bad_alloc This constructor will throw</span></div>
<div class="line"><a name="l01416"></a><span class="lineno"> 1416</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws on</span></div>
<div class="line"><a name="l01417"></a><span class="lineno"> 1417</span> <span class="comment"> * such exhaustion (unless the library has been installed using the</span></div>
<div class="line"><a name="l01418"></a><span class="lineno"> 1418</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01419"></a><span class="lineno"> 1419</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01420"></a><span class="lineno"> 1420</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01421"></a><span class="lineno"> 1421</span> <span class="comment"> * obtain memory from the operating system). No other exception will</span></div>
<div class="line"><a name="l01422"></a><span class="lineno"> 1422</span> <span class="comment"> * be thrown unless the constructor of std::basic_streambuf or</span></div>
<div class="line"><a name="l01423"></a><span class="lineno"> 1423</span> <span class="comment"> * std::basic_ostream throws.</span></div>
<div class="line"><a name="l01424"></a><span class="lineno"> 1424</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01425"></a><span class="lineno"> 1425</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01426"></a><span class="lineno"> 1426</span> <span class="comment"> * seekable even if it otherwise would be, so tellp() and seekp()</span></div>
<div class="line"><a name="l01427"></a><span class="lineno"> 1427</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l01428"></a><span class="lineno"> 1428</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01429"></a><span class="lineno"> 1429</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div>
<div class="line"><a name="l01430"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#ac1103b02d048f85234646d3943577346"> 1430</a></span>  <a class="code" href="classCgu_1_1basic__gostream.html#ac1103b02d048f85234646d3943577346">basic_gostream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a>& stream,</div>
<div class="line"><a name="l01431"></a><span class="lineno"> 1431</span>  <span class="keywordtype">bool</span> manage,</div>
<div class="line"><a name="l01432"></a><span class="lineno"> 1432</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>()):</div>
<div class="line"><a name="l01433"></a><span class="lineno"> 1433</span>  std::basic_ostream<charT, Traits>(0),</div>
<div class="line"><a name="l01434"></a><span class="lineno"> 1434</span>  buf(stream, manage, converter) {</div>
<div class="line"><a name="l01435"></a><span class="lineno"> 1435</span>  this->rdbuf(&buf);</div>
<div class="line"><a name="l01436"></a><span class="lineno"> 1436</span>  }</div>
<div class="line"><a name="l01437"></a><span class="lineno"> 1437</span> <span class="comment"></span></div>
<div class="line"><a name="l01438"></a><span class="lineno"> 1438</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01439"></a><span class="lineno"> 1439</span> <span class="comment"> * With this constructor, the GIO output stream must be attached</span></div>
<div class="line"><a name="l01440"></a><span class="lineno"> 1440</span> <span class="comment"> * later with the attach() method. It will not throw unless the</span></div>
<div class="line"><a name="l01441"></a><span class="lineno"> 1441</span> <span class="comment"> * default constructor of std::basic_streambuf or std::basic_ostream</span></div>
<div class="line"><a name="l01442"></a><span class="lineno"> 1442</span> <span class="comment"> * throws. This class does not offer concurrent access from multiple</span></div>
<div class="line"><a name="l01443"></a><span class="lineno"> 1443</span> <span class="comment"> * threads to the same stream object, and if that is required users</span></div>
<div class="line"><a name="l01444"></a><span class="lineno"> 1444</span> <span class="comment"> * should provide their own synchronisation.</span></div>
<div class="line"><a name="l01445"></a><span class="lineno"> 1445</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01446"></a><span class="lineno"> 1446</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div>
<div class="line"><a name="l01447"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#a46a09cec55fe8aed182044525298b86c"> 1447</a></span>  <a class="code" href="classCgu_1_1basic__gostream.html#a46a09cec55fe8aed182044525298b86c">basic_gostream</a>(): std::basic_ostream<charT, Traits>(0) {</div>
<div class="line"><a name="l01448"></a><span class="lineno"> 1448</span>  this->rdbuf(&buf);</div>
<div class="line"><a name="l01449"></a><span class="lineno"> 1449</span>  }</div>
<div class="line"><a name="l01450"></a><span class="lineno"> 1450</span> <span class="comment"></span></div>
<div class="line"><a name="l01451"></a><span class="lineno"> 1451</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01452"></a><span class="lineno"> 1452</span> <span class="comment"> * Attach a new GIO output stream to this object (and close any GIO</span></div>
<div class="line"><a name="l01453"></a><span class="lineno"> 1453</span> <span class="comment"> * stream at present managed by it). If output buffering was</span></div>
<div class="line"><a name="l01454"></a><span class="lineno"> 1454</span> <span class="comment"> * previously switched off, it is switched back on again. If any</span></div>
<div class="line"><a name="l01455"></a><span class="lineno"> 1455</span> <span class="comment"> * stream state flags were set (eofbit, failbit or badbit), they will</span></div>
<div class="line"><a name="l01456"></a><span class="lineno"> 1456</span> <span class="comment"> * be cleared by a call to clear(). If this method closes a stream</span></div>
<div class="line"><a name="l01457"></a><span class="lineno"> 1457</span> <span class="comment"> * at present managed by it and the close fails, failbit is not set</span></div>
<div class="line"><a name="l01458"></a><span class="lineno"> 1458</span> <span class="comment"> * and no exception will be thrown. Accordingly, if the user needs</span></div>
<div class="line"><a name="l01459"></a><span class="lineno"> 1459</span> <span class="comment"> * to know whether there was an error in this method closing any</span></div>
<div class="line"><a name="l01460"></a><span class="lineno"> 1460</span> <span class="comment"> * managed stream, she should call close() explicitly before calling</span></div>
<div class="line"><a name="l01461"></a><span class="lineno"> 1461</span> <span class="comment"> * this method. This class does not offer concurrent access from</span></div>
<div class="line"><a name="l01462"></a><span class="lineno"> 1462</span> <span class="comment"> * multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l01463"></a><span class="lineno"> 1463</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01464"></a><span class="lineno"> 1464</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01465"></a><span class="lineno"> 1465</span> <span class="comment"> * @param stream A GIO output stream to be attached. If the caller</span></div>
<div class="line"><a name="l01466"></a><span class="lineno"> 1466</span> <span class="comment"> * wants the GIO output stream to survive a subsequent call to</span></div>
<div class="line"><a name="l01467"></a><span class="lineno"> 1467</span> <span class="comment"> * close() or attach() or this class's destruction, the caller should</span></div>
<div class="line"><a name="l01468"></a><span class="lineno"> 1468</span> <span class="comment"> * keep a separate GobjHandle object which references the stream</span></div>
<div class="line"><a name="l01469"></a><span class="lineno"> 1469</span> <span class="comment"> * (obtained by, say, calling get_gio_stream()) and pass 'manage' as</span></div>
<div class="line"><a name="l01470"></a><span class="lineno"> 1470</span> <span class="comment"> * false. If this is a GFilterOutputStream object (that is, a</span></div>
<div class="line"><a name="l01471"></a><span class="lineno"> 1471</span> <span class="comment"> * GBufferedOutputStream, GConverterOutputStream or GDataOutputStream</span></div>
<div class="line"><a name="l01472"></a><span class="lineno"> 1472</span> <span class="comment"> * stream), only the underlying base output stream will be attached</span></div>
<div class="line"><a name="l01473"></a><span class="lineno"> 1473</span> <span class="comment"> * and the other higher level streams will be closed (buffering and</span></div>
<div class="line"><a name="l01474"></a><span class="lineno"> 1474</span> <span class="comment"> * converting are controlled solely by the set_buffered() method and</span></div>
<div class="line"><a name="l01475"></a><span class="lineno"> 1475</span> <span class="comment"> * 'converter' argument).</span></div>
<div class="line"><a name="l01476"></a><span class="lineno"> 1476</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01477"></a><span class="lineno"> 1477</span> <span class="comment"> * @param manage Whether the underlying streambuffer should call</span></div>
<div class="line"><a name="l01478"></a><span class="lineno"> 1478</span> <span class="comment"> * g_output_stream_close() on the GIO stream in the streambuffer's</span></div>
<div class="line"><a name="l01479"></a><span class="lineno"> 1479</span> <span class="comment"> * destructor or when another stream is attached. Passing 'true' is</span></div>
<div class="line"><a name="l01480"></a><span class="lineno"> 1480</span> <span class="comment"> * usually what is wanted, and is particularly relevant on output</span></div>
<div class="line"><a name="l01481"></a><span class="lineno"> 1481</span> <span class="comment"> * streams because unless g_output_stream_close() is called, GIO may</span></div>
<div class="line"><a name="l01482"></a><span class="lineno"> 1482</span> <span class="comment"> * not commit to disk - 'false' only makes sense if the caller keeps</span></div>
<div class="line"><a name="l01483"></a><span class="lineno"> 1483</span> <span class="comment"> * a separate GobjHandle object which references the stream to keep</span></div>
<div class="line"><a name="l01484"></a><span class="lineno"> 1484</span> <span class="comment"> * it alive (obtained by, say, calling get_gio_stream()). Unlike its</span></div>
<div class="line"><a name="l01485"></a><span class="lineno"> 1485</span> <span class="comment"> * fdstreams equivalent, this parameter does not have a default value</span></div>
<div class="line"><a name="l01486"></a><span class="lineno"> 1486</span> <span class="comment"> * of 'true': this is partly to make it less likely that a converter</span></div>
<div class="line"><a name="l01487"></a><span class="lineno"> 1487</span> <span class="comment"> * is passed to this argument by mistake (that would not normally</span></div>
<div class="line"><a name="l01488"></a><span class="lineno"> 1488</span> <span class="comment"> * cause a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l01489"></a><span class="lineno"> 1489</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l01490"></a><span class="lineno"> 1490</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l01491"></a><span class="lineno"> 1491</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l01492"></a><span class="lineno"> 1492</span> <span class="comment"> * partly to maintain compatibility with the constructor's interface,</span></div>
<div class="line"><a name="l01493"></a><span class="lineno"> 1493</span> <span class="comment"> * which has separate syntactic constraints.</span></div>
<div class="line"><a name="l01494"></a><span class="lineno"> 1494</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01495"></a><span class="lineno"> 1495</span> <span class="comment"> * @param converter A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l01496"></a><span class="lineno"> 1496</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l01497"></a><span class="lineno"> 1497</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01498"></a><span class="lineno"> 1498</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01499"></a><span class="lineno"> 1499</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l01500"></a><span class="lineno"> 1500</span> <span class="comment"> * memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l01501"></a><span class="lineno"> 1501</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l01502"></a><span class="lineno"> 1502</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01503"></a><span class="lineno"> 1503</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01504"></a><span class="lineno"> 1504</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01505"></a><span class="lineno"> 1505</span> <span class="comment"> * obtain memory from the operating system).</span></div>
<div class="line"><a name="l01506"></a><span class="lineno"> 1506</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01507"></a><span class="lineno"> 1507</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01508"></a><span class="lineno"> 1508</span> <span class="comment"> * seekable even if it otherwise would be, so tellp() and seekp()</span></div>
<div class="line"><a name="l01509"></a><span class="lineno"> 1509</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l01510"></a><span class="lineno"> 1510</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01511"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#a06374d8e33481f7b4526024e7a8d3a7a"> 1511</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gostream.html#a06374d8e33481f7b4526024e7a8d3a7a">attach</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a>& stream,</div>
<div class="line"><a name="l01512"></a><span class="lineno"> 1512</span>  <span class="keywordtype">bool</span> manage,</div>
<div class="line"><a name="l01513"></a><span class="lineno"> 1513</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>())</div>
<div class="line"><a name="l01514"></a><span class="lineno"> 1514</span>  {buf.attach_stream(stream, manage, converter); this->clear();}</div>
<div class="line"><a name="l01515"></a><span class="lineno"> 1515</span> <span class="comment"></span></div>
<div class="line"><a name="l01516"></a><span class="lineno"> 1516</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01517"></a><span class="lineno"> 1517</span> <span class="comment"> * Call g_output_stream_close() on the GIO stream at present attached</span></div>
<div class="line"><a name="l01518"></a><span class="lineno"> 1518</span> <span class="comment"> * (if any), and release the underlying C++ streambuffer's reference</span></div>
<div class="line"><a name="l01519"></a><span class="lineno"> 1519</span> <span class="comment"> * to that stream. If the caller wants the GIO stream to survive the</span></div>
<div class="line"><a name="l01520"></a><span class="lineno"> 1520</span> <span class="comment"> * call to this method (albeit in a closed state), the caller should,</span></div>
<div class="line"><a name="l01521"></a><span class="lineno"> 1521</span> <span class="comment"> * before the call is made, keep a separate GobjHandle object which</span></div>
<div class="line"><a name="l01522"></a><span class="lineno"> 1522</span> <span class="comment"> * references the stream. If the close fails, the failbit will be</span></div>
<div class="line"><a name="l01523"></a><span class="lineno"> 1523</span> <span class="comment"> * set with setstate(std::ios_base::failbit). This class does not</span></div>
<div class="line"><a name="l01524"></a><span class="lineno"> 1524</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l01525"></a><span class="lineno"> 1525</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l01526"></a><span class="lineno"> 1526</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01527"></a><span class="lineno"> 1527</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01528"></a><span class="lineno"> 1528</span> <span class="comment"> * @exception std::ios_base::failure This exception will be thrown if</span></div>
<div class="line"><a name="l01529"></a><span class="lineno"> 1529</span> <span class="comment"> * an error arises on closing the stream and such an exception has</span></div>
<div class="line"><a name="l01530"></a><span class="lineno"> 1530</span> <span class="comment"> * been required by a call to the exceptions() method of this class</span></div>
<div class="line"><a name="l01531"></a><span class="lineno"> 1531</span> <span class="comment"> * (inherited from std::basic_ios<>). No exception will be thrown if</span></div>
<div class="line"><a name="l01532"></a><span class="lineno"> 1532</span> <span class="comment"> * exceptions() has not been called.</span></div>
<div class="line"><a name="l01533"></a><span class="lineno"> 1533</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01534"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#ab0751dd2ccec41b4d62eb2a63497a8b6"> 1534</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gostream.html#ab0751dd2ccec41b4d62eb2a63497a8b6">close</a>() {<span class="keywordflow">if</span> (!buf.close_stream()) this->setstate(std::ios_base::failbit);}</div>
<div class="line"><a name="l01535"></a><span class="lineno"> 1535</span> <span class="comment"></span></div>
<div class="line"><a name="l01536"></a><span class="lineno"> 1536</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01537"></a><span class="lineno"> 1537</span> <span class="comment"> * Get the GIO output stream at present attached (if any), by</span></div>
<div class="line"><a name="l01538"></a><span class="lineno"> 1538</span> <span class="comment"> * GobjHandle. If no stream has been attached, this method will</span></div>
<div class="line"><a name="l01539"></a><span class="lineno"> 1539</span> <span class="comment"> * return an empty GobjHandle object. Retaining the return value</span></div>
<div class="line"><a name="l01540"></a><span class="lineno"> 1540</span> <span class="comment"> * will cause the GIO output stream to survive the destruction of</span></div>
<div class="line"><a name="l01541"></a><span class="lineno"> 1541</span> <span class="comment"> * this object. The return value may be a different stream from the</span></div>
<div class="line"><a name="l01542"></a><span class="lineno"> 1542</span> <span class="comment"> * one originally passed to this object's constructor or to attach().</span></div>
<div class="line"><a name="l01543"></a><span class="lineno"> 1543</span> <span class="comment"> * It will be different if a converter has been attached to it. This</span></div>
<div class="line"><a name="l01544"></a><span class="lineno"> 1544</span> <span class="comment"> * method does not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l01545"></a><span class="lineno"> 1545</span> <span class="comment"> * access from multiple threads to the same stream object, and if</span></div>
<div class="line"><a name="l01546"></a><span class="lineno"> 1546</span> <span class="comment"> * that is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01547"></a><span class="lineno"> 1547</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01548"></a><span class="lineno"> 1548</span> <span class="comment"> * @return The GIO output stream at present attached, or an empty</span></div>
<div class="line"><a name="l01549"></a><span class="lineno"> 1549</span> <span class="comment"> * GobjHandle object if none has been attached</span></div>
<div class="line"><a name="l01550"></a><span class="lineno"> 1550</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01551"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#aad94c21d1c0d33f69f76e106b4da95f4"> 1551</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a> <a class="code" href="classCgu_1_1basic__gostream.html#aad94c21d1c0d33f69f76e106b4da95f4">get_gio_stream</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.get_ostream();}</div>
<div class="line"><a name="l01552"></a><span class="lineno"> 1552</span> <span class="comment"></span></div>
<div class="line"><a name="l01553"></a><span class="lineno"> 1553</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01554"></a><span class="lineno"> 1554</span> <span class="comment"> * This method converts the attached GIO output stream to an</span></div>
<div class="line"><a name="l01555"></a><span class="lineno"> 1555</span> <span class="comment"> * unbuffered stream for output if 'buffered' is false, or back to a</span></div>
<div class="line"><a name="l01556"></a><span class="lineno"> 1556</span> <span class="comment"> * buffered stream if buffering has previously been switched off and</span></div>
<div class="line"><a name="l01557"></a><span class="lineno"> 1557</span> <span class="comment"> * 'buffered' is true. Buffering is on by default for any newly</span></div>
<div class="line"><a name="l01558"></a><span class="lineno"> 1558</span> <span class="comment"> * created gostream object and any newly attached GIO output stream.</span></div>
<div class="line"><a name="l01559"></a><span class="lineno"> 1559</span> <span class="comment"> * If buffering is turned off, all characters at present in the</span></div>
<div class="line"><a name="l01560"></a><span class="lineno"> 1560</span> <span class="comment"> * buffers which are stored for output are flushed (but if writing to</span></div>
<div class="line"><a name="l01561"></a><span class="lineno"> 1561</span> <span class="comment"> * a file which is being written over/replaced, output may not appear</span></div>
<div class="line"><a name="l01562"></a><span class="lineno"> 1562</span> <span class="comment"> * in the destination until the GIO stream is closed). This method</span></div>
<div class="line"><a name="l01563"></a><span class="lineno"> 1563</span> <span class="comment"> * has no effect if no GIO output stream has yet been attached.</span></div>
<div class="line"><a name="l01564"></a><span class="lineno"> 1564</span> <span class="comment"> * Switching output buffering off is similar in effect to setting the</span></div>
<div class="line"><a name="l01565"></a><span class="lineno"> 1565</span> <span class="comment"> * std::ios_base::unitbuf flag, but is slightly more efficient. This</span></div>
<div class="line"><a name="l01566"></a><span class="lineno"> 1566</span> <span class="comment"> * class does not offer concurrent access from multiple threads to the</span></div>
<div class="line"><a name="l01567"></a><span class="lineno"> 1567</span> <span class="comment"> * same stream object, and if that is required users should provide</span></div>
<div class="line"><a name="l01568"></a><span class="lineno"> 1568</span> <span class="comment"> * their own synchronisation.</span></div>
<div class="line"><a name="l01569"></a><span class="lineno"> 1569</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01570"></a><span class="lineno"> 1570</span> <span class="comment"> * @param buffered 'false' if buffering is to be turned off, 'true' if</span></div>
<div class="line"><a name="l01571"></a><span class="lineno"> 1571</span> <span class="comment"> * it is to be turned back on.</span></div>
<div class="line"><a name="l01572"></a><span class="lineno"> 1572</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01573"></a><span class="lineno"> 1573</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l01574"></a><span class="lineno"> 1574</span> <span class="comment"> * 'buffered' is true, output buffering had previously been switched</span></div>
<div class="line"><a name="l01575"></a><span class="lineno"> 1575</span> <span class="comment"> * off, memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l01576"></a><span class="lineno"> 1576</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l01577"></a><span class="lineno"> 1577</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01578"></a><span class="lineno"> 1578</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in which</span></div>
<div class="line"><a name="l01579"></a><span class="lineno"> 1579</span> <span class="comment"> * case glib will terminate the program if it is unable to obtain</span></div>
<div class="line"><a name="l01580"></a><span class="lineno"> 1580</span> <span class="comment"> * memory from the operating system).</span></div>
<div class="line"><a name="l01581"></a><span class="lineno"> 1581</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01582"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#a2c5cd30c1b82f8d944bb6fd43b98c4cb"> 1582</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gostream.html#a2c5cd30c1b82f8d944bb6fd43b98c4cb">set_buffered</a>(<span class="keywordtype">bool</span> buffered) {buf.set_output_buffered(buffered);}</div>
<div class="line"><a name="l01583"></a><span class="lineno"> 1583</span> <span class="comment"></span></div>
<div class="line"><a name="l01584"></a><span class="lineno"> 1584</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01585"></a><span class="lineno"> 1585</span> <span class="comment"> * This method indicates whether the attached GIO output stream</span></div>
<div class="line"><a name="l01586"></a><span class="lineno"> 1586</span> <span class="comment"> * implements GSeekable, so that a call to tellp() or seekp() can</span></div>
<div class="line"><a name="l01587"></a><span class="lineno"> 1587</span> <span class="comment"> * succeed. Note that in the seekp(off_type off, ios_base::seekdir</span></div>
<div class="line"><a name="l01588"></a><span class="lineno"> 1588</span> <span class="comment"> * dir) variant, on wide character streams the 'off' argument is</span></div>
<div class="line"><a name="l01589"></a><span class="lineno"> 1589</span> <span class="comment"> * dimensioned as the number of wchar_t/char32_t/char16_t units not</span></div>
<div class="line"><a name="l01590"></a><span class="lineno"> 1590</span> <span class="comment"> * the number of bytes (that is, it is bytes/sizeof(char_type)). This</span></div>
<div class="line"><a name="l01591"></a><span class="lineno"> 1591</span> <span class="comment"> * method does not throw. This class does not offer concurrent access</span></div>
<div class="line"><a name="l01592"></a><span class="lineno"> 1592</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l01593"></a><span class="lineno"> 1593</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01594"></a><span class="lineno"> 1594</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01595"></a><span class="lineno"> 1595</span> <span class="comment"> * @return true if the attached GIO stream implements GSeekable,</span></div>
<div class="line"><a name="l01596"></a><span class="lineno"> 1596</span> <span class="comment"> * otherwise false. The result is only meaningful if a GIO stream has</span></div>
<div class="line"><a name="l01597"></a><span class="lineno"> 1597</span> <span class="comment"> * been attached to this C++ stream object.</span></div>
<div class="line"><a name="l01598"></a><span class="lineno"> 1598</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01599"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#ab248e0990494a230a85d6271f0c82e3d"> 1599</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCgu_1_1basic__gostream.html#ab248e0990494a230a85d6271f0c82e3d">can_seek</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.can_seek();}</div>
<div class="line"><a name="l01600"></a><span class="lineno"> 1600</span> <span class="comment"></span></div>
<div class="line"><a name="l01601"></a><span class="lineno"> 1601</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01602"></a><span class="lineno"> 1602</span> <span class="comment"> * This method reports the error status of any attached GIO output</span></div>
<div class="line"><a name="l01603"></a><span class="lineno"> 1603</span> <span class="comment"> * stream, and is intended to be called where failbit or badbit has</span></div>
<div class="line"><a name="l01604"></a><span class="lineno"> 1604</span> <span class="comment"> * been set. It can be useful for interpreting conversion errors on</span></div>
<div class="line"><a name="l01605"></a><span class="lineno"> 1605</span> <span class="comment"> * converting streams where one of those bits is set. This class does</span></div>
<div class="line"><a name="l01606"></a><span class="lineno"> 1606</span> <span class="comment"> * not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l01607"></a><span class="lineno"> 1607</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l01608"></a><span class="lineno"> 1608</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l01609"></a><span class="lineno"> 1609</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01610"></a><span class="lineno"> 1610</span> <span class="comment"> * @return NULL if no output stream is attached, or it is not in an</span></div>
<div class="line"><a name="l01611"></a><span class="lineno"> 1611</span> <span class="comment"> * error state. If an attached output stream is in an error state,</span></div>
<div class="line"><a name="l01612"></a><span class="lineno"> 1612</span> <span class="comment"> * say because it is a converting output stream which has encountered</span></div>
<div class="line"><a name="l01613"></a><span class="lineno"> 1613</span> <span class="comment"> * a conversion error, the most recent GError object emitted by a</span></div>
<div class="line"><a name="l01614"></a><span class="lineno"> 1614</span> <span class="comment"> * write operation on it is returned. Ownership of the return value</span></div>
<div class="line"><a name="l01615"></a><span class="lineno"> 1615</span> <span class="comment"> * is retained, so if it is intended to be used after the next write</span></div>
<div class="line"><a name="l01616"></a><span class="lineno"> 1616</span> <span class="comment"> * operation, it should be copied using g_error_copy().</span></div>
<div class="line"><a name="l01617"></a><span class="lineno"> 1617</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01618"></a><span class="lineno"> 1618</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l01619"></a><span class="lineno"> 1619</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01620"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gostream.html#acbef3fde2370fa28c8dc1096b05f54a9"> 1620</a></span>  GError* <a class="code" href="classCgu_1_1basic__gostream.html#acbef3fde2370fa28c8dc1096b05f54a9">is_error</a>() {<span class="keywordflow">return</span> buf.is_output_error();}</div>
<div class="line"><a name="l01621"></a><span class="lineno"> 1621</span> </div>
<div class="line"><a name="l01622"></a><span class="lineno"> 1622</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01623"></a><span class="lineno"> 1623</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div>
<div class="line"><a name="l01624"></a><span class="lineno"> 1624</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div>
<div class="line"><a name="l01625"></a><span class="lineno"> 1625</span> };</div>
<div class="line"><a name="l01626"></a><span class="lineno"> 1626</span> </div>
<div class="line"><a name="l01627"></a><span class="lineno"> 1627</span> <span class="comment"></span></div>
<div class="line"><a name="l01628"></a><span class="lineno"> 1628</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01629"></a><span class="lineno"> 1629</span> <span class="comment"> * @headerfile gstream.h c++-gtk-utils/gstream.h</span></div>
<div class="line"><a name="l01630"></a><span class="lineno"> 1630</span> <span class="comment"> * @brief C++ input stream for GIO streams</span></div>
<div class="line"><a name="l01631"></a><span class="lineno"> 1631</span> <span class="comment"> * @sa gstreams</span></div>
<div class="line"><a name="l01632"></a><span class="lineno"> 1632</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l01633"></a><span class="lineno"> 1633</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01634"></a><span class="lineno"> 1634</span> <span class="comment"> * This class provides standard istream services for GIO input</span></div>
<div class="line"><a name="l01635"></a><span class="lineno"> 1635</span> <span class="comment"> * streams.</span></div>
<div class="line"><a name="l01636"></a><span class="lineno"> 1636</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01637"></a><span class="lineno"> 1637</span> <span class="keyword">template</span> <<span class="keyword">class</span> <span class="keywordtype">char</span>T , <span class="keyword">class</span> Traits = std::<span class="keywordtype">char</span>_traits<<span class="keywordtype">char</span>T> ></div>
<div class="line"><a name="l01638"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html"> 1638</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream</a> : <span class="keyword">public</span> std::basic_istream<charT, Traits> {</div>
<div class="line"><a name="l01639"></a><span class="lineno"> 1639</span> </div>
<div class="line"><a name="l01640"></a><span class="lineno"> 1640</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<charT , Traits></a> buf;</div>
<div class="line"><a name="l01641"></a><span class="lineno"> 1641</span> </div>
<div class="line"><a name="l01642"></a><span class="lineno"> 1642</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l01643"></a><span class="lineno"> 1643</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01644"></a><span class="lineno"> 1644</span> <span class="comment"> * This class cannot be copied. The copy constructor is deleted.</span></div>
<div class="line"><a name="l01645"></a><span class="lineno"> 1645</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01646"></a><span class="lineno"> 1646</span>  <a class="code" href="classCgu_1_1basic__gistream.html#a58304d879d2cf7d967097ccd0e20c4f5">basic_gistream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l01647"></a><span class="lineno"> 1647</span> <span class="comment"></span></div>
<div class="line"><a name="l01648"></a><span class="lineno"> 1648</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01649"></a><span class="lineno"> 1649</span> <span class="comment"> * This class cannot be copied. The copy assignment operator is</span></div>
<div class="line"><a name="l01650"></a><span class="lineno"> 1650</span> <span class="comment"> * deleted.</span></div>
<div class="line"><a name="l01651"></a><span class="lineno"> 1651</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01652"></a><span class="lineno"> 1652</span>  <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream</a>& <a class="code" href="classCgu_1_1basic__gistream.html#a9e8e8d2e42cc7526d84c6b0db4d69826">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l01653"></a><span class="lineno"> 1653</span> <span class="comment"></span></div>
<div class="line"><a name="l01654"></a><span class="lineno"> 1654</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01655"></a><span class="lineno"> 1655</span> <span class="comment"> * The constructor taking a GIO input stream. This class does not</span></div>
<div class="line"><a name="l01656"></a><span class="lineno"> 1656</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l01657"></a><span class="lineno"> 1657</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l01658"></a><span class="lineno"> 1658</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01659"></a><span class="lineno"> 1659</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01660"></a><span class="lineno"> 1660</span> <span class="comment"> * @param stream A GIO input stream to be attached. If the caller</span></div>
<div class="line"><a name="l01661"></a><span class="lineno"> 1661</span> <span class="comment"> * wants the GIO input stream to survive this class's destruction or</span></div>
<div class="line"><a name="l01662"></a><span class="lineno"> 1662</span> <span class="comment"> * a call to close() or attach(), the caller should keep a separate</span></div>
<div class="line"><a name="l01663"></a><span class="lineno"> 1663</span> <span class="comment"> * GobjHandle object which references the stream (obtained by, say,</span></div>
<div class="line"><a name="l01664"></a><span class="lineno"> 1664</span> <span class="comment"> * calling get_gio_stream()) and pass 'manage' as false. If this is</span></div>
<div class="line"><a name="l01665"></a><span class="lineno"> 1665</span> <span class="comment"> * a GFilterInputStream object (that is, a GBufferedInputStream or</span></div>
<div class="line"><a name="l01666"></a><span class="lineno"> 1666</span> <span class="comment"> * GConverterInputStream stream), only the underlying base input</span></div>
<div class="line"><a name="l01667"></a><span class="lineno"> 1667</span> <span class="comment"> * stream will be attached and the other higher level streams will be</span></div>
<div class="line"><a name="l01668"></a><span class="lineno"> 1668</span> <span class="comment"> * closed (buffering of input streams is always provided by the</span></div>
<div class="line"><a name="l01669"></a><span class="lineno"> 1669</span> <span class="comment"> * underlying C++ streambuffer, and converting is controlled solely</span></div>
<div class="line"><a name="l01670"></a><span class="lineno"> 1670</span> <span class="comment"> * by the 'converter' argument).</span></div>
<div class="line"><a name="l01671"></a><span class="lineno"> 1671</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01672"></a><span class="lineno"> 1672</span> <span class="comment"> * @param manage Whether the underlying streambuffer should call</span></div>
<div class="line"><a name="l01673"></a><span class="lineno"> 1673</span> <span class="comment"> * g_input_stream_close() on the GIO stream in the streambuffer's</span></div>
<div class="line"><a name="l01674"></a><span class="lineno"> 1674</span> <span class="comment"> * destructor or when another stream is attached. Passing 'true' is</span></div>
<div class="line"><a name="l01675"></a><span class="lineno"> 1675</span> <span class="comment"> * usually what is wanted - 'false' only makes sense if the caller</span></div>
<div class="line"><a name="l01676"></a><span class="lineno"> 1676</span> <span class="comment"> * keeps a separate GobjHandle object which references the stream to</span></div>
<div class="line"><a name="l01677"></a><span class="lineno"> 1677</span> <span class="comment"> * keep it alive (obtained by, say, calling get_gio_stream()).</span></div>
<div class="line"><a name="l01678"></a><span class="lineno"> 1678</span> <span class="comment"> * Unlike its fdstreams equivalent, this parameter does not have a</span></div>
<div class="line"><a name="l01679"></a><span class="lineno"> 1679</span> <span class="comment"> * default value of 'true': this is partly to make it less likely</span></div>
<div class="line"><a name="l01680"></a><span class="lineno"> 1680</span> <span class="comment"> * that a converter is passed to this argument by mistake (that would</span></div>
<div class="line"><a name="l01681"></a><span class="lineno"> 1681</span> <span class="comment"> * not normally cause a compiler warning because GobjHandle has a</span></div>
<div class="line"><a name="l01682"></a><span class="lineno"> 1682</span> <span class="comment"> * type conversion operator providing the underlying C object by</span></div>
<div class="line"><a name="l01683"></a><span class="lineno"> 1683</span> <span class="comment"> * pointer, so GobjHandles are type convertible to pointers, and such</span></div>
<div class="line"><a name="l01684"></a><span class="lineno"> 1684</span> <span class="comment"> * a pointer will in turn provide a type match with a bool argument);</span></div>
<div class="line"><a name="l01685"></a><span class="lineno"> 1685</span> <span class="comment"> * and partly because, given a GInputStream* p, the construction</span></div>
<div class="line"><a name="l01686"></a><span class="lineno"> 1686</span> <span class="comment"> * \"Cgu::gistream str(Cgu::GobjHandle<GInputStream>(p));\" without</span></div>
<div class="line"><a name="l01687"></a><span class="lineno"> 1687</span> <span class="comment"> * an additional argument or additional parentheses (or the use of</span></div>
<div class="line"><a name="l01688"></a><span class="lineno"> 1688</span> <span class="comment"> * uniform initializer syntax using braces) would cause a compiler</span></div>
<div class="line"><a name="l01689"></a><span class="lineno"> 1689</span> <span class="comment"> * error as it would be interpreted as a function declaration.</span></div>
<div class="line"><a name="l01690"></a><span class="lineno"> 1690</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01691"></a><span class="lineno"> 1691</span> <span class="comment"> * @param converter A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l01692"></a><span class="lineno"> 1692</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l01693"></a><span class="lineno"> 1693</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l01694"></a><span class="lineno"> 1694</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01695"></a><span class="lineno"> 1695</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01696"></a><span class="lineno"> 1696</span> <span class="comment"> * @exception std::bad_alloc This constructor will throw</span></div>
<div class="line"><a name="l01697"></a><span class="lineno"> 1697</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws on</span></div>
<div class="line"><a name="l01698"></a><span class="lineno"> 1698</span> <span class="comment"> * such exhaustion (unless the library has been installed using the</span></div>
<div class="line"><a name="l01699"></a><span class="lineno"> 1699</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01700"></a><span class="lineno"> 1700</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01701"></a><span class="lineno"> 1701</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01702"></a><span class="lineno"> 1702</span> <span class="comment"> * obtain memory from the operating system). No other exception will</span></div>
<div class="line"><a name="l01703"></a><span class="lineno"> 1703</span> <span class="comment"> * be thrown unless the constructor of std::basic_streambuf or</span></div>
<div class="line"><a name="l01704"></a><span class="lineno"> 1704</span> <span class="comment"> * std::basic_istream throws.</span></div>
<div class="line"><a name="l01705"></a><span class="lineno"> 1705</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01706"></a><span class="lineno"> 1706</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01707"></a><span class="lineno"> 1707</span> <span class="comment"> * seekable even if it otherwise would be, so tellg() and seekg()</span></div>
<div class="line"><a name="l01708"></a><span class="lineno"> 1708</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l01709"></a><span class="lineno"> 1709</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01710"></a><span class="lineno"> 1710</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div>
<div class="line"><a name="l01711"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a3da2e05d5e77edf2408f25f53138ccc1"> 1711</a></span>  <a class="code" href="classCgu_1_1basic__gistream.html#a3da2e05d5e77edf2408f25f53138ccc1">basic_gistream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a>& stream,</div>
<div class="line"><a name="l01712"></a><span class="lineno"> 1712</span>  <span class="keywordtype">bool</span> manage,</div>
<div class="line"><a name="l01713"></a><span class="lineno"> 1713</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>()):</div>
<div class="line"><a name="l01714"></a><span class="lineno"> 1714</span>  std::basic_istream<charT, Traits>(0),</div>
<div class="line"><a name="l01715"></a><span class="lineno"> 1715</span>  buf(stream, manage, converter) {</div>
<div class="line"><a name="l01716"></a><span class="lineno"> 1716</span>  this->rdbuf(&buf);</div>
<div class="line"><a name="l01717"></a><span class="lineno"> 1717</span>  }</div>
<div class="line"><a name="l01718"></a><span class="lineno"> 1718</span> <span class="comment"></span></div>
<div class="line"><a name="l01719"></a><span class="lineno"> 1719</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01720"></a><span class="lineno"> 1720</span> <span class="comment"> * With this constructor, the GIO input stream must be attached later</span></div>
<div class="line"><a name="l01721"></a><span class="lineno"> 1721</span> <span class="comment"> * with the attach() method. It will not throw unless the default</span></div>
<div class="line"><a name="l01722"></a><span class="lineno"> 1722</span> <span class="comment"> * constructor of std::basic_streambuf or std::basic_istream throws.</span></div>
<div class="line"><a name="l01723"></a><span class="lineno"> 1723</span> <span class="comment"> * This class does not offer concurrent access from multiple threads</span></div>
<div class="line"><a name="l01724"></a><span class="lineno"> 1724</span> <span class="comment"> * to the same stream object, and if that is required users should</span></div>
<div class="line"><a name="l01725"></a><span class="lineno"> 1725</span> <span class="comment"> * provide their own synchronisation.</span></div>
<div class="line"><a name="l01726"></a><span class="lineno"> 1726</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01727"></a><span class="lineno"> 1727</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div>
<div class="line"><a name="l01728"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a58304d879d2cf7d967097ccd0e20c4f5"> 1728</a></span>  <a class="code" href="classCgu_1_1basic__gistream.html#a58304d879d2cf7d967097ccd0e20c4f5">basic_gistream</a>(): std::basic_istream<charT, Traits>(0) {</div>
<div class="line"><a name="l01729"></a><span class="lineno"> 1729</span>  this->rdbuf(&buf);</div>
<div class="line"><a name="l01730"></a><span class="lineno"> 1730</span>  }</div>
<div class="line"><a name="l01731"></a><span class="lineno"> 1731</span> <span class="comment"></span></div>
<div class="line"><a name="l01732"></a><span class="lineno"> 1732</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01733"></a><span class="lineno"> 1733</span> <span class="comment"> * Attach a new GIO input stream to this object (and close any GIO</span></div>
<div class="line"><a name="l01734"></a><span class="lineno"> 1734</span> <span class="comment"> * stream at present managed by it). In the case of wide character</span></div>
<div class="line"><a name="l01735"></a><span class="lineno"> 1735</span> <span class="comment"> * input streams, it also switches off byte swapping, if it was</span></div>
<div class="line"><a name="l01736"></a><span class="lineno"> 1736</span> <span class="comment"> * previously on. If any stream state flags were set (eofbit,</span></div>
<div class="line"><a name="l01737"></a><span class="lineno"> 1737</span> <span class="comment"> * failbit or badbit), they will be cleared by a call to clear(). If</span></div>
<div class="line"><a name="l01738"></a><span class="lineno"> 1738</span> <span class="comment"> * this method closes a stream at present managed by it and the close</span></div>
<div class="line"><a name="l01739"></a><span class="lineno"> 1739</span> <span class="comment"> * fails, failbit is not set and no exception will be thrown.</span></div>
<div class="line"><a name="l01740"></a><span class="lineno"> 1740</span> <span class="comment"> * Accordingly, if the user needs to know whether there was an error</span></div>
<div class="line"><a name="l01741"></a><span class="lineno"> 1741</span> <span class="comment"> * in this method closing any managed stream, she should call close()</span></div>
<div class="line"><a name="l01742"></a><span class="lineno"> 1742</span> <span class="comment"> * explicitly before calling this method. This class does not offer</span></div>
<div class="line"><a name="l01743"></a><span class="lineno"> 1743</span> <span class="comment"> * concurrent access from multiple threads to the same stream object,</span></div>
<div class="line"><a name="l01744"></a><span class="lineno"> 1744</span> <span class="comment"> * and if that is required users should provide their own</span></div>
<div class="line"><a name="l01745"></a><span class="lineno"> 1745</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01746"></a><span class="lineno"> 1746</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01747"></a><span class="lineno"> 1747</span> <span class="comment"> * @param stream A GIO input stream to be attached. If the caller</span></div>
<div class="line"><a name="l01748"></a><span class="lineno"> 1748</span> <span class="comment"> * wants the GIO input stream to survive a subsequent call to close()</span></div>
<div class="line"><a name="l01749"></a><span class="lineno"> 1749</span> <span class="comment"> * or attach() or this class's destruction, the caller should keep a</span></div>
<div class="line"><a name="l01750"></a><span class="lineno"> 1750</span> <span class="comment"> * separate GobjHandle object which references the stream (obtained</span></div>
<div class="line"><a name="l01751"></a><span class="lineno"> 1751</span> <span class="comment"> * by, say, calling get_gio_stream()) and pass 'manage' as false. If</span></div>
<div class="line"><a name="l01752"></a><span class="lineno"> 1752</span> <span class="comment"> * this is a GFilterInputStream object (that is, a</span></div>
<div class="line"><a name="l01753"></a><span class="lineno"> 1753</span> <span class="comment"> * GBufferedInputStream or GConverterInputStream stream), only the</span></div>
<div class="line"><a name="l01754"></a><span class="lineno"> 1754</span> <span class="comment"> * underlying base input stream will be attached and the other higher</span></div>
<div class="line"><a name="l01755"></a><span class="lineno"> 1755</span> <span class="comment"> * level streams will be closed (buffering of input streams is always</span></div>
<div class="line"><a name="l01756"></a><span class="lineno"> 1756</span> <span class="comment"> * provided by the underlying C++ streambuffer, and converting is</span></div>
<div class="line"><a name="l01757"></a><span class="lineno"> 1757</span> <span class="comment"> * controlled solely by the 'converter' argument).</span></div>
<div class="line"><a name="l01758"></a><span class="lineno"> 1758</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01759"></a><span class="lineno"> 1759</span> <span class="comment"> * @param manage Whether the underlying streambuffer should call</span></div>
<div class="line"><a name="l01760"></a><span class="lineno"> 1760</span> <span class="comment"> * g_input_stream_close() on the GIO stream in the streambuffer's</span></div>
<div class="line"><a name="l01761"></a><span class="lineno"> 1761</span> <span class="comment"> * destructor or when another stream is attached. Passing 'true' is</span></div>
<div class="line"><a name="l01762"></a><span class="lineno"> 1762</span> <span class="comment"> * usually what is wanted - 'false' only makes sense if the caller</span></div>
<div class="line"><a name="l01763"></a><span class="lineno"> 1763</span> <span class="comment"> * keeps a separate GobjHandle object which references the stream to</span></div>
<div class="line"><a name="l01764"></a><span class="lineno"> 1764</span> <span class="comment"> * keep it alive (obtained by, say, calling get_gio_stream()).</span></div>
<div class="line"><a name="l01765"></a><span class="lineno"> 1765</span> <span class="comment"> * Unlike its fdstreams equivalent, this parameter does not have a</span></div>
<div class="line"><a name="l01766"></a><span class="lineno"> 1766</span> <span class="comment"> * default value of 'true': this is partly to make it less likely</span></div>
<div class="line"><a name="l01767"></a><span class="lineno"> 1767</span> <span class="comment"> * that a converter is passed to this argument by mistake (that would</span></div>
<div class="line"><a name="l01768"></a><span class="lineno"> 1768</span> <span class="comment"> * not normally cause a compiler warning because GobjHandle has a</span></div>
<div class="line"><a name="l01769"></a><span class="lineno"> 1769</span> <span class="comment"> * type conversion operator providing the underlying C object by</span></div>
<div class="line"><a name="l01770"></a><span class="lineno"> 1770</span> <span class="comment"> * pointer, so GobjHandles are type convertible to pointers, and such</span></div>
<div class="line"><a name="l01771"></a><span class="lineno"> 1771</span> <span class="comment"> * a pointer will in turn provide a type match with a bool argument);</span></div>
<div class="line"><a name="l01772"></a><span class="lineno"> 1772</span> <span class="comment"> * and partly to maintain compatibility with the constructor's</span></div>
<div class="line"><a name="l01773"></a><span class="lineno"> 1773</span> <span class="comment"> * interface, which has separate syntactic constraints.</span></div>
<div class="line"><a name="l01774"></a><span class="lineno"> 1774</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01775"></a><span class="lineno"> 1775</span> <span class="comment"> * @param converter A converter (if any) to be attached to the GIO</span></div>
<div class="line"><a name="l01776"></a><span class="lineno"> 1776</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l01777"></a><span class="lineno"> 1777</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l01778"></a><span class="lineno"> 1778</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01779"></a><span class="lineno"> 1779</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01780"></a><span class="lineno"> 1780</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l01781"></a><span class="lineno"> 1781</span> <span class="comment"> * memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l01782"></a><span class="lineno"> 1782</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l01783"></a><span class="lineno"> 1783</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01784"></a><span class="lineno"> 1784</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01785"></a><span class="lineno"> 1785</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01786"></a><span class="lineno"> 1786</span> <span class="comment"> * obtain memory from the operating system).</span></div>
<div class="line"><a name="l01787"></a><span class="lineno"> 1787</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01788"></a><span class="lineno"> 1788</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01789"></a><span class="lineno"> 1789</span> <span class="comment"> * seekable even if it otherwise would be, so tellg() and seekg()</span></div>
<div class="line"><a name="l01790"></a><span class="lineno"> 1790</span> <span class="comment"> * will no longer work (they will return pos_type(off_type(-1)).</span></div>
<div class="line"><a name="l01791"></a><span class="lineno"> 1791</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01792"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#acadc621e7f01ebdd0d2984bed4551def"> 1792</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gistream.html#acadc621e7f01ebdd0d2984bed4551def">attach</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a>& stream,</div>
<div class="line"><a name="l01793"></a><span class="lineno"> 1793</span>  <span class="keywordtype">bool</span> manage,</div>
<div class="line"><a name="l01794"></a><span class="lineno"> 1794</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>())</div>
<div class="line"><a name="l01795"></a><span class="lineno"> 1795</span>  {buf.attach_stream(stream, manage, converter); this->clear();}</div>
<div class="line"><a name="l01796"></a><span class="lineno"> 1796</span> <span class="comment"></span></div>
<div class="line"><a name="l01797"></a><span class="lineno"> 1797</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01798"></a><span class="lineno"> 1798</span> <span class="comment"> * Call g_input_stream_close() on the GIO stream at present attached</span></div>
<div class="line"><a name="l01799"></a><span class="lineno"> 1799</span> <span class="comment"> * (if any), and release the underlying C++ streambuffer's reference</span></div>
<div class="line"><a name="l01800"></a><span class="lineno"> 1800</span> <span class="comment"> * to that stream. If the caller wants the GIO stream to survive the</span></div>
<div class="line"><a name="l01801"></a><span class="lineno"> 1801</span> <span class="comment"> * call to this method (albeit in a closed state), the caller should,</span></div>
<div class="line"><a name="l01802"></a><span class="lineno"> 1802</span> <span class="comment"> * before the call is made, keep a separate GobjHandle object which</span></div>
<div class="line"><a name="l01803"></a><span class="lineno"> 1803</span> <span class="comment"> * references the stream. If the close fails, the failbit will be</span></div>
<div class="line"><a name="l01804"></a><span class="lineno"> 1804</span> <span class="comment"> * set with setstate(std::ios_base::failbit). This class does not</span></div>
<div class="line"><a name="l01805"></a><span class="lineno"> 1805</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l01806"></a><span class="lineno"> 1806</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l01807"></a><span class="lineno"> 1807</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l01808"></a><span class="lineno"> 1808</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01809"></a><span class="lineno"> 1809</span> <span class="comment"> * @exception std::ios_base::failure This exception will be thrown if</span></div>
<div class="line"><a name="l01810"></a><span class="lineno"> 1810</span> <span class="comment"> * an error arises on closing the stream and such an exception has</span></div>
<div class="line"><a name="l01811"></a><span class="lineno"> 1811</span> <span class="comment"> * been required by a call to the exceptions() method of this class</span></div>
<div class="line"><a name="l01812"></a><span class="lineno"> 1812</span> <span class="comment"> * (inherited from std::basic_ios<>). No exception will be thrown if</span></div>
<div class="line"><a name="l01813"></a><span class="lineno"> 1813</span> <span class="comment"> * exceptions() has not been called.</span></div>
<div class="line"><a name="l01814"></a><span class="lineno"> 1814</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01815"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a53126704ddeb7fb129110eec7e6804f0"> 1815</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gistream.html#a53126704ddeb7fb129110eec7e6804f0">close</a>() {<span class="keywordflow">if</span> (!buf.close_stream()) this->setstate(std::ios_base::failbit);}</div>
<div class="line"><a name="l01816"></a><span class="lineno"> 1816</span> <span class="comment"></span></div>
<div class="line"><a name="l01817"></a><span class="lineno"> 1817</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01818"></a><span class="lineno"> 1818</span> <span class="comment"> * Get the GIO input stream at present attached (if any), by</span></div>
<div class="line"><a name="l01819"></a><span class="lineno"> 1819</span> <span class="comment"> * GobjHandle. If no stream has been attached, this method will</span></div>
<div class="line"><a name="l01820"></a><span class="lineno"> 1820</span> <span class="comment"> * return an empty GobjHandle object. Retaining the return value</span></div>
<div class="line"><a name="l01821"></a><span class="lineno"> 1821</span> <span class="comment"> * will cause the GIO input stream to survive the destruction of this</span></div>
<div class="line"><a name="l01822"></a><span class="lineno"> 1822</span> <span class="comment"> * object. The return value may be a different stream from the one</span></div>
<div class="line"><a name="l01823"></a><span class="lineno"> 1823</span> <span class="comment"> * originally passed to this object's constructor or to attach(). It</span></div>
<div class="line"><a name="l01824"></a><span class="lineno"> 1824</span> <span class="comment"> * will be different if a converter has been attached to it. This</span></div>
<div class="line"><a name="l01825"></a><span class="lineno"> 1825</span> <span class="comment"> * method does not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l01826"></a><span class="lineno"> 1826</span> <span class="comment"> * access from multiple threads to the same stream object, and if</span></div>
<div class="line"><a name="l01827"></a><span class="lineno"> 1827</span> <span class="comment"> * that is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01828"></a><span class="lineno"> 1828</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01829"></a><span class="lineno"> 1829</span> <span class="comment"> * @return The GIO input stream at present attached, or an empty</span></div>
<div class="line"><a name="l01830"></a><span class="lineno"> 1830</span> <span class="comment"> * GobjHandle object if none has been attached</span></div>
<div class="line"><a name="l01831"></a><span class="lineno"> 1831</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01832"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a621312926efcbf6d74ca2caf6e8d446b"> 1832</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a> <a class="code" href="classCgu_1_1basic__gistream.html#a621312926efcbf6d74ca2caf6e8d446b">get_gio_stream</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.get_istream();}</div>
<div class="line"><a name="l01833"></a><span class="lineno"> 1833</span> <span class="comment"></span></div>
<div class="line"><a name="l01834"></a><span class="lineno"> 1834</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01835"></a><span class="lineno"> 1835</span> <span class="comment"> * Causes the underlying streambuffer to swap bytes in the incoming</span></div>
<div class="line"><a name="l01836"></a><span class="lineno"> 1836</span> <span class="comment"> * text, so as to convert big endian text to little endian text, or</span></div>
<div class="line"><a name="l01837"></a><span class="lineno"> 1837</span> <span class="comment"> * little endian text to big endian text. It is called by the user</span></div>
<div class="line"><a name="l01838"></a><span class="lineno"> 1838</span> <span class="comment"> * in response to finding a byte order marker (BOM) 0xfffe (UTF-16)</span></div>
<div class="line"><a name="l01839"></a><span class="lineno"> 1839</span> <span class="comment"> * or 0xfffe0000 (UTF-32) as the first character of a newly opened</span></div>
<div class="line"><a name="l01840"></a><span class="lineno"> 1840</span> <span class="comment"> * file/stream, or if the user knows by some other means that the</span></div>
<div class="line"><a name="l01841"></a><span class="lineno"> 1841</span> <span class="comment"> * native endianness of the machine doing the reading differs from</span></div>
<div class="line"><a name="l01842"></a><span class="lineno"> 1842</span> <span class="comment"> * the endianness of the file/stream being read. This only has</span></div>
<div class="line"><a name="l01843"></a><span class="lineno"> 1843</span> <span class="comment"> * effect on wide character streams (for example, a wgistream</span></div>
<div class="line"><a name="l01844"></a><span class="lineno"> 1844</span> <span class="comment"> * object), and not the gistream narrow character stream. This</span></div>
<div class="line"><a name="l01845"></a><span class="lineno"> 1845</span> <span class="comment"> * method does not throw. This class does not offer concurrent</span></div>
<div class="line"><a name="l01846"></a><span class="lineno"> 1846</span> <span class="comment"> * access from multiple threads to the same stream object, and if</span></div>
<div class="line"><a name="l01847"></a><span class="lineno"> 1847</span> <span class="comment"> * that is required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01848"></a><span class="lineno"> 1848</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01849"></a><span class="lineno"> 1849</span> <span class="comment"> * @param swap 'true' if byte swapping is to be turned on, 'false' if</span></div>
<div class="line"><a name="l01850"></a><span class="lineno"> 1850</span> <span class="comment"> * it is to be turned off. This will affect all characters extracted</span></div>
<div class="line"><a name="l01851"></a><span class="lineno"> 1851</span> <span class="comment"> * from the underlying streambuffer after this call is made. If a</span></div>
<div class="line"><a name="l01852"></a><span class="lineno"> 1852</span> <span class="comment"> * previously extracted character is to be putback(), it must be put</span></div>
<div class="line"><a name="l01853"></a><span class="lineno"> 1853</span> <span class="comment"> * back before this function is called (or unget() should be called</span></div>
<div class="line"><a name="l01854"></a><span class="lineno"> 1854</span> <span class="comment"> * instead) to avoid a putback mismatch, because this call will</span></div>
<div class="line"><a name="l01855"></a><span class="lineno"> 1855</span> <span class="comment"> * byte-swap anything already in the buffers. (Characters extracted</span></div>
<div class="line"><a name="l01856"></a><span class="lineno"> 1856</span> <span class="comment"> * after the call to this method may be putback normally.)</span></div>
<div class="line"><a name="l01857"></a><span class="lineno"> 1857</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01858"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a2d3eb38e5c2097b4272c2be0192a6756"> 1858</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__gistream.html#a2d3eb38e5c2097b4272c2be0192a6756">set_byteswap</a>(<span class="keywordtype">bool</span> <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">swap</a>) {buf.set_byteswap(swap);}</div>
<div class="line"><a name="l01859"></a><span class="lineno"> 1859</span> <span class="comment"></span></div>
<div class="line"><a name="l01860"></a><span class="lineno"> 1860</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01861"></a><span class="lineno"> 1861</span> <span class="comment"> * This method indicates whether the attached GIO input stream</span></div>
<div class="line"><a name="l01862"></a><span class="lineno"> 1862</span> <span class="comment"> * implements GSeekable, so that a call to tellg() or seekg() can</span></div>
<div class="line"><a name="l01863"></a><span class="lineno"> 1863</span> <span class="comment"> * succeed. Note that in the seekg(off_type off, ios_base::seekdir</span></div>
<div class="line"><a name="l01864"></a><span class="lineno"> 1864</span> <span class="comment"> * dir) variant, on wide character streams the 'off' argument is</span></div>
<div class="line"><a name="l01865"></a><span class="lineno"> 1865</span> <span class="comment"> * dimensioned as the number of wchar_t/char32_t/char16_t units not</span></div>
<div class="line"><a name="l01866"></a><span class="lineno"> 1866</span> <span class="comment"> * the number of bytes (that is, it is bytes/sizeof(char_type)). This</span></div>
<div class="line"><a name="l01867"></a><span class="lineno"> 1867</span> <span class="comment"> * method does not throw. This class does not offer concurrent access</span></div>
<div class="line"><a name="l01868"></a><span class="lineno"> 1868</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l01869"></a><span class="lineno"> 1869</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01870"></a><span class="lineno"> 1870</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01871"></a><span class="lineno"> 1871</span> <span class="comment"> * @return true if the attached GIO stream implements GSeekable,</span></div>
<div class="line"><a name="l01872"></a><span class="lineno"> 1872</span> <span class="comment"> * otherwise false. The result is only meaningful if a GIO stream has</span></div>
<div class="line"><a name="l01873"></a><span class="lineno"> 1873</span> <span class="comment"> * been attached to this C++ stream object.</span></div>
<div class="line"><a name="l01874"></a><span class="lineno"> 1874</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01875"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a1908ef23a8c0a8d339ea9d488f2e02fd"> 1875</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCgu_1_1basic__gistream.html#a1908ef23a8c0a8d339ea9d488f2e02fd">can_seek</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.can_seek();}</div>
<div class="line"><a name="l01876"></a><span class="lineno"> 1876</span> <span class="comment"></span></div>
<div class="line"><a name="l01877"></a><span class="lineno"> 1877</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01878"></a><span class="lineno"> 1878</span> <span class="comment"> * This method reports the error status of any attached GIO input</span></div>
<div class="line"><a name="l01879"></a><span class="lineno"> 1879</span> <span class="comment"> * stream, and is intended to be called where failbit has been set.</span></div>
<div class="line"><a name="l01880"></a><span class="lineno"> 1880</span> <span class="comment"> * It can be useful for establishing, where that bit is set, whether</span></div>
<div class="line"><a name="l01881"></a><span class="lineno"> 1881</span> <span class="comment"> * failbit indicates normal end-of-file or a conversion error on a</span></div>
<div class="line"><a name="l01882"></a><span class="lineno"> 1882</span> <span class="comment"> * converting stream. This class does not offer concurrent access</span></div>
<div class="line"><a name="l01883"></a><span class="lineno"> 1883</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l01884"></a><span class="lineno"> 1884</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l01885"></a><span class="lineno"> 1885</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01886"></a><span class="lineno"> 1886</span> <span class="comment"> * @return NULL if no input stream is attached, or it is not in an</span></div>
<div class="line"><a name="l01887"></a><span class="lineno"> 1887</span> <span class="comment"> * error state. If an attached input stream is in an error state, say</span></div>
<div class="line"><a name="l01888"></a><span class="lineno"> 1888</span> <span class="comment"> * because it is a converting input stream which has encountered a</span></div>
<div class="line"><a name="l01889"></a><span class="lineno"> 1889</span> <span class="comment"> * conversion error, the most recent GError object emitted by a read</span></div>
<div class="line"><a name="l01890"></a><span class="lineno"> 1890</span> <span class="comment"> * operation on it is returned. Ownership of the return value is</span></div>
<div class="line"><a name="l01891"></a><span class="lineno"> 1891</span> <span class="comment"> * retained, so if it is intended to be used after the next read</span></div>
<div class="line"><a name="l01892"></a><span class="lineno"> 1892</span> <span class="comment"> * operation, it should be copied using g_error_copy().</span></div>
<div class="line"><a name="l01893"></a><span class="lineno"> 1893</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01894"></a><span class="lineno"> 1894</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l01895"></a><span class="lineno"> 1895</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01896"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__gistream.html#a750f2fa5c7c1d3ba94f023ed480d4361"> 1896</a></span>  GError* <a class="code" href="classCgu_1_1basic__gistream.html#a750f2fa5c7c1d3ba94f023ed480d4361">is_error</a>() {<span class="keywordflow">return</span> buf.is_input_error();}</div>
<div class="line"><a name="l01897"></a><span class="lineno"> 1897</span> </div>
<div class="line"><a name="l01898"></a><span class="lineno"> 1898</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01899"></a><span class="lineno"> 1899</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div>
<div class="line"><a name="l01900"></a><span class="lineno"> 1900</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div>
<div class="line"><a name="l01901"></a><span class="lineno"> 1901</span> };</div>
<div class="line"><a name="l01902"></a><span class="lineno"> 1902</span> </div>
<div class="line"><a name="l01903"></a><span class="lineno"> 1903</span> </div>
<div class="line"><a name="l01904"></a><span class="lineno"> 1904</span> <span class="comment"></span></div>
<div class="line"><a name="l01905"></a><span class="lineno"> 1905</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01906"></a><span class="lineno"> 1906</span> <span class="comment"> * @headerfile gstream.h c++-gtk-utils/gstream.h</span></div>
<div class="line"><a name="l01907"></a><span class="lineno"> 1907</span> <span class="comment"> * @brief C++ input-output stream for GIO streams</span></div>
<div class="line"><a name="l01908"></a><span class="lineno"> 1908</span> <span class="comment"> * @sa gstreams</span></div>
<div class="line"><a name="l01909"></a><span class="lineno"> 1909</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l01910"></a><span class="lineno"> 1910</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01911"></a><span class="lineno"> 1911</span> <span class="comment"> * This class provides standard iostream services for GIO streams.</span></div>
<div class="line"><a name="l01912"></a><span class="lineno"> 1912</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01913"></a><span class="lineno"> 1913</span> <span class="keyword">template</span> <<span class="keyword">class</span> <span class="keywordtype">char</span>T , <span class="keyword">class</span> Traits = std::<span class="keywordtype">char</span>_traits<<span class="keywordtype">char</span>T> ></div>
<div class="line"><a name="l01914"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html"> 1914</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream</a> : <span class="keyword">public</span> std::basic_iostream<charT, Traits> {</div>
<div class="line"><a name="l01915"></a><span class="lineno"> 1915</span> </div>
<div class="line"><a name="l01916"></a><span class="lineno"> 1916</span>  <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<charT , Traits></a> buf;</div>
<div class="line"><a name="l01917"></a><span class="lineno"> 1917</span> </div>
<div class="line"><a name="l01918"></a><span class="lineno"> 1918</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l01919"></a><span class="lineno"> 1919</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01920"></a><span class="lineno"> 1920</span> <span class="comment"> * This class cannot be copied. The copy constructor is deleted.</span></div>
<div class="line"><a name="l01921"></a><span class="lineno"> 1921</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01922"></a><span class="lineno"> 1922</span>  <a class="code" href="classCgu_1_1basic__giostream.html#a081f33c606c9df073a9921e3b484914c">basic_giostream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l01923"></a><span class="lineno"> 1923</span> <span class="comment"></span></div>
<div class="line"><a name="l01924"></a><span class="lineno"> 1924</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01925"></a><span class="lineno"> 1925</span> <span class="comment"> * This class cannot be copied. The copy assignment operator is</span></div>
<div class="line"><a name="l01926"></a><span class="lineno"> 1926</span> <span class="comment"> * deleted.</span></div>
<div class="line"><a name="l01927"></a><span class="lineno"> 1927</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01928"></a><span class="lineno"> 1928</span>  <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream</a>& <a class="code" href="classCgu_1_1basic__giostream.html#a6a2053a9b48dce2f463cd0727d50e70c">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l01929"></a><span class="lineno"> 1929</span> <span class="comment"></span></div>
<div class="line"><a name="l01930"></a><span class="lineno"> 1930</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01931"></a><span class="lineno"> 1931</span> <span class="comment"> * The constructor taking a GIO input-output stream. This class does</span></div>
<div class="line"><a name="l01932"></a><span class="lineno"> 1932</span> <span class="comment"> * not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l01933"></a><span class="lineno"> 1933</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l01934"></a><span class="lineno"> 1934</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l01935"></a><span class="lineno"> 1935</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01936"></a><span class="lineno"> 1936</span> <span class="comment"> * @param stream A GIO input-output stream to be attached. If the</span></div>
<div class="line"><a name="l01937"></a><span class="lineno"> 1937</span> <span class="comment"> * caller wants the GIO stream to survive this class's destruction or</span></div>
<div class="line"><a name="l01938"></a><span class="lineno"> 1938</span> <span class="comment"> * a call to close() or attach(), the caller should keep a separate</span></div>
<div class="line"><a name="l01939"></a><span class="lineno"> 1939</span> <span class="comment"> * GobjHandle object which references the stream (obtained by, say,</span></div>
<div class="line"><a name="l01940"></a><span class="lineno"> 1940</span> <span class="comment"> * calling get_gio_io_stream()) and pass 'manage' as false.</span></div>
<div class="line"><a name="l01941"></a><span class="lineno"> 1941</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01942"></a><span class="lineno"> 1942</span> <span class="comment"> * @param manage Whether the underlying streambuffer should call</span></div>
<div class="line"><a name="l01943"></a><span class="lineno"> 1943</span> <span class="comment"> * g_io_stream_close() on the GIO stream in the streambuffer's</span></div>
<div class="line"><a name="l01944"></a><span class="lineno"> 1944</span> <span class="comment"> * destructor or when another stream is attached. Passing 'true' is</span></div>
<div class="line"><a name="l01945"></a><span class="lineno"> 1945</span> <span class="comment"> * usually what is wanted, and is particularly relevant on output</span></div>
<div class="line"><a name="l01946"></a><span class="lineno"> 1946</span> <span class="comment"> * streams because unless g_io_stream_close() is called, GIO may not</span></div>
<div class="line"><a name="l01947"></a><span class="lineno"> 1947</span> <span class="comment"> * commit to disk - 'false' only makes sense if the caller keeps a</span></div>
<div class="line"><a name="l01948"></a><span class="lineno"> 1948</span> <span class="comment"> * separate GobjHandle object which references the stream to keep it</span></div>
<div class="line"><a name="l01949"></a><span class="lineno"> 1949</span> <span class="comment"> * alive (obtained by, say, calling get_gio_io_stream()). Unlike its</span></div>
<div class="line"><a name="l01950"></a><span class="lineno"> 1950</span> <span class="comment"> * fdstreams equivalent, this parameter does not have a default value</span></div>
<div class="line"><a name="l01951"></a><span class="lineno"> 1951</span> <span class="comment"> * of 'true': this is partly to make it less likely that a converter</span></div>
<div class="line"><a name="l01952"></a><span class="lineno"> 1952</span> <span class="comment"> * is passed to this argument by mistake (that would not normally</span></div>
<div class="line"><a name="l01953"></a><span class="lineno"> 1953</span> <span class="comment"> * cause a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l01954"></a><span class="lineno"> 1954</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l01955"></a><span class="lineno"> 1955</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l01956"></a><span class="lineno"> 1956</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l01957"></a><span class="lineno"> 1957</span> <span class="comment"> * partly because, given a GIOStream* p, the construction</span></div>
<div class="line"><a name="l01958"></a><span class="lineno"> 1958</span> <span class="comment"> * \"Cgu::giostream str(Cgu::GobjHandle<GIOStream>(p));\" without</span></div>
<div class="line"><a name="l01959"></a><span class="lineno"> 1959</span> <span class="comment"> * an additional argument or additional parentheses (or the use of</span></div>
<div class="line"><a name="l01960"></a><span class="lineno"> 1960</span> <span class="comment"> * uniform initializer syntax using braces) would cause a compiler</span></div>
<div class="line"><a name="l01961"></a><span class="lineno"> 1961</span> <span class="comment"> * error as it would be interpreted as a function declaration.</span></div>
<div class="line"><a name="l01962"></a><span class="lineno"> 1962</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01963"></a><span class="lineno"> 1963</span> <span class="comment"> * @param input_converter A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l01964"></a><span class="lineno"> 1964</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l01965"></a><span class="lineno"> 1965</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l01966"></a><span class="lineno"> 1966</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01967"></a><span class="lineno"> 1967</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01968"></a><span class="lineno"> 1968</span> <span class="comment"> * @param output_converter A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l01969"></a><span class="lineno"> 1969</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l01970"></a><span class="lineno"> 1970</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l01971"></a><span class="lineno"> 1971</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01972"></a><span class="lineno"> 1972</span> <span class="comment"> * @exception std::bad_alloc This constructor will throw</span></div>
<div class="line"><a name="l01973"></a><span class="lineno"> 1973</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws on</span></div>
<div class="line"><a name="l01974"></a><span class="lineno"> 1974</span> <span class="comment"> * such exhaustion (unless the library has been installed using the</span></div>
<div class="line"><a name="l01975"></a><span class="lineno"> 1975</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l01976"></a><span class="lineno"> 1976</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l01977"></a><span class="lineno"> 1977</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l01978"></a><span class="lineno"> 1978</span> <span class="comment"> * obtain memory from the operating system). No other exception will</span></div>
<div class="line"><a name="l01979"></a><span class="lineno"> 1979</span> <span class="comment"> * be thrown unless the constructor of std::basic_streambuf or</span></div>
<div class="line"><a name="l01980"></a><span class="lineno"> 1980</span> <span class="comment"> * std::basic_iostream throws.</span></div>
<div class="line"><a name="l01981"></a><span class="lineno"> 1981</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01982"></a><span class="lineno"> 1982</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l01983"></a><span class="lineno"> 1983</span> <span class="comment"> * seekable even if it otherwise would be, so tellg(), tellp(),</span></div>
<div class="line"><a name="l01984"></a><span class="lineno"> 1984</span> <span class="comment"> * seekg() and seekp() will no longer work (they will return</span></div>
<div class="line"><a name="l01985"></a><span class="lineno"> 1985</span> <span class="comment"> * pos_type(off_type(-1)). If the stream to which a converter has</span></div>
<div class="line"><a name="l01986"></a><span class="lineno"> 1986</span> <span class="comment"> * been attached represents a file on the file system (rather than a</span></div>
<div class="line"><a name="l01987"></a><span class="lineno"> 1987</span> <span class="comment"> * socket), after a read has been made, no further write may be made</span></div>
<div class="line"><a name="l01988"></a><span class="lineno"> 1988</span> <span class="comment"> * using the same GFileIOStream object. These restrictions do not</span></div>
<div class="line"><a name="l01989"></a><span class="lineno"> 1989</span> <span class="comment"> * apply to sockets (which are not seekable) so the use of converters</span></div>
<div class="line"><a name="l01990"></a><span class="lineno"> 1990</span> <span class="comment"> * with input-output streams (GIOStream) should generally be</span></div>
<div class="line"><a name="l01991"></a><span class="lineno"> 1991</span> <span class="comment"> * restricted to sockets.</span></div>
<div class="line"><a name="l01992"></a><span class="lineno"> 1992</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01993"></a><span class="lineno"> 1993</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div>
<div class="line"><a name="l01994"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a8624d9d44ba7c42f78395a547f430ba7"> 1994</a></span>  <a class="code" href="classCgu_1_1basic__giostream.html#a8624d9d44ba7c42f78395a547f430ba7">basic_giostream</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a>& stream,</div>
<div class="line"><a name="l01995"></a><span class="lineno"> 1995</span>  <span class="keywordtype">bool</span> manage,</div>
<div class="line"><a name="l01996"></a><span class="lineno"> 1996</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& input_converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>(),</div>
<div class="line"><a name="l01997"></a><span class="lineno"> 1997</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& output_converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>()):</div>
<div class="line"><a name="l01998"></a><span class="lineno"> 1998</span>  std::basic_iostream<charT, Traits>(0),</div>
<div class="line"><a name="l01999"></a><span class="lineno"> 1999</span>  buf(stream, manage, input_converter, output_converter) {</div>
<div class="line"><a name="l02000"></a><span class="lineno"> 2000</span>  this->rdbuf(&buf); <span class="comment">// std::basic_ios is a virtual base class</span></div>
<div class="line"><a name="l02001"></a><span class="lineno"> 2001</span>  }</div>
<div class="line"><a name="l02002"></a><span class="lineno"> 2002</span> <span class="comment"></span></div>
<div class="line"><a name="l02003"></a><span class="lineno"> 2003</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02004"></a><span class="lineno"> 2004</span> <span class="comment"> * With this constructor, the GIO input-output stream must be</span></div>
<div class="line"><a name="l02005"></a><span class="lineno"> 2005</span> <span class="comment"> * attached later with the attach() method. It will not throw unless</span></div>
<div class="line"><a name="l02006"></a><span class="lineno"> 2006</span> <span class="comment"> * the constructor of std::basic_streambuf or std::basic_iostream</span></div>
<div class="line"><a name="l02007"></a><span class="lineno"> 2007</span> <span class="comment"> * throws. This class does not offer concurrent access from multiple</span></div>
<div class="line"><a name="l02008"></a><span class="lineno"> 2008</span> <span class="comment"> * threads to the same stream object, and if that is required users</span></div>
<div class="line"><a name="l02009"></a><span class="lineno"> 2009</span> <span class="comment"> * should provide their own synchronisation.</span></div>
<div class="line"><a name="l02010"></a><span class="lineno"> 2010</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02011"></a><span class="lineno"> 2011</span>  <span class="comment">// using uniform initializer syntax here confuses doxygen</span></div>
<div class="line"><a name="l02012"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a081f33c606c9df073a9921e3b484914c"> 2012</a></span>  <a class="code" href="classCgu_1_1basic__giostream.html#a081f33c606c9df073a9921e3b484914c">basic_giostream</a>() : std::basic_iostream<charT, Traits>(0) {</div>
<div class="line"><a name="l02013"></a><span class="lineno"> 2013</span>  this->rdbuf(&buf); <span class="comment">// std::basic_ios is a virtual base class</span></div>
<div class="line"><a name="l02014"></a><span class="lineno"> 2014</span>  }</div>
<div class="line"><a name="l02015"></a><span class="lineno"> 2015</span> <span class="comment"></span></div>
<div class="line"><a name="l02016"></a><span class="lineno"> 2016</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02017"></a><span class="lineno"> 2017</span> <span class="comment"> * Attach a new GIO input-output stream to this object (and close any</span></div>
<div class="line"><a name="l02018"></a><span class="lineno"> 2018</span> <span class="comment"> * GIO stream at present managed by it). If output buffering was</span></div>
<div class="line"><a name="l02019"></a><span class="lineno"> 2019</span> <span class="comment"> * previously switched off, it is switched back on again. In the</span></div>
<div class="line"><a name="l02020"></a><span class="lineno"> 2020</span> <span class="comment"> * case of wide character input-output streams, it also switches off</span></div>
<div class="line"><a name="l02021"></a><span class="lineno"> 2021</span> <span class="comment"> * byte swapping on input, if it was previously on. If any stream</span></div>
<div class="line"><a name="l02022"></a><span class="lineno"> 2022</span> <span class="comment"> * state flags were set (eofbit, failbit or badbit), they will be</span></div>
<div class="line"><a name="l02023"></a><span class="lineno"> 2023</span> <span class="comment"> * cleared by a call to clear(). If this method closes a stream at</span></div>
<div class="line"><a name="l02024"></a><span class="lineno"> 2024</span> <span class="comment"> * present managed by it and the close fails, failbit is not set and</span></div>
<div class="line"><a name="l02025"></a><span class="lineno"> 2025</span> <span class="comment"> * no exception will be thrown. Accordingly, if the user needs to</span></div>
<div class="line"><a name="l02026"></a><span class="lineno"> 2026</span> <span class="comment"> * know whether there was an error in this method closing any managed</span></div>
<div class="line"><a name="l02027"></a><span class="lineno"> 2027</span> <span class="comment"> * stream, she should call close() explicitly before calling this</span></div>
<div class="line"><a name="l02028"></a><span class="lineno"> 2028</span> <span class="comment"> * method. This class does not offer concurrent access from multiple</span></div>
<div class="line"><a name="l02029"></a><span class="lineno"> 2029</span> <span class="comment"> * threads to the same stream object, and if that is required users</span></div>
<div class="line"><a name="l02030"></a><span class="lineno"> 2030</span> <span class="comment"> * should provide their own synchronisation.</span></div>
<div class="line"><a name="l02031"></a><span class="lineno"> 2031</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02032"></a><span class="lineno"> 2032</span> <span class="comment"> * @param stream A GIO input-output stream to be attached. If the</span></div>
<div class="line"><a name="l02033"></a><span class="lineno"> 2033</span> <span class="comment"> * caller wants the GIO stream to survive a subsequent call to</span></div>
<div class="line"><a name="l02034"></a><span class="lineno"> 2034</span> <span class="comment"> * close() or attach() or this class's destruction, the caller should</span></div>
<div class="line"><a name="l02035"></a><span class="lineno"> 2035</span> <span class="comment"> * keep a separate GobjHandle object which references the stream</span></div>
<div class="line"><a name="l02036"></a><span class="lineno"> 2036</span> <span class="comment"> * (obtained by, say, calling get_gio_io_stream()) and pass 'manage'</span></div>
<div class="line"><a name="l02037"></a><span class="lineno"> 2037</span> <span class="comment"> * as false.</span></div>
<div class="line"><a name="l02038"></a><span class="lineno"> 2038</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02039"></a><span class="lineno"> 2039</span> <span class="comment"> * @param manage Whether the underlying streambuffer should call</span></div>
<div class="line"><a name="l02040"></a><span class="lineno"> 2040</span> <span class="comment"> * g_io_stream_close() on the GIO stream in the streambuffer's</span></div>
<div class="line"><a name="l02041"></a><span class="lineno"> 2041</span> <span class="comment"> * destructor or when another stream is attached. Passing 'true' is</span></div>
<div class="line"><a name="l02042"></a><span class="lineno"> 2042</span> <span class="comment"> * usually what is wanted, and is particularly relevant on output</span></div>
<div class="line"><a name="l02043"></a><span class="lineno"> 2043</span> <span class="comment"> * streams because unless g_io_stream_close() is called, GIO may not</span></div>
<div class="line"><a name="l02044"></a><span class="lineno"> 2044</span> <span class="comment"> * commit to disk - 'false' only makes sense if the caller keeps a</span></div>
<div class="line"><a name="l02045"></a><span class="lineno"> 2045</span> <span class="comment"> * separate GobjHandle object which references the stream to keep it</span></div>
<div class="line"><a name="l02046"></a><span class="lineno"> 2046</span> <span class="comment"> * alive (obtained by, say, calling get_gio_io_stream()). Unlike its</span></div>
<div class="line"><a name="l02047"></a><span class="lineno"> 2047</span> <span class="comment"> * fdstreams equivalent, this parameter does not have a default value</span></div>
<div class="line"><a name="l02048"></a><span class="lineno"> 2048</span> <span class="comment"> * of 'true': this is partly to make it less likely that a converter</span></div>
<div class="line"><a name="l02049"></a><span class="lineno"> 2049</span> <span class="comment"> * is passed to this argument by mistake (that would not normally</span></div>
<div class="line"><a name="l02050"></a><span class="lineno"> 2050</span> <span class="comment"> * cause a compiler warning because GobjHandle has a type conversion</span></div>
<div class="line"><a name="l02051"></a><span class="lineno"> 2051</span> <span class="comment"> * operator providing the underlying C object by pointer, so</span></div>
<div class="line"><a name="l02052"></a><span class="lineno"> 2052</span> <span class="comment"> * GobjHandles are type convertible to pointers, and such a pointer</span></div>
<div class="line"><a name="l02053"></a><span class="lineno"> 2053</span> <span class="comment"> * will in turn provide a type match with a bool argument); and</span></div>
<div class="line"><a name="l02054"></a><span class="lineno"> 2054</span> <span class="comment"> * partly to maintain compatibility with the constructor's interface,</span></div>
<div class="line"><a name="l02055"></a><span class="lineno"> 2055</span> <span class="comment"> * which has separate syntactic constraints.</span></div>
<div class="line"><a name="l02056"></a><span class="lineno"> 2056</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02057"></a><span class="lineno"> 2057</span> <span class="comment"> * @param input_converter A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l02058"></a><span class="lineno"> 2058</span> <span class="comment"> * input stream (note that this does not affect the operation of</span></div>
<div class="line"><a name="l02059"></a><span class="lineno"> 2059</span> <span class="comment"> * set_byteswap()). The default value of an empty</span></div>
<div class="line"><a name="l02060"></a><span class="lineno"> 2060</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l02061"></a><span class="lineno"> 2061</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02062"></a><span class="lineno"> 2062</span> <span class="comment"> * @param output_converter A converter (if any) to be attached to the</span></div>
<div class="line"><a name="l02063"></a><span class="lineno"> 2063</span> <span class="comment"> * output stream. The default value of an empty</span></div>
<div class="line"><a name="l02064"></a><span class="lineno"> 2064</span> <span class="comment"> * GobjHandle<GConverter> object indicates no converter.</span></div>
<div class="line"><a name="l02065"></a><span class="lineno"> 2065</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02066"></a><span class="lineno"> 2066</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l02067"></a><span class="lineno"> 2067</span> <span class="comment"> * memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l02068"></a><span class="lineno"> 2068</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l02069"></a><span class="lineno"> 2069</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l02070"></a><span class="lineno"> 2070</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in</span></div>
<div class="line"><a name="l02071"></a><span class="lineno"> 2071</span> <span class="comment"> * which case glib will terminate the program if it is unable to</span></div>
<div class="line"><a name="l02072"></a><span class="lineno"> 2072</span> <span class="comment"> * obtain memory from the operating system).</span></div>
<div class="line"><a name="l02073"></a><span class="lineno"> 2073</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02074"></a><span class="lineno"> 2074</span> <span class="comment"> * @note If a converter is provided, the stream will no longer be</span></div>
<div class="line"><a name="l02075"></a><span class="lineno"> 2075</span> <span class="comment"> * seekable even if it otherwise would be, so tellg(), tellp(),</span></div>
<div class="line"><a name="l02076"></a><span class="lineno"> 2076</span> <span class="comment"> * seekg() and seekp() will no longer work (they will return</span></div>
<div class="line"><a name="l02077"></a><span class="lineno"> 2077</span> <span class="comment"> * pos_type(off_type(-1)). If the stream to which a converter has</span></div>
<div class="line"><a name="l02078"></a><span class="lineno"> 2078</span> <span class="comment"> * been attached represents a file on the file system (rather than a</span></div>
<div class="line"><a name="l02079"></a><span class="lineno"> 2079</span> <span class="comment"> * socket), after a read has been made, no further write may be made</span></div>
<div class="line"><a name="l02080"></a><span class="lineno"> 2080</span> <span class="comment"> * using the same GFileIOStream object. These restrictions do not</span></div>
<div class="line"><a name="l02081"></a><span class="lineno"> 2081</span> <span class="comment"> * apply to sockets (which are not seekable) so the use of converters</span></div>
<div class="line"><a name="l02082"></a><span class="lineno"> 2082</span> <span class="comment"> * with input-output streams (GIOStream) should generally be</span></div>
<div class="line"><a name="l02083"></a><span class="lineno"> 2083</span> <span class="comment"> * restricted to sockets.</span></div>
<div class="line"><a name="l02084"></a><span class="lineno"> 2084</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02085"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a31d899cc710377a1261d9f5bd3987286"> 2085</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__giostream.html#a31d899cc710377a1261d9f5bd3987286">attach</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a>& stream,</div>
<div class="line"><a name="l02086"></a><span class="lineno"> 2086</span>  <span class="keywordtype">bool</span> manage,</div>
<div class="line"><a name="l02087"></a><span class="lineno"> 2087</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& input_converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>(),</div>
<div class="line"><a name="l02088"></a><span class="lineno"> 2088</span>  <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>& output_converter = <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<GConverter></a>())</div>
<div class="line"><a name="l02089"></a><span class="lineno"> 2089</span>  {buf.attach_stream(stream, manage, input_converter, output_converter); this->clear();}</div>
<div class="line"><a name="l02090"></a><span class="lineno"> 2090</span> <span class="comment"></span></div>
<div class="line"><a name="l02091"></a><span class="lineno"> 2091</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02092"></a><span class="lineno"> 2092</span> <span class="comment"> * Call g_io_stream_close() on the GIO stream at present attached (if</span></div>
<div class="line"><a name="l02093"></a><span class="lineno"> 2093</span> <span class="comment"> * any), and release the underlying C++ streambuffer's reference to</span></div>
<div class="line"><a name="l02094"></a><span class="lineno"> 2094</span> <span class="comment"> * that stream. If the caller wants the GIO stream to survive the</span></div>
<div class="line"><a name="l02095"></a><span class="lineno"> 2095</span> <span class="comment"> * call to this method (albeit in a closed state), the caller should,</span></div>
<div class="line"><a name="l02096"></a><span class="lineno"> 2096</span> <span class="comment"> * before the call is made, keep a separate GobjHandle object which</span></div>
<div class="line"><a name="l02097"></a><span class="lineno"> 2097</span> <span class="comment"> * references the stream. If the close fails, the failbit will be</span></div>
<div class="line"><a name="l02098"></a><span class="lineno"> 2098</span> <span class="comment"> * set with setstate(std::ios_base::failbit). This class does not</span></div>
<div class="line"><a name="l02099"></a><span class="lineno"> 2099</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l02100"></a><span class="lineno"> 2100</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l02101"></a><span class="lineno"> 2101</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l02102"></a><span class="lineno"> 2102</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02103"></a><span class="lineno"> 2103</span> <span class="comment"> * @exception std::ios_base::failure This exception will be thrown if</span></div>
<div class="line"><a name="l02104"></a><span class="lineno"> 2104</span> <span class="comment"> * an error arises on closing the stream and such an exception has</span></div>
<div class="line"><a name="l02105"></a><span class="lineno"> 2105</span> <span class="comment"> * been required by a call to the exceptions() method of this class</span></div>
<div class="line"><a name="l02106"></a><span class="lineno"> 2106</span> <span class="comment"> * (inherited from std::basic_ios<>). No exception will be thrown if</span></div>
<div class="line"><a name="l02107"></a><span class="lineno"> 2107</span> <span class="comment"> * exceptions() has not been called.</span></div>
<div class="line"><a name="l02108"></a><span class="lineno"> 2108</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02109"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a1a5222e875ecc410a49d3d2323fe5661"> 2109</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__giostream.html#a1a5222e875ecc410a49d3d2323fe5661">close</a>() {<span class="keywordflow">if</span> (!buf.close_stream()) this->setstate(std::ios_base::failbit);}</div>
<div class="line"><a name="l02110"></a><span class="lineno"> 2110</span> <span class="comment"></span></div>
<div class="line"><a name="l02111"></a><span class="lineno"> 2111</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02112"></a><span class="lineno"> 2112</span> <span class="comment"> * Get the GIO input-output stream at present attached (if any), by</span></div>
<div class="line"><a name="l02113"></a><span class="lineno"> 2113</span> <span class="comment"> * GobjHandle. If no stream has been attached, this method will</span></div>
<div class="line"><a name="l02114"></a><span class="lineno"> 2114</span> <span class="comment"> * return an empty GobjHandle object. Retaining the return value</span></div>
<div class="line"><a name="l02115"></a><span class="lineno"> 2115</span> <span class="comment"> * will cause the GIO input-output stream to survive the destruction</span></div>
<div class="line"><a name="l02116"></a><span class="lineno"> 2116</span> <span class="comment"> * of this object. This method does not throw. This class does not</span></div>
<div class="line"><a name="l02117"></a><span class="lineno"> 2117</span> <span class="comment"> * offer concurrent access from multiple threads to the same stream</span></div>
<div class="line"><a name="l02118"></a><span class="lineno"> 2118</span> <span class="comment"> * object, and if that is required users should provide their own</span></div>
<div class="line"><a name="l02119"></a><span class="lineno"> 2119</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l02120"></a><span class="lineno"> 2120</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02121"></a><span class="lineno"> 2121</span> <span class="comment"> * @return The GIO input-output stream at present attached, or an</span></div>
<div class="line"><a name="l02122"></a><span class="lineno"> 2122</span> <span class="comment"> * empty GobjHandle object if none has been attached</span></div>
<div class="line"><a name="l02123"></a><span class="lineno"> 2123</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02124"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#abe138d9e515ab7cecd20b31b4fc9998d"> 2124</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GIOStream></a> <a class="code" href="classCgu_1_1basic__giostream.html#abe138d9e515ab7cecd20b31b4fc9998d">get_gio_io_stream</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.get_iostream();}</div>
<div class="line"><a name="l02125"></a><span class="lineno"> 2125</span> <span class="comment"></span></div>
<div class="line"><a name="l02126"></a><span class="lineno"> 2126</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02127"></a><span class="lineno"> 2127</span> <span class="comment"> * Get the underlying GIO output stream at present attached (if any),</span></div>
<div class="line"><a name="l02128"></a><span class="lineno"> 2128</span> <span class="comment"> * by GobjHandle. If none has been attached, this method will return</span></div>
<div class="line"><a name="l02129"></a><span class="lineno"> 2129</span> <span class="comment"> * an empty GobjHandle object. Retaining the return value will cause</span></div>
<div class="line"><a name="l02130"></a><span class="lineno"> 2130</span> <span class="comment"> * the GIO output stream to survive the destruction of this object.</span></div>
<div class="line"><a name="l02131"></a><span class="lineno"> 2131</span> <span class="comment"> * The return value may be a different stream from the one kept by</span></div>
<div class="line"><a name="l02132"></a><span class="lineno"> 2132</span> <span class="comment"> * the GIOStream object passed to this object's constructor or to</span></div>
<div class="line"><a name="l02133"></a><span class="lineno"> 2133</span> <span class="comment"> * attach(). It will be different if a converter has been attached</span></div>
<div class="line"><a name="l02134"></a><span class="lineno"> 2134</span> <span class="comment"> * to it. This method does not throw. This class does not offer</span></div>
<div class="line"><a name="l02135"></a><span class="lineno"> 2135</span> <span class="comment"> * concurrent access from multiple threads to the same stream object,</span></div>
<div class="line"><a name="l02136"></a><span class="lineno"> 2136</span> <span class="comment"> * and if that is required users should provide their own</span></div>
<div class="line"><a name="l02137"></a><span class="lineno"> 2137</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l02138"></a><span class="lineno"> 2138</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02139"></a><span class="lineno"> 2139</span> <span class="comment"> * @return The GIO output stream at present attached, or an empty</span></div>
<div class="line"><a name="l02140"></a><span class="lineno"> 2140</span> <span class="comment"> * GobjHandle object if none has been attached</span></div>
<div class="line"><a name="l02141"></a><span class="lineno"> 2141</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02142"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#ad620d6811dbe98fbe6df4eebebb27ac4"> 2142</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GOutputStream></a> <a class="code" href="classCgu_1_1basic__giostream.html#ad620d6811dbe98fbe6df4eebebb27ac4">get_gio_output_stream</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.get_ostream();}</div>
<div class="line"><a name="l02143"></a><span class="lineno"> 2143</span> <span class="comment"></span></div>
<div class="line"><a name="l02144"></a><span class="lineno"> 2144</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02145"></a><span class="lineno"> 2145</span> <span class="comment"> * Get the GIO input stream at present attached (if any), by</span></div>
<div class="line"><a name="l02146"></a><span class="lineno"> 2146</span> <span class="comment"> * GobjHandle. If none has been attached, this method will return an</span></div>
<div class="line"><a name="l02147"></a><span class="lineno"> 2147</span> <span class="comment"> * empty GobjHandle object. Retaining the return value will cause</span></div>
<div class="line"><a name="l02148"></a><span class="lineno"> 2148</span> <span class="comment"> * the GIO input stream to survive the destruction of this object. The</span></div>
<div class="line"><a name="l02149"></a><span class="lineno"> 2149</span> <span class="comment"> * return value may be a different stream from the one kept by the</span></div>
<div class="line"><a name="l02150"></a><span class="lineno"> 2150</span> <span class="comment"> * GIOStream object passed to this object's constructor or to</span></div>
<div class="line"><a name="l02151"></a><span class="lineno"> 2151</span> <span class="comment"> * attach(). It will be different if a converter has been attached</span></div>
<div class="line"><a name="l02152"></a><span class="lineno"> 2152</span> <span class="comment"> * to it. This method does not throw. This class does not offer</span></div>
<div class="line"><a name="l02153"></a><span class="lineno"> 2153</span> <span class="comment"> * concurrent access from multiple threads to the same stream object,</span></div>
<div class="line"><a name="l02154"></a><span class="lineno"> 2154</span> <span class="comment"> * and if that is required users should provide their own</span></div>
<div class="line"><a name="l02155"></a><span class="lineno"> 2155</span> <span class="comment"> * synchronisation.</span></div>
<div class="line"><a name="l02156"></a><span class="lineno"> 2156</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02157"></a><span class="lineno"> 2157</span> <span class="comment"> * @return The GIO input stream at present attached, or an empty</span></div>
<div class="line"><a name="l02158"></a><span class="lineno"> 2158</span> <span class="comment"> * GobjHandle object if none has been attached</span></div>
<div class="line"><a name="l02159"></a><span class="lineno"> 2159</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02160"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#af6eb4aaf124b1dabfc962c529be99770"> 2160</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html">GobjHandle<GInputStream></a> <a class="code" href="classCgu_1_1basic__giostream.html#af6eb4aaf124b1dabfc962c529be99770">get_gio_input_stream</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.get_istream();}</div>
<div class="line"><a name="l02161"></a><span class="lineno"> 2161</span> <span class="comment"></span></div>
<div class="line"><a name="l02162"></a><span class="lineno"> 2162</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l02163"></a><span class="lineno"> 2163</span> <span class="comment"> * Causes the underlying streambuffer to swap bytes in the incoming</span></div>
<div class="line"><a name="l02164"></a><span class="lineno"> 2164</span> <span class="comment"> * text, so as to convert big endian text to little endian text, or</span></div>
<div class="line"><a name="l02165"></a><span class="lineno"> 2165</span> <span class="comment"> * little endian text to big endian text. It is called by the user</span></div>
<div class="line"><a name="l02166"></a><span class="lineno"> 2166</span> <span class="comment"> * in response to finding a byte order marker (BOM) 0xfffe (UTF-16)</span></div>
<div class="line"><a name="l02167"></a><span class="lineno"> 2167</span> <span class="comment"> * or 0xfffe0000 (UTF-32) as the first character of a newly opened</span></div>
<div class="line"><a name="l02168"></a><span class="lineno"> 2168</span> <span class="comment"> * file/stream, or if the user knows by some other means that the</span></div>
<div class="line"><a name="l02169"></a><span class="lineno"> 2169</span> <span class="comment"> * native endianness of the machine doing the reading differs from</span></div>
<div class="line"><a name="l02170"></a><span class="lineno"> 2170</span> <span class="comment"> * the endianness of the file/stream being read. This only has</span></div>
<div class="line"><a name="l02171"></a><span class="lineno"> 2171</span> <span class="comment"> * effect on wide character streams for input (for example, a</span></div>
<div class="line"><a name="l02172"></a><span class="lineno"> 2172</span> <span class="comment"> * wgiostream object), and not the giostream narrow character stream.</span></div>
<div class="line"><a name="l02173"></a><span class="lineno"> 2173</span> <span class="comment"> * Note also that characters held for output are always outputted in</span></div>
<div class="line"><a name="l02174"></a><span class="lineno"> 2174</span> <span class="comment"> * native endian format unless a GConverter object has been attached,</span></div>
<div class="line"><a name="l02175"></a><span class="lineno"> 2175</span> <span class="comment"> * and this method does not affect that. This method does not throw.</span></div>
<div class="line"><a name="l02176"></a><span class="lineno"> 2176</span> <span class="comment"> * This class does not offer concurrent access from multiple threads</span></div>
<div class="line"><a name="l02177"></a><span class="lineno"> 2177</span> <span class="comment"> * to the same stream object, and if that is required users should</span></div>
<div class="line"><a name="l02178"></a><span class="lineno"> 2178</span> <span class="comment"> * provide their own synchronisation.</span></div>
<div class="line"><a name="l02179"></a><span class="lineno"> 2179</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02180"></a><span class="lineno"> 2180</span> <span class="comment"> * @param swap 'true' if byte swapping for input is to be turned on,</span></div>
<div class="line"><a name="l02181"></a><span class="lineno"> 2181</span> <span class="comment"> * 'false' if it is to be turned off. This will affect all</span></div>
<div class="line"><a name="l02182"></a><span class="lineno"> 2182</span> <span class="comment"> * characters extracted from the underlying streambuffer after this</span></div>
<div class="line"><a name="l02183"></a><span class="lineno"> 2183</span> <span class="comment"> * call is made. If a previously extracted character is to be</span></div>
<div class="line"><a name="l02184"></a><span class="lineno"> 2184</span> <span class="comment"> * putback(), it must be put back before this function is called (or</span></div>
<div class="line"><a name="l02185"></a><span class="lineno"> 2185</span> <span class="comment"> * unget() should be called instead) to avoid a putback mismatch,</span></div>
<div class="line"><a name="l02186"></a><span class="lineno"> 2186</span> <span class="comment"> * because this call will byte-swap anything already in the buffers.</span></div>
<div class="line"><a name="l02187"></a><span class="lineno"> 2187</span> <span class="comment"> * (Characters extracted after the call to this method may be putback</span></div>
<div class="line"><a name="l02188"></a><span class="lineno"> 2188</span> <span class="comment"> * normally.)</span></div>
<div class="line"><a name="l02189"></a><span class="lineno"> 2189</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02190"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#acc9a30ab7d3f2fa5a1947d676a8889bf"> 2190</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__giostream.html#acc9a30ab7d3f2fa5a1947d676a8889bf">set_byteswap</a>(<span class="keywordtype">bool</span> <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">swap</a>) {buf.set_byteswap(swap);}</div>
<div class="line"><a name="l02191"></a><span class="lineno"> 2191</span> <span class="comment"></span></div>
<div class="line"><a name="l02192"></a><span class="lineno"> 2192</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02193"></a><span class="lineno"> 2193</span> <span class="comment"> * This method converts the attached GIO input-output stream to an</span></div>
<div class="line"><a name="l02194"></a><span class="lineno"> 2194</span> <span class="comment"> * unbuffered stream for output if 'buffered' is false, or back to a</span></div>
<div class="line"><a name="l02195"></a><span class="lineno"> 2195</span> <span class="comment"> * buffered stream if buffering has previously been switched off and</span></div>
<div class="line"><a name="l02196"></a><span class="lineno"> 2196</span> <span class="comment"> * 'buffered' is true. Buffering is on by default for any newly</span></div>
<div class="line"><a name="l02197"></a><span class="lineno"> 2197</span> <span class="comment"> * created giostream object and any newly attached GIO input-output</span></div>
<div class="line"><a name="l02198"></a><span class="lineno"> 2198</span> <span class="comment"> * stream. If buffering is turned off, all characters at present in</span></div>
<div class="line"><a name="l02199"></a><span class="lineno"> 2199</span> <span class="comment"> * the buffers which are stored for output are flushed (but if writing</span></div>
<div class="line"><a name="l02200"></a><span class="lineno"> 2200</span> <span class="comment"> * to a file which is being written over/replaced, output may not</span></div>
<div class="line"><a name="l02201"></a><span class="lineno"> 2201</span> <span class="comment"> * appear in the destination until the GIO stream is closed). This</span></div>
<div class="line"><a name="l02202"></a><span class="lineno"> 2202</span> <span class="comment"> * method has no effect if no GIO input-output stream has yet been</span></div>
<div class="line"><a name="l02203"></a><span class="lineno"> 2203</span> <span class="comment"> * attached. Switching output buffering off is similar in effect to</span></div>
<div class="line"><a name="l02204"></a><span class="lineno"> 2204</span> <span class="comment"> * setting the std::ios_base::unitbuf flag, except that switching</span></div>
<div class="line"><a name="l02205"></a><span class="lineno"> 2205</span> <span class="comment"> * buffering off is slightly more efficient, and setting the</span></div>
<div class="line"><a name="l02206"></a><span class="lineno"> 2206</span> <span class="comment"> * std::ios_base::unitbuf flag will not retain the automatic tying of</span></div>
<div class="line"><a name="l02207"></a><span class="lineno"> 2207</span> <span class="comment"> * logical and actual file positions that occurs when output buffering</span></div>
<div class="line"><a name="l02208"></a><span class="lineno"> 2208</span> <span class="comment"> * is switched off, as explained @ref GioRandomAccessAnchor "here".</span></div>
<div class="line"><a name="l02209"></a><span class="lineno"> 2209</span> <span class="comment"> * This class does not offer concurrent access from multiple threads</span></div>
<div class="line"><a name="l02210"></a><span class="lineno"> 2210</span> <span class="comment"> * to the same stream object, and if that is required users should</span></div>
<div class="line"><a name="l02211"></a><span class="lineno"> 2211</span> <span class="comment"> * provide their own synchronisation.</span></div>
<div class="line"><a name="l02212"></a><span class="lineno"> 2212</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02213"></a><span class="lineno"> 2213</span> <span class="comment"> * @param buffered 'false' if buffering for output is to be turned</span></div>
<div class="line"><a name="l02214"></a><span class="lineno"> 2214</span> <span class="comment"> * off, 'true' if it is to be turned back on.</span></div>
<div class="line"><a name="l02215"></a><span class="lineno"> 2215</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02216"></a><span class="lineno"> 2216</span> <span class="comment"> * @exception std::bad_alloc This method will throw std::bad_alloc if</span></div>
<div class="line"><a name="l02217"></a><span class="lineno"> 2217</span> <span class="comment"> * 'buffered' is true, output buffering had previously been switched</span></div>
<div class="line"><a name="l02218"></a><span class="lineno"> 2218</span> <span class="comment"> * off, memory is exhausted and the system throws on such exhaustion</span></div>
<div class="line"><a name="l02219"></a><span class="lineno"> 2219</span> <span class="comment"> * (unless the library has been installed using the</span></div>
<div class="line"><a name="l02220"></a><span class="lineno"> 2220</span> <span class="comment"> * \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l02221"></a><span class="lineno"> 2221</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, in which</span></div>
<div class="line"><a name="l02222"></a><span class="lineno"> 2222</span> <span class="comment"> * case glib will terminate the program if it is unable to obtain</span></div>
<div class="line"><a name="l02223"></a><span class="lineno"> 2223</span> <span class="comment"> * memory from the operating system).</span></div>
<div class="line"><a name="l02224"></a><span class="lineno"> 2224</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02225"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a63c115c23715871006d9532d2e6daba3"> 2225</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1basic__giostream.html#a63c115c23715871006d9532d2e6daba3">set_output_buffered</a>(<span class="keywordtype">bool</span> buffered) {buf.set_output_buffered(buffered);}</div>
<div class="line"><a name="l02226"></a><span class="lineno"> 2226</span> <span class="comment"></span></div>
<div class="line"><a name="l02227"></a><span class="lineno"> 2227</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02228"></a><span class="lineno"> 2228</span> <span class="comment"> * This method indicates whether the attached GIO stream implements</span></div>
<div class="line"><a name="l02229"></a><span class="lineno"> 2229</span> <span class="comment"> * GSeekable, so that a call to tellg(), tellp(), seekg() or seekp()</span></div>
<div class="line"><a name="l02230"></a><span class="lineno"> 2230</span> <span class="comment"> * can succeed. Note that in the seekg(off_type off,</span></div>
<div class="line"><a name="l02231"></a><span class="lineno"> 2231</span> <span class="comment"> * ios_base::seekdir dir) and seekp(off_type off, ios_base::seekdir</span></div>
<div class="line"><a name="l02232"></a><span class="lineno"> 2232</span> <span class="comment"> * dir) variants, on wide character streams the 'off' argument is</span></div>
<div class="line"><a name="l02233"></a><span class="lineno"> 2233</span> <span class="comment"> * dimensioned as the number of wchar_t/char32_t/char16_t units not</span></div>
<div class="line"><a name="l02234"></a><span class="lineno"> 2234</span> <span class="comment"> * the number of bytes (that is, it is bytes/sizeof(char_type)). This</span></div>
<div class="line"><a name="l02235"></a><span class="lineno"> 2235</span> <span class="comment"> * method does not throw. This class does not offer concurrent access</span></div>
<div class="line"><a name="l02236"></a><span class="lineno"> 2236</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l02237"></a><span class="lineno"> 2237</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l02238"></a><span class="lineno"> 2238</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02239"></a><span class="lineno"> 2239</span> <span class="comment"> * @return true if the attached GIO stream implements GSeekable,</span></div>
<div class="line"><a name="l02240"></a><span class="lineno"> 2240</span> <span class="comment"> * otherwise false. The result is only meaningful if a GIO stream has</span></div>
<div class="line"><a name="l02241"></a><span class="lineno"> 2241</span> <span class="comment"> * been attached to this C++ stream object.</span></div>
<div class="line"><a name="l02242"></a><span class="lineno"> 2242</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02243"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a2b43f74329bf9f5776ee38b7c25a50b7"> 2243</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCgu_1_1basic__giostream.html#a2b43f74329bf9f5776ee38b7c25a50b7">can_seek</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> buf.can_seek();}</div>
<div class="line"><a name="l02244"></a><span class="lineno"> 2244</span> <span class="comment"></span></div>
<div class="line"><a name="l02245"></a><span class="lineno"> 2245</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02246"></a><span class="lineno"> 2246</span> <span class="comment"> * This method reports the error status of any attached GIO output</span></div>
<div class="line"><a name="l02247"></a><span class="lineno"> 2247</span> <span class="comment"> * stream, and is intended to be called where failbit or badbit has</span></div>
<div class="line"><a name="l02248"></a><span class="lineno"> 2248</span> <span class="comment"> * been set. It can be useful for interpreting conversion errors on</span></div>
<div class="line"><a name="l02249"></a><span class="lineno"> 2249</span> <span class="comment"> * converting streams where one of those bits is set. This class does</span></div>
<div class="line"><a name="l02250"></a><span class="lineno"> 2250</span> <span class="comment"> * not offer concurrent access from multiple threads to the same</span></div>
<div class="line"><a name="l02251"></a><span class="lineno"> 2251</span> <span class="comment"> * stream object, and if that is required users should provide their</span></div>
<div class="line"><a name="l02252"></a><span class="lineno"> 2252</span> <span class="comment"> * own synchronisation.</span></div>
<div class="line"><a name="l02253"></a><span class="lineno"> 2253</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02254"></a><span class="lineno"> 2254</span> <span class="comment"> * @return NULL if no output stream is attached, or it is not in an</span></div>
<div class="line"><a name="l02255"></a><span class="lineno"> 2255</span> <span class="comment"> * error state. If an attached output stream is in an error state,</span></div>
<div class="line"><a name="l02256"></a><span class="lineno"> 2256</span> <span class="comment"> * say because it is a converting output stream which has encountered</span></div>
<div class="line"><a name="l02257"></a><span class="lineno"> 2257</span> <span class="comment"> * a conversion error, the most recent GError object emitted by a</span></div>
<div class="line"><a name="l02258"></a><span class="lineno"> 2258</span> <span class="comment"> * write operation on it is returned. Ownership of the return value</span></div>
<div class="line"><a name="l02259"></a><span class="lineno"> 2259</span> <span class="comment"> * is retained, so if it is intended to be used after the next write</span></div>
<div class="line"><a name="l02260"></a><span class="lineno"> 2260</span> <span class="comment"> * operation, it should be copied using g_error_copy().</span></div>
<div class="line"><a name="l02261"></a><span class="lineno"> 2261</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02262"></a><span class="lineno"> 2262</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l02263"></a><span class="lineno"> 2263</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02264"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#aea784f0f7e75ed20821acff9d26f698f"> 2264</a></span>  GError* <a class="code" href="classCgu_1_1basic__giostream.html#aea784f0f7e75ed20821acff9d26f698f">is_output_error</a>() {<span class="keywordflow">return</span> buf.is_output_error();}</div>
<div class="line"><a name="l02265"></a><span class="lineno"> 2265</span> <span class="comment"></span></div>
<div class="line"><a name="l02266"></a><span class="lineno"> 2266</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02267"></a><span class="lineno"> 2267</span> <span class="comment"> * This method reports the error status of any attached GIO input</span></div>
<div class="line"><a name="l02268"></a><span class="lineno"> 2268</span> <span class="comment"> * stream, and is intended to be called where failbit has been set.</span></div>
<div class="line"><a name="l02269"></a><span class="lineno"> 2269</span> <span class="comment"> * It can be useful for establishing, where that bit is set, whether</span></div>
<div class="line"><a name="l02270"></a><span class="lineno"> 2270</span> <span class="comment"> * failbit indicates normal end-of-file or a conversion error on a</span></div>
<div class="line"><a name="l02271"></a><span class="lineno"> 2271</span> <span class="comment"> * converting stream. This class does not offer concurrent access</span></div>
<div class="line"><a name="l02272"></a><span class="lineno"> 2272</span> <span class="comment"> * from multiple threads to the same stream object, and if that is</span></div>
<div class="line"><a name="l02273"></a><span class="lineno"> 2273</span> <span class="comment"> * required users should provide their own synchronisation.</span></div>
<div class="line"><a name="l02274"></a><span class="lineno"> 2274</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02275"></a><span class="lineno"> 2275</span> <span class="comment"> * @return NULL if no input stream is attached, or it is not in an</span></div>
<div class="line"><a name="l02276"></a><span class="lineno"> 2276</span> <span class="comment"> * error state. If an attached input stream is in an error state, say</span></div>
<div class="line"><a name="l02277"></a><span class="lineno"> 2277</span> <span class="comment"> * because it is a converting input stream which has encountered a</span></div>
<div class="line"><a name="l02278"></a><span class="lineno"> 2278</span> <span class="comment"> * conversion error, the most recent GError object emitted by a read</span></div>
<div class="line"><a name="l02279"></a><span class="lineno"> 2279</span> <span class="comment"> * operation on it is returned. Ownership of the return value is</span></div>
<div class="line"><a name="l02280"></a><span class="lineno"> 2280</span> <span class="comment"> * retained, so if it is intended to be used after the next read</span></div>
<div class="line"><a name="l02281"></a><span class="lineno"> 2281</span> <span class="comment"> * operation, it should be copied using g_error_copy().</span></div>
<div class="line"><a name="l02282"></a><span class="lineno"> 2282</span> <span class="comment"> *</span></div>
<div class="line"><a name="l02283"></a><span class="lineno"> 2283</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l02284"></a><span class="lineno"> 2284</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02285"></a><span class="lineno"><a class="code" href="classCgu_1_1basic__giostream.html#a91eab25818e3ebae7ad91e00ae823f61"> 2285</a></span>  GError* <a class="code" href="classCgu_1_1basic__giostream.html#a91eab25818e3ebae7ad91e00ae823f61">is_input_error</a>() {<span class="keywordflow">return</span> buf.is_input_error();}</div>
<div class="line"><a name="l02286"></a><span class="lineno"> 2286</span> </div>
<div class="line"><a name="l02287"></a><span class="lineno"> 2287</span> <span class="comment">/* Only has effect if --with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l02288"></a><span class="lineno"> 2288</span> <span class="comment"> * --with-glib-memory-slices-no-compat option picked */</span></div>
<div class="line"><a name="l02289"></a><span class="lineno"> 2289</span>  <a class="code" href="cgu__config_8h.html#a13241741f6a47356f61508faea37c35a">CGU_GLIB_MEMORY_SLICES_FUNCS</a></div>
<div class="line"><a name="l02290"></a><span class="lineno"> 2290</span> };</div>
<div class="line"><a name="l02291"></a><span class="lineno"> 2291</span> <span class="comment"></span></div>
<div class="line"><a name="l02292"></a><span class="lineno"> 2292</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02293"></a><span class="lineno"> 2293</span> <span class="comment"> * @defgroup gstreams gstreams</span></div>
<div class="line"><a name="l02294"></a><span class="lineno"> 2294</span> <span class="comment"> */</span><span class="comment"></span></div>
<div class="line"><a name="l02295"></a><span class="lineno"> 2295</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02296"></a><span class="lineno"> 2296</span> <span class="comment"> * @typedef gstreambuf.</span></div>
<div class="line"><a name="l02297"></a><span class="lineno"> 2297</span> <span class="comment"> * @brief C++ stream buffer for GIO streams for char type</span></div>
<div class="line"><a name="l02298"></a><span class="lineno"> 2298</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02299"></a><span class="lineno"> 2299</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02300"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga0a2f9976e0c3499c13442b925f5e8f9e"> 2300</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<char></a> <a class="code" href="group__gstreams.html#ga0a2f9976e0c3499c13442b925f5e8f9e" title="C++ stream buffer for GIO streams for char type. ">gstreambuf</a>;</div>
<div class="line"><a name="l02301"></a><span class="lineno"> 2301</span> <span class="comment"></span></div>
<div class="line"><a name="l02302"></a><span class="lineno"> 2302</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02303"></a><span class="lineno"> 2303</span> <span class="comment"> * @typedef gistream.</span></div>
<div class="line"><a name="l02304"></a><span class="lineno"> 2304</span> <span class="comment"> * @brief C++ input stream for GIO streams for char type</span></div>
<div class="line"><a name="l02305"></a><span class="lineno"> 2305</span> <span class="comment"> * @anchor gistreamAnchor</span></div>
<div class="line"><a name="l02306"></a><span class="lineno"> 2306</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02307"></a><span class="lineno"> 2307</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02308"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga50a922fa93858106458a9da7722118a9"> 2308</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream<char></a> <a class="code" href="group__gstreams.html#ga50a922fa93858106458a9da7722118a9" title="C++ input stream for GIO streams for char type. ">gistream</a>;</div>
<div class="line"><a name="l02309"></a><span class="lineno"> 2309</span> <span class="comment"></span></div>
<div class="line"><a name="l02310"></a><span class="lineno"> 2310</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02311"></a><span class="lineno"> 2311</span> <span class="comment"> * @typedef gostream.</span></div>
<div class="line"><a name="l02312"></a><span class="lineno"> 2312</span> <span class="comment"> * @brief C++ output stream for GIO streams for char type</span></div>
<div class="line"><a name="l02313"></a><span class="lineno"> 2313</span> <span class="comment"> * @anchor gostreamAnchor</span></div>
<div class="line"><a name="l02314"></a><span class="lineno"> 2314</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02315"></a><span class="lineno"> 2315</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02316"></a><span class="lineno"><a class="code" href="group__gstreams.html#gaf601782cc7c521ad0aec6ddff2ed3139"> 2316</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream<char></a> <a class="code" href="group__gstreams.html#gaf601782cc7c521ad0aec6ddff2ed3139" title="C++ output stream for GIO streams for char type. ">gostream</a>;</div>
<div class="line"><a name="l02317"></a><span class="lineno"> 2317</span> <span class="comment"></span></div>
<div class="line"><a name="l02318"></a><span class="lineno"> 2318</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02319"></a><span class="lineno"> 2319</span> <span class="comment"> * @typedef giostream.</span></div>
<div class="line"><a name="l02320"></a><span class="lineno"> 2320</span> <span class="comment"> * @brief C++ input/output stream for GIO streams for char type</span></div>
<div class="line"><a name="l02321"></a><span class="lineno"> 2321</span> <span class="comment"> * @anchor giostreamAnchor</span></div>
<div class="line"><a name="l02322"></a><span class="lineno"> 2322</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02323"></a><span class="lineno"> 2323</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02324"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga0dd24c5eb7f02e7179f0ac4e6093026c"> 2324</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream<char></a> <a class="code" href="group__gstreams.html#ga0dd24c5eb7f02e7179f0ac4e6093026c" title="C++ input/output stream for GIO streams for char type. ">giostream</a>;</div>
<div class="line"><a name="l02325"></a><span class="lineno"> 2325</span> <span class="comment"></span></div>
<div class="line"><a name="l02326"></a><span class="lineno"> 2326</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02327"></a><span class="lineno"> 2327</span> <span class="comment"> * @typedef wgstreambuf.</span></div>
<div class="line"><a name="l02328"></a><span class="lineno"> 2328</span> <span class="comment"> * @brief C++ stream buffer for GIO streams for wchar_t type</span></div>
<div class="line"><a name="l02329"></a><span class="lineno"> 2329</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02330"></a><span class="lineno"> 2330</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02331"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga71b5bacd58d5d74d0d0e15f875f7d9db"> 2331</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<wchar_t></a> <a class="code" href="group__gstreams.html#ga71b5bacd58d5d74d0d0e15f875f7d9db" title="C++ stream buffer for GIO streams for wchar_t type. ">wgstreambuf</a>;</div>
<div class="line"><a name="l02332"></a><span class="lineno"> 2332</span> <span class="comment"></span></div>
<div class="line"><a name="l02333"></a><span class="lineno"> 2333</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02334"></a><span class="lineno"> 2334</span> <span class="comment"> * @typedef wgistream.</span></div>
<div class="line"><a name="l02335"></a><span class="lineno"> 2335</span> <span class="comment"> * @brief C++ input stream for GIO streams for wchar_t type</span></div>
<div class="line"><a name="l02336"></a><span class="lineno"> 2336</span> <span class="comment"> * @anchor wgistreamAnchor</span></div>
<div class="line"><a name="l02337"></a><span class="lineno"> 2337</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02338"></a><span class="lineno"> 2338</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02339"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga02f7d31dbb3f1589416d0455fe6a6b17"> 2339</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream<wchar_t></a> <a class="code" href="group__gstreams.html#ga02f7d31dbb3f1589416d0455fe6a6b17" title="C++ input stream for GIO streams for wchar_t type. ">wgistream</a>;</div>
<div class="line"><a name="l02340"></a><span class="lineno"> 2340</span> <span class="comment"></span></div>
<div class="line"><a name="l02341"></a><span class="lineno"> 2341</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02342"></a><span class="lineno"> 2342</span> <span class="comment"> * @typedef wgostream.</span></div>
<div class="line"><a name="l02343"></a><span class="lineno"> 2343</span> <span class="comment"> * @brief C++ output stream for GIO streams for wchar_t type</span></div>
<div class="line"><a name="l02344"></a><span class="lineno"> 2344</span> <span class="comment"> * @anchor wgostreamAnchor</span></div>
<div class="line"><a name="l02345"></a><span class="lineno"> 2345</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02346"></a><span class="lineno"> 2346</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02347"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga2e03297004baf396ee76a8444dc96db5"> 2347</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream<wchar_t></a> <a class="code" href="group__gstreams.html#ga2e03297004baf396ee76a8444dc96db5" title="C++ output stream for GIO streams for wchar_t type. ">wgostream</a>;</div>
<div class="line"><a name="l02348"></a><span class="lineno"> 2348</span> <span class="comment"></span></div>
<div class="line"><a name="l02349"></a><span class="lineno"> 2349</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02350"></a><span class="lineno"> 2350</span> <span class="comment"> * @typedef wgiostream.</span></div>
<div class="line"><a name="l02351"></a><span class="lineno"> 2351</span> <span class="comment"> * @brief C++ input/output stream for GIO streams for wchar_t type</span></div>
<div class="line"><a name="l02352"></a><span class="lineno"> 2352</span> <span class="comment"> * @anchor wgiostreamAnchor</span></div>
<div class="line"><a name="l02353"></a><span class="lineno"> 2353</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02354"></a><span class="lineno"> 2354</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02355"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga863de0bd9fe72837bb7098c82f58dc6f"> 2355</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream<wchar_t></a> <a class="code" href="group__gstreams.html#ga863de0bd9fe72837bb7098c82f58dc6f" title="C++ input/output stream for GIO streams for wchar_t type. ">wgiostream</a>;</div>
<div class="line"><a name="l02356"></a><span class="lineno"> 2356</span> <span class="comment"></span></div>
<div class="line"><a name="l02357"></a><span class="lineno"> 2357</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02358"></a><span class="lineno"> 2358</span> <span class="comment"> * @typedef u16gstreambuf.</span></div>
<div class="line"><a name="l02359"></a><span class="lineno"> 2359</span> <span class="comment"> * @brief C++ stream buffer for GIO streams for char16_t type</span></div>
<div class="line"><a name="l02360"></a><span class="lineno"> 2360</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02361"></a><span class="lineno"> 2361</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02362"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga5b4e68874a133ac65a42255af595c6b2"> 2362</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<char16_t></a> <a class="code" href="group__gstreams.html#ga5b4e68874a133ac65a42255af595c6b2" title="C++ stream buffer for GIO streams for char16_t type. ">u16gstreambuf</a>;</div>
<div class="line"><a name="l02363"></a><span class="lineno"> 2363</span> <span class="comment"></span></div>
<div class="line"><a name="l02364"></a><span class="lineno"> 2364</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02365"></a><span class="lineno"> 2365</span> <span class="comment"> * @typedef u16gistream.</span></div>
<div class="line"><a name="l02366"></a><span class="lineno"> 2366</span> <span class="comment"> * @brief C++ input stream for GIO streams for char16_t type</span></div>
<div class="line"><a name="l02367"></a><span class="lineno"> 2367</span> <span class="comment"> * @anchor u16gistreamAnchor</span></div>
<div class="line"><a name="l02368"></a><span class="lineno"> 2368</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02369"></a><span class="lineno"> 2369</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02370"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga8808f69293d0bebbc8522c6c263ee7db"> 2370</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream<char16_t></a> <a class="code" href="group__gstreams.html#ga8808f69293d0bebbc8522c6c263ee7db" title="C++ input stream for GIO streams for char16_t type. ">u16gistream</a>;</div>
<div class="line"><a name="l02371"></a><span class="lineno"> 2371</span> <span class="comment"></span></div>
<div class="line"><a name="l02372"></a><span class="lineno"> 2372</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02373"></a><span class="lineno"> 2373</span> <span class="comment"> * @typedef u16gostream.</span></div>
<div class="line"><a name="l02374"></a><span class="lineno"> 2374</span> <span class="comment"> * @brief C++ output stream for GIO streams for char16_t type</span></div>
<div class="line"><a name="l02375"></a><span class="lineno"> 2375</span> <span class="comment"> * @anchor u16gostreamAnchor</span></div>
<div class="line"><a name="l02376"></a><span class="lineno"> 2376</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02377"></a><span class="lineno"> 2377</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02378"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga77446d9796635382908ea8ffd32a278f"> 2378</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream<char16_t></a> <a class="code" href="group__gstreams.html#ga77446d9796635382908ea8ffd32a278f" title="C++ output stream for GIO streams for char16_t type. ">u16gostream</a>;</div>
<div class="line"><a name="l02379"></a><span class="lineno"> 2379</span> <span class="comment"></span></div>
<div class="line"><a name="l02380"></a><span class="lineno"> 2380</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02381"></a><span class="lineno"> 2381</span> <span class="comment"> * @typedef u16giostream.</span></div>
<div class="line"><a name="l02382"></a><span class="lineno"> 2382</span> <span class="comment"> * @brief C++ input/output stream for GIO streams for char16_t type</span></div>
<div class="line"><a name="l02383"></a><span class="lineno"> 2383</span> <span class="comment"> * @anchor u16giostreamAnchor</span></div>
<div class="line"><a name="l02384"></a><span class="lineno"> 2384</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02385"></a><span class="lineno"> 2385</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02386"></a><span class="lineno"><a class="code" href="group__gstreams.html#gafb9359dfb52357482b73c69d8bfcb3a1"> 2386</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream<char16_t></a> <a class="code" href="group__gstreams.html#gafb9359dfb52357482b73c69d8bfcb3a1" title="C++ input/output stream for GIO streams for char16_t type. ">u16giostream</a>;</div>
<div class="line"><a name="l02387"></a><span class="lineno"> 2387</span> <span class="comment"></span></div>
<div class="line"><a name="l02388"></a><span class="lineno"> 2388</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02389"></a><span class="lineno"> 2389</span> <span class="comment"> * @typedef u32gstreambuf.</span></div>
<div class="line"><a name="l02390"></a><span class="lineno"> 2390</span> <span class="comment"> * @brief C++ stream buffer for GIO streams for char32_t type</span></div>
<div class="line"><a name="l02391"></a><span class="lineno"> 2391</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02392"></a><span class="lineno"> 2392</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02393"></a><span class="lineno"><a class="code" href="group__gstreams.html#gaf9472a0a51a96c1f2c8b22e3d825d7db"> 2393</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gstreambuf.html" title="C++ stream buffer for GIO streams. ">basic_gstreambuf<char32_t></a> <a class="code" href="group__gstreams.html#gaf9472a0a51a96c1f2c8b22e3d825d7db" title="C++ stream buffer for GIO streams for char32_t type. ">u32gstreambuf</a>;</div>
<div class="line"><a name="l02394"></a><span class="lineno"> 2394</span> <span class="comment"></span></div>
<div class="line"><a name="l02395"></a><span class="lineno"> 2395</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02396"></a><span class="lineno"> 2396</span> <span class="comment"> * @typedef u32gistream.</span></div>
<div class="line"><a name="l02397"></a><span class="lineno"> 2397</span> <span class="comment"> * @brief C++ input stream for GIO streams for char32_t type</span></div>
<div class="line"><a name="l02398"></a><span class="lineno"> 2398</span> <span class="comment"> * @anchor u32gistreamAnchor</span></div>
<div class="line"><a name="l02399"></a><span class="lineno"> 2399</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02400"></a><span class="lineno"> 2400</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02401"></a><span class="lineno"><a class="code" href="group__gstreams.html#gad065f53dddbd101396e6755a62fe9964"> 2401</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gistream.html" title="C++ input stream for GIO streams. ">basic_gistream<char32_t></a> <a class="code" href="group__gstreams.html#gad065f53dddbd101396e6755a62fe9964" title="C++ input stream for GIO streams for char32_t type. ">u32gistream</a>;</div>
<div class="line"><a name="l02402"></a><span class="lineno"> 2402</span> <span class="comment"></span></div>
<div class="line"><a name="l02403"></a><span class="lineno"> 2403</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02404"></a><span class="lineno"> 2404</span> <span class="comment"> * @typedef u32gostream.</span></div>
<div class="line"><a name="l02405"></a><span class="lineno"> 2405</span> <span class="comment"> * @brief C++ output stream for GIO streams for char32_t type</span></div>
<div class="line"><a name="l02406"></a><span class="lineno"> 2406</span> <span class="comment"> * @anchor u32gostreamAnchor</span></div>
<div class="line"><a name="l02407"></a><span class="lineno"> 2407</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02408"></a><span class="lineno"> 2408</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02409"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga4bdb06d4a5e0d250bb0dc0f8ee2bcb12"> 2409</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__gostream.html" title="C++ output stream for GIO streams. ">basic_gostream<char32_t></a> <a class="code" href="group__gstreams.html#ga4bdb06d4a5e0d250bb0dc0f8ee2bcb12" title="C++ output stream for GIO streams for char32_t type. ">u32gostream</a>;</div>
<div class="line"><a name="l02410"></a><span class="lineno"> 2410</span> <span class="comment"></span></div>
<div class="line"><a name="l02411"></a><span class="lineno"> 2411</span> <span class="comment">/**</span></div>
<div class="line"><a name="l02412"></a><span class="lineno"> 2412</span> <span class="comment"> * @typedef u32giostream.</span></div>
<div class="line"><a name="l02413"></a><span class="lineno"> 2413</span> <span class="comment"> * @brief C++ input/output stream for GIO streams for char32_t type</span></div>
<div class="line"><a name="l02414"></a><span class="lineno"> 2414</span> <span class="comment"> * @anchor u32giostreamAnchor</span></div>
<div class="line"><a name="l02415"></a><span class="lineno"> 2415</span> <span class="comment"> * @ingroup gstreams</span></div>
<div class="line"><a name="l02416"></a><span class="lineno"> 2416</span> <span class="comment"> */</span></div>
<div class="line"><a name="l02417"></a><span class="lineno"><a class="code" href="group__gstreams.html#ga4e5293d03097caa9e1cae43627333358"> 2417</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1basic__giostream.html" title="C++ input-output stream for GIO streams. ">basic_giostream<char32_t></a> <a class="code" href="group__gstreams.html#ga4e5293d03097caa9e1cae43627333358" title="C++ input/output stream for GIO streams for char32_t type. ">u32giostream</a>;</div>
<div class="line"><a name="l02418"></a><span class="lineno"> 2418</span> </div>
<div class="line"><a name="l02419"></a><span class="lineno"> 2419</span> } <span class="comment">// namespace Cgu</span></div>
<div class="line"><a name="l02420"></a><span class="lineno"> 2420</span> </div>
<div class="line"><a name="l02421"></a><span class="lineno"> 2421</span> <span class="preprocessor">#include <c++-gtk-utils/gstream.tpp></span></div>
<div class="line"><a name="l02422"></a><span class="lineno"> 2422</span> </div>
<div class="line"><a name="l02423"></a><span class="lineno"> 2423</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l02424"></a><span class="lineno"> 2424</span> <span class="preprocessor"></span><span class="preprocessor">#warning gstreams are not available: glib >= 2.16.0 is required</span></div>
<div class="line"><a name="l02425"></a><span class="lineno"> 2425</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/*GLIB_CHECK_VERSION(2,16,0)*/</span><span class="preprocessor"></span></div>
<div class="line"><a name="l02426"></a><span class="lineno"> 2426</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l02427"></a><span class="lineno"> 2427</span> <span class="preprocessor">#endif </span><span class="comment">/*CGU_GSTREAM_H*/</span><span class="preprocessor"></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>
