<!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: shared_handle.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">shared_handle.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="shared__handle_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) 2004 to 2013 Chris Vine</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">The library comprised in this file or of which this file is part is</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">distributed by Chris Vine under the GNU Lesser General Public</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">License as follows:</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1 of</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> Lesser General Public License, version 2.1, for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> License, version 2.1, along with this library (see the file LGPL.TXT</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> which came with this source code package in the c++-gtk-utils</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> sub-directory); if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">However, it is not intended that the object code of a program whose</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">source code instantiates a template from this file or uses macros or</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">inline functions (of any length) should by reason only of that</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">instantiation or use be subject to the restrictions of use in the GNU</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">Lesser General Public License. With that in mind, the words "and</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">macros, inline functions and instantiations of templates (of any</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">length)" shall be treated as substituted for the words "and small</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">macros and small inline functions (ten lines or less in length)" in</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">the fourth paragraph of section 5 of that licence. This does not</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">affect any other reason why object code may be subject to the</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">restrictions in that licence (nor for the avoidance of doubt does it</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">affect the application of section 2 of that licence to modifications</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">of the source code in this file).</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef CGU_SHARED_HANDLE_H</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define CGU_SHARED_HANDLE_H</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// define this if, instead of GLIB atomic funcions/memory barriers,</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// you want to use a (slower) mutex to lock the reference count in the</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// SharedLockHandle class</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/* #define CGU_SHARED_LOCK_HANDLE_USE_MUTEX 1 */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include <exception></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include <new></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include <functional></span> <span class="comment">// for std::less and std::hash<T*></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#include <utility></span> <span class="comment">// for std::swap</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#include <cstddef></span> <span class="comment">// for std::size_t</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#include <cstdlib></span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#include <glib.h></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="mutex_8h.html" title="Provides wrapper classes for pthread mutexes and condition variables, and scoped locking classes for ...">c++-gtk-utils/mutex.h</a>></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</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="l00061"></a><span class="lineno"> 61</span> <span class="comment"></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"> * @addtogroup handles handles and smart pointers</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> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">namespace </span>Cgu {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @class SharedHandle shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @brief This is a generic class for managing the lifetime of objects</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * allocated on freestore.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @sa SharedLockHandle</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @sa ScopedHandle</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @sa SharedHandleError</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @sa GcharSharedHandle</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @sa GerrorSharedHandle</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @sa StandardArrayDelete CFree GFree GerrorFree GSliceFree GSliceFreeSize GSliceDestroy</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"> * The SharedHandle class is similar to the SharedPtr class (it keeps</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * a reference count and deletes the handled object when the count</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * reaches 0), but it does not have pointer semantics. Accordingly,</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * it can be used to manage the memory of arrays and other objects</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * allocated on the heap.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * Because it is useful with arrays, by default it deallocates memory</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * using C++ delete[]. However, if a SharedHandle object is passed a</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * function object type as a second template argument when</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * instantiated, it will use that function object to delete memory.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * This enables it to handle the memory of any object, such as objects</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * to be deleted using std::free() or Glib's g_free(), g_list_free()</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * or g_slice_free(). Instances (such as @ref GcharScopedHandleAnchor</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * "GcharScopedHandle", @ref GcharSharedHandleAnchor</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * "GcharSharedHandle", @ref GerrorSharedHandleAnchor</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * "GerrorSharedHandle" and @ref GerrorScopedHandleAnchor</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * "GerrorScopedHandle") typdef'ed for particular deleters can</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * conveniently manage objects of any kind.</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"> * To reflect the fact that it is just a handle for a pointer, it has</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * different instantiation semantics from a SharedPtr object. A</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * SharedPtr object is instantiated using this syntax:</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @code SharedPtr<ObjType> sh_ptr(new ObjType); @endcode</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * A SharedHandle is instantiated using this syntax (note that the</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * instantiated handle is for type T* and not T):</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"> * @code SharedHandle<ObjType*> sh_handle(new ObjType[n]); @endcode</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * Apart from the operatorT() type conversion operator (which returns</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * the underlying pointer), the only other method to obtain the</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * underlying pointer is the get() method. If the object referenced</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * is an array allocated on the heap, to use indexing you could either</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * do this:</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"> * @code</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * SharedHandle<char*> handle(new char[10]);</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * handle.get()[0] = 'a';</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * std::cout << handle.get()[0] << std::endl;</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @endcode</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"> * or this:</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * SharedHandle<char*> handle(new char[10]);</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * handle[0] = 'a';</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * std::cout << handle[0] << std::endl;</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * There is also a SharedLockHandle class, which has a thread-safe</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * reference count, and a ScopedHandle class, which deletes its object</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * as soon as it goes out of scope. A ScopedHandle class can be</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * viewed as a SharedHandle which cannot be assigned to or used as the</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * argument to a copy constructor and therefore which cannot have a</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * reference count of more than 1. It is used where, if you wanted</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * pointer semantics, you might use a const std::auto_ptr<>.</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * SharedHandle objects can be instantiated for pointers to constant</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * objects (such as SharedHandle<const char*>), provided the deleter</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * functor will take such pointers.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * This library provides StandardArrayDelete, CFree, GFree,</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * GerrorFree, GSliceFree, GSliceFreeSize and GSliceDestroy deleter</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * functors, which can be used as the second template parameter of the</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * SharedHandle class. As mentioned above, StandardArrayDelete is the</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * default, and some typedef'ed instances of SharedHandle for gchar</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * (with the GFree deleter) and for GError (with the GerrorFree</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * deleter) are provided.</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"> * @b Comparison @b with @b std::shared_ptr</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * Although the semantics of std::shared_ptr in C++11 are not</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * particularly suited to managing either arrays or C objects with</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * accessor functions (such as in glib), most of the things that can</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * be done by this class can be done by using std::shared_ptr with a</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * specialised deleter. However, this class is retained in the</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * c++-gtk-utils library not only to retain compatibility with series</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * 1.2 of the library, but also to cater for some cases not met (or</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * not so easily met) by std::shared_ptr:</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"> * 1. The Cgu::SharedHandle class takes its deleter as a template</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * parameter, which means that typedefs can be used to enable</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * handles for particular deleters to be easily created (and as</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * mentioned, this library provides a number of pre-formed deleter</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * functors and typedefs for them). With std::shared_ptr, custom</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * deleters must be passed to the shared_ptr constructor on every</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * occasion a shared_ptr is constructed to manage a new object (and</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * they cannot be templated as a typedef).</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * 2. Glib memory slices provide an efficient small object allocator</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * (they are likely to be significantly more efficient than global</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * operator new()/new[](), which generally hand off to malloc(),</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * and whilst malloc() is good for large block allocations it is</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * generally poor as a small object allocator). Internal</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * Cgu::SharedHandle allocation using glib memory slices can be</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * achieved by compiling the library with the</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * 3. If glib memory slices are not used (which do not throw),</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * constructing a shared pointer for a new managed object (or</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * calling reset() for a new managed object) might throw if</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * internal allocation fails. Although by default the</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * Cgu::SharedHandle implementation will delete the new managed</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * object in such a case, it also provides an alternative</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * constructor and reset() method which instead enable the new</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * object to be accessed via the thrown exception object so that</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * user code can decide what to do; std::shared_ptr deletes the new</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * object in every case.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * 4. A user can explicitly state whether the shared handle object is</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * to have atomic increment and decrement-and-test with respect to</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * the reference count so that the reference count is thread safe</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * ('no' in the case of Cgu::SharedHandle, and 'yes' in the case of</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * Cgu::SharedLockHandle). Using atomic functions is unnecessary</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * if the managed object concerned is only addressed in one thread</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * (and might cause unwanted cache flushing in certain</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * circumstances). std::shared_ptr will generally always use</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * atomic functions with respect to its reference count in a</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * multi-threaded program.</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * In favour of std::shared_ptr, it has an associated std::weak_ptr</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * class, which Cgu::SharedHandle does not (there is a</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * Cgu::GobjWeakHandle class, but that is cognate with Cgu::GobjHandle</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * and is only usable with GObjects).</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * If the library is compiled with the</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, as</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * mentioned Cgu::SharedHandle constructs its reference counting</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * internals using glib memory slices. Although it is safe in a</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * multi-threaded program if glib < 2.32 is installed to construct a</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * static SharedHandle object in global namespace (that is, prior to</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * g_thread_init() being called) by means of the default constructor</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * and/or a pointer argument of NULL, it is not safe if constructed</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * with a non-NULL pointer value. If glib >= 2.32 is installed,</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * global objects with memory slices are safe in all</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * circumstances. (Having said that, it would be highly unusual to</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * have global SharedHandle objects.)</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment">/********************* here are some deleter classes *******************/</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"></span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * @class StandardArrayDelete shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * template classes, which calls the C++ delete[] expression.</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * @details This functor enables those classes to manage arrays</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * created with the new expression. It is the default type of the</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * second template paramenter of those classes.</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"><a class="code" href="classCgu_1_1StandardArrayDelete.html"> 232</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="classCgu_1_1StandardArrayDelete.html" title="A deleter functor for use as the second (Dealloc) template parameter of the SharedHandle, SharedLockHandle or ScopedHandle template classes, which calls the C++ delete[] expression. ">StandardArrayDelete</a> {</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00234"></a><span class="lineno"><a class="code" href="classCgu_1_1StandardArrayDelete.html#a3cc17ab6df8b3b9b35f8a111410c194b"> 234</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1StandardArrayDelete.html#a3cc17ab6df8b3b9b35f8a111410c194b">operator()</a>(T obj) {</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keyword">delete</span>[] obj;</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  }</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> };</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"></span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @class CFree shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * template classes, which calls std::free.</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * @details This functor enables those classes to manage memory</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * allocated with std::malloc(), std::calloc() and std::realloc().</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"><a class="code" href="classCgu_1_1CFree.html"> 248</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1CFree.html" title="A deleter functor for use as the second (Dealloc) template parameter of the SharedHandle, SharedLockHandle or ScopedHandle template classes, which calls std::free. ">CFree</a> {</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00250"></a><span class="lineno"><a class="code" href="classCgu_1_1CFree.html#a31e6d43a98af1d8cd4837925f2eba643"> 250</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1CFree.html#a31e6d43a98af1d8cd4837925f2eba643">operator()</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* obj) noexcept {</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  std::free(const_cast<void*>(obj));</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  }</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> };</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"></span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * @class GFree shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * template classes, which calls glib's g_free().</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * @details This functor enables those classes to manage memory</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> * allocated by glib or gtk+ functions which requires to be freed with</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * g_free(). It is used in the typedefs @ref GcharSharedHandleAnchor</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * "GcharSharedHandle" and @ref GcharScopedHandleAnchor</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * "GcharScopedHandle".</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"><a class="code" href="classCgu_1_1GFree.html"> 267</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1GFree.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_free(). ">GFree</a> {</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00269"></a><span class="lineno"><a class="code" href="classCgu_1_1GFree.html#a0d611b28ace1323506fb3f52acb0006e"> 269</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GFree.html#a0d611b28ace1323506fb3f52acb0006e">operator()</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* obj) noexcept {</div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  g_free(const_cast<void*>(obj));</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  }</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> };</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"></span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * @class GSliceFree shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * template classes, which calls glib's g_slice_free1().</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * @details This functor enables those classes to manage a memory</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * block allocated using glib memory slices. The managed memory block</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * to be deleted by the GSliceFree functor must have the same size as</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * the size of the object for which the functor is instantiated by</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> * pointer, as for example as allocated with the g_slice_new,</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * g_slice_new0 or g_slice_dup macros (in other words, the GSliceFree</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * template parameter must match the argument passed to those macros):</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * see the example below. Use GSliceFreeSize where it is necessary or</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * more convenient to have the size of the block to be freed as the</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * template parameter. Use GSliceDestroy where the memory holds a C++</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * object constructed in the memory by the global placement new</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * expression.</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> * The type of the template argument for the functor is a pointer to</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * the managed type: it is the same as the first template argument of</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * the relevant SharedHandle, SharedLockHandle or ScopedHandle object.</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> * For example:</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * SharedHandle<MyStruct*, GSliceFree<MyStruct*> > h(g_slice_new(MyStruct));</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * @endcode</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"> * The availability of this functor is not dependent on the library</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * having been installed with the \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option (see @ref</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * Memory for further details of those options).</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"><a class="code" href="classCgu_1_1GSliceFree.html"> 310</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="classCgu_1_1GSliceFree.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(). ">GSliceFree</a> {</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00312"></a><span class="lineno"><a class="code" href="classCgu_1_1GSliceFree.html#a8d27d2141e928a82d85362736548d885"> 312</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GSliceFree.html#a8d27d2141e928a82d85362736548d885">operator()</a>(T obj) noexcept {</div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  g_slice_free1(<span class="keyword">sizeof</span>(*obj), (<span class="keywordtype">void</span>*)obj);</div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  }</div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> };</div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"></span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * @class GSliceDestroy shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * template classes, which calls glib's g_slice_free1(), but before</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * doing so also explicitly calls the destructor of a C++ object</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * constructed in the memory.</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * @details The managed memory block to be deleted by the</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * GSliceDestroy functor must have the same size as the size of the</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * object for which the functor is instantiated by pointer, as for</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * example as allocated with the g_slice_new or g_slice_new0 macros</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * (in other words, the GSliceDestroy template parameter must match</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * the argument passed to those macros), and the memory block must</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * have had that object constructed in it with the global placement</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * new expression: see the example below. Sometimes it is more</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * convenient to implement C++ objects in glib memory slices that way,</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * rather than to have custom new and delete member operators of the</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * classes concerned which use glib's g_slice_*(). However, a</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * SharedHandle class with a GSliceDestroy deleter is not as easy to</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * use as the SharedPtr class, as SharedHandle has no operator*() nor</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * operator->() method (the get() method would have to be used to</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * obtain the underlying pointer).</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * One consequence of the static sizing (and so typing) of memory</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * slices is that a GSliceDestroy object instantiated for the</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * management of a particular class must not be used by a</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * SharedHandle, SharedLockHandle or ScopedHandle object which</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * attempts to manage a class derived from it. This comes back to the</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * point that the GSliceDestroy template parameter must match the</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * argument passed to the g_slice_new or g_slice_new0 macros.</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * The type of the template argument for the functor is a pointer to</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * the managed type: it is the same as the first template argument of</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * the relevant SharedHandle, SharedLockHandle or ScopedHandle object.</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * For example, to construct a SharedHandle managing an object of type</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * MyClass to be constructed in a glib memory slice in an exception</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> * safe way:</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * SharedHandle<MyClass*, GSliceDestroy<MyClass*> > h; // won't throw</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * { // scope block for p variable</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * MyClass* p = g_slice_new(MyClass);</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * try {new(p) MyClass;} // MyClass constructor might throw</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * catch(...) {</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * g_slice_free(MyClass, p);</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> * throw;</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * h.reset(p); // might throw but if so cleans up</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> * The availability of this functor is not dependent on the library</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * having been installed with the \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option (see @ref</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * Memory for further details of those options).</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"><a class="code" href="classCgu_1_1GSliceDestroy.html"> 377</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="classCgu_1_1GSliceDestroy.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(), but before doing so also explicitly calls the destructor of a C++ object constructed in the memory. ">GSliceDestroy</a> {</div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <span class="keyword">template</span> <<span class="keyword">class</span> U> <span class="keywordtype">void</span> destroy(U& obj) {obj.~U();}</div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00380"></a><span class="lineno"><a class="code" href="classCgu_1_1GSliceDestroy.html#ab28d41ffb0e7c7d82373d282dcd04698"> 380</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GSliceDestroy.html#ab28d41ffb0e7c7d82373d282dcd04698">operator()</a>(T obj) {</div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  destroy(*obj);</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  g_slice_free1(<span class="keyword">sizeof</span>(*obj), (<span class="keywordtype">void</span>*)obj);</div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  }</div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> };</div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"></span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> * @class GSliceFreeSize shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * template classes, which calls glib's g_slice_free1().</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * @details This functor enables those classes to manage memory</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> * allocated with g_slice_alloc(), g_slice_alloc0() or g_slice_copy().</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> * It is an alternative to using GSliceFree where, instead of the</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> * template parameter being a pointer to a particular managed type,</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> * the size of the memory block to be freed is passed, so enabling it</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * to be more conveniently used to free memory containing arrays of</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * built-in types or of PODSs. Use GSliceDestroy where the memory</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * holds a C++ object constructed in the memory by the global</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * placement new expression.</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * The type of the template argument for the functor is an integer</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * type (gsize) and is the size of the block to be managed. For</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * example:</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> * SharedHandle<char*, GSliceFreeSize<10> > h(static_cast<char*>(g_slice_alloc(10)));</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"> * @endcode</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * The availability of this functor is not dependent on the library</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * having been installed with the \--with-glib-memory-slices-compat or</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option (see @ref</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * Memory for further details of those options).</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"><a class="code" href="classCgu_1_1GSliceFreeSize.html"> 418</a></span> <span class="keyword">template</span> <gsize block_size> <span class="keyword">class </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</a> {</div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00420"></a><span class="lineno"><a class="code" href="classCgu_1_1GSliceFreeSize.html#ad0a04ed0e005e74e9e3f82e4f8b9c0cc"> 420</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GSliceFreeSize.html#ad0a04ed0e005e74e9e3f82e4f8b9c0cc">operator()</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* obj) noexcept {</div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  g_slice_free1(block_size, const_cast<void*>(obj));</div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  }</div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> };</div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> </div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> * we could provide a functor class for</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> * g_slice_free_chain_with_offset() such as:</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> * template <class T, gsize offset> class GSliceFreeChain {</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * public:</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> * void operator()(T obj) {</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> * g_slice_free_chain_with_offset(sizeof(*obj), (void*)obj, offset);</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * };</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"> * However, this is not going to be particularly useful because the</span></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> * G_STRUCT_OFFSET macro and/or C's offsetof macro, needed to provide</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> * the value for the offset parameter, do not work for other than</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> * PODSs. g_slice_free_chain_with_offset() is intended for internal</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> * implementations and in the event of a user wanting such memory</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> * management it is best achieved by having custom new[] and delete[]</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * member operators of the class concerned which use glib's</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> * g_slice_*() directly.</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> </div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment">/********************* define some typedefs for Glib ******************/</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> </div>
<div class="line"><a name="l00448"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html"> 448</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc> <span class="keyword">class </span><a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a>;</div>
<div class="line"><a name="l00449"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html"> 449</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc> <span class="keyword">class </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>;</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"></span></div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment"> * @typedef GcharSharedHandle.</span></div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"> * @brief A handle comprising a typed instance of the SharedHandle</span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> * class for gchar* arrays and strings</span></div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"> * @anchor GcharSharedHandleAnchor</span></div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> * \#include <c++-gtk-utils/shared_handle.h></span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"><a class="code" href="group__handles.html#ga94036be619198b2869bebd18b876978d"> 459</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1SharedHandle.html">SharedHandle<gchar*, GFree></a> <a class="code" href="group__handles.html#ga94036be619198b2869bebd18b876978d" title="A handle comprising a typed instance of the SharedHandle class for gchar* arrays and strings...">GcharSharedHandle</a>;</div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"></span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> * @typedef GcharScopedHandle.</span></div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> * @brief A handle comprising a typed instance of the ScopedHandle</span></div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> * class for gchar* arrays and strings</span></div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> * @anchor GcharScopedHandleAnchor</span></div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> * \#include <c++-gtk-utils/shared_handle.h></span></div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00469"></a><span class="lineno"><a class="code" href="group__handles.html#ga3950c0b1540591717adfaf48555eca80"> 469</a></span> <span class="keyword">typedef</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<gchar*, GFree></a> <a class="code" href="group__handles.html#ga3950c0b1540591717adfaf48555eca80" title="A handle comprising a typed instance of the ScopedHandle class for gchar* arrays and strings...">GcharScopedHandle</a>;</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> </div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment">/******************* now the handle class definitions *****************/</span></div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"></span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> * @class SharedHandleError shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> * @brief This is an exception struct thrown as an alternative to</span></div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> * deleting a managed object when internal memory allocation for</span></div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> * SharedHandle or SharedLockHandle fails in their reset() method or</span></div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> * in their constructor which takes a pointer.</span></div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> * @sa SharedHandle SharedLockHandle SharedHandleAllocFail</span></div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> * This is an exception struct thrown as an alternative to deleting a</span></div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> * managed object when SharedHandle<T>::SharedHandle(T),</span></div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> * SharedLockHandle<T>::SharedLockHandle(T), SharedHandle<T>::reset(T)</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> * or SharedLockHandle<T>::reset(T) would otherwise throw</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> * std::bad_alloc. To make those methods do that,</span></div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> * Cgu::SharedHandleAllocFail::leave is passed as their second</span></div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"> * argument.</span></div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> * If the exception is thrown, the struct has a member 'obj' of type</span></div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> * T, which is a pointer to the object or array originally passed to</span></div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> * those methods, so the user can deal with it appropriately. This</span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> * enables the result of the new expression to be passed directly as</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * the argument to those methods without giving rise to a resource</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> * leak, as in:</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * SharedHandle<T*> s; // doesn't throw</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> * try {</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> * s.reset(new T[2], SharedHandleAllocFail::leave); // both T allocation and reset() might throw</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> * catch (std::bad_alloc&) {</span></div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> * catch (SharedHandleError<T*>& e) {</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> * e.obj[0].do_something();</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> * e.obj[1].do_something();</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> * @endcode </span></div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> * As above, a catch block will need to deal with std::bad_alloc (if</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> * the call to the new expression when creating the T object fails)</span></div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> * as well as SharedHandleError (if the call to the new expression in</span></div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> * the reset() method fails after a valid T object has been</span></div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> * constructed).</span></div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> </div>
<div class="line"><a name="l00522"></a><span class="lineno"><a class="code" href="structCgu_1_1SharedHandleError.html"> 522</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">struct </span><a class="code" href="structCgu_1_1SharedHandleError.html" title="This is an exception struct thrown as an alternative to deleting a managed object when internal memor...">SharedHandleError</a>: <span class="keyword">public</span> std::exception {</div>
<div class="line"><a name="l00523"></a><span class="lineno"><a class="code" href="structCgu_1_1SharedHandleError.html#a5341599c0e330e8939050ba59da332e2"> 523</a></span>  T <a class="code" href="structCgu_1_1SharedHandleError.html#a5341599c0e330e8939050ba59da332e2">obj</a>;</div>
<div class="line"><a name="l00524"></a><span class="lineno"><a class="code" href="structCgu_1_1SharedHandleError.html#a50acf3a14333030ba0735db024cffbe5"> 524</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structCgu_1_1SharedHandleError.html#a50acf3a14333030ba0735db024cffbe5">what</a>() <span class="keyword">const</span> throw() {<span class="keywordflow">return</span> <span class="stringliteral">"SharedHandleError\n"</span>;}</div>
<div class="line"><a name="l00525"></a><span class="lineno"><a class="code" href="structCgu_1_1SharedHandleError.html#af5efdd9b8be48e7d6869392b8bf6c130"> 525</a></span>  <a class="code" href="structCgu_1_1SharedHandleError.html#af5efdd9b8be48e7d6869392b8bf6c130">SharedHandleError</a>(T p): <a class="code" href="structCgu_1_1SharedHandleError.html#a5341599c0e330e8939050ba59da332e2">obj</a>(p) {}</div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> };</div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"></span></div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> * enum Cgu::SharedHandleAllocFail::Leave</span></div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> * The enumerator Cgu::SharedHandleAllocFail::leave is passed as the</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> * second argument of the reset() method of SharedHandle or</span></div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> * SharedLockHandle in order to prevent the method deleting the object</span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> * passed to it if reset() fails internally because of memory</span></div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> * exhaustion.</span></div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00537"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html"> 537</a></span> <span class="keyword">namespace </span>SharedHandleAllocFail {</div>
<div class="line"><a name="l00538"></a><span class="lineno"><a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165ba06b3691e0b5b46d8d138c67a100397a5"> 538</a></span>  <span class="keyword">enum</span> <a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165b">Leave</a> {<a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165ba06b3691e0b5b46d8d138c67a100397a5">leave</a>};</div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> }</div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> </div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc = StandardArrayDelete<T>> <span class="keyword">class </span>SharedHandle {</div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> </div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  Dealloc deleter;</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> </div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="preprocessor">#ifndef DOXYGEN_PARSING</span></div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="preprocessor"></span> <span class="keyword">struct </span>RefItems {</div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* ref_count_p;</div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  T obj;</div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  } ref_items;</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  <span class="keywordtype">void</span> unreference() {</div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keywordflow">if</span> (!ref_items.ref_count_p) <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  --(*ref_items.ref_count_p);</div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  <span class="keywordflow">if</span> (*ref_items.ref_count_p == 0) {</div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="preprocessor">#ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="preprocessor"></span> g_slice_free(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, ref_items.ref_count_p);</div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="preprocessor"></span> <span class="keyword">delete</span> ref_items.ref_count_p;</div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="preprocessor"></span> deleter(ref_items.obj);</div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>  }</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  }</div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> </div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  <span class="keywordtype">void</span> reference() noexcept {</div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  <span class="keywordflow">if</span> (!ref_items.ref_count_p) <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  ++(*ref_items.ref_count_p);</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  }</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> </div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * Constructor taking an unmanaged object.</span></div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> * @param ptr The object which the SharedHandle is to manage (if</span></div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> * any).</span></div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> * @exception std::bad_alloc This constructor will not throw if the</span></div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> * 'ptr' argument has a NULL value (the default), otherwise it might</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> * throw std::bad_alloc if memory is exhausted and the system throws</span></div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> * in that case. If such an exception is thrown, this constructor is</span></div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> * exception safe (it does not leak resources), but as well as</span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> * cleaning itself up this constructor will also delete the managed</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> * object passed to it to avoid a memory leak. If such automatic</span></div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> * deletion is not wanted in that case, use the version of this</span></div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> * constructor taking a Cgu::SharedHandleAllocFail::Leave tag argument.</span></div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> * @note std::bad_alloc will not be thrown if the library has been</span></div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> * installed using the \--with-glib-memory-slices-no-compat</span></div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> * configuration option: instead glib will terminate the program if it</span></div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> * is unable to obtain memory from the operating system.</span></div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00589"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#a35312198a5c402ade385d0df8eaf6c7f"> 589</a></span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1SharedHandle.html#a35312198a5c402ade385d0df8eaf6c7f">SharedHandle</a>(T ptr = 0) {</div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> </div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span>  <span class="keywordflow">if</span> ((ref_items.obj = ptr)) { <span class="comment">// not NULL</span></div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="preprocessor">#ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="preprocessor"></span> ref_items.ref_count_p = g_slice_new(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  *ref_items.ref_count_p = 1;</div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  ref_items.ref_count_p = <span class="keyword">new</span> <span class="keywordtype">unsigned</span> int(1);</div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  }</div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  deleter(ptr); <span class="comment">// if allocating the int referenced by ref_items.ref_count_p</span></div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  <span class="comment">// has failed then delete the object to be referenced to</span></div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span>  <span class="comment">// avoid a memory leak</span></div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>  <span class="keywordflow">throw</span>;</div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span>  }</div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span>  <span class="keywordflow">else</span> ref_items.ref_count_p = 0;</div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>  }</div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"></span></div>
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> * Constructor taking an unmanaged object.</span></div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> * @param ptr The object which the SharedHandle is to manage</span></div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> * @param tag Passing the tag emumerator</span></div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> * Cgu::SharedHandleAllocFail::leave causes this constructor not to</span></div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"> * delete the new managed object passed as the 'ptr' argument in the</span></div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> * event of internal allocation in this method failing because of</span></div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> * memory exhaustion (in that event, Cgu::SharedHandleError will be</span></div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"> * thrown).</span></div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> * @exception Cgu::SharedHandleError This constructor might throw</span></div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> * Cgu::SharedHandleError if memory is exhausted and the system would</span></div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> * otherwise throw std::bad_alloc in that case. This constructor is</span></div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> * exception safe (it does not leak resources), and if such an</span></div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> * exception is thrown it will clean itself up, but it will not</span></div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> * attempt to delete the new managed object passed to it. Access to</span></div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> * the object passed to the 'ptr' argument can be obtained via the</span></div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> * thrown Cgu::SharedHandleError object.</span></div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> * @note 1. On systems with over-commit/lazy-commit combined with</span></div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> * virtual memory (swap), it is rarely useful to check for memory</span></div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> * exhaustion, so in those cases this version of the constructor will</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> * not be useful.</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="comment"> * @note 2. If the library has been installed using the</span></div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option this</span></div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"> * version of the constructor will also not be useful: instead glib</span></div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment"> * will terminate the program if it is unable to obtain memory from</span></div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment"> * the operating system.</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"><a class="code" href="classCgu_1_1SharedHandle.html#aa41809c2268597ca0285c04e672efcb5"> 637</a></span>  <a class="code" href="classCgu_1_1SharedHandle.html#aa41809c2268597ca0285c04e672efcb5">SharedHandle</a>(T ptr, <a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165b">Cgu::SharedHandleAllocFail::Leave</a> tag) {</div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> </div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span>  <span class="keywordflow">if</span> ((ref_items.obj = ptr)) { <span class="comment">// not NULL</span></div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="preprocessor">#ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="preprocessor"></span> ref_items.ref_count_p = g_slice_new(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>  *ref_items.ref_count_p = 1;</div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span>  ref_items.ref_count_p = <span class="keyword">new</span> <span class="keywordtype">unsigned</span> int(1);</div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>  }</div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span>  <span class="keywordflow">catch</span> (std::bad_alloc&) { <span class="comment">// as we are not rethrowing, make NPTL friendly</span></div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>  <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1SharedHandleError.html" title="This is an exception struct thrown as an alternative to deleting a managed object when internal memor...">SharedHandleError<T></a>(ptr);</div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span>  }</div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span>  <span class="keywordflow">else</span> ref_items.ref_count_p = 0;</div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>  }</div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"></span></div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> * Causes the SharedHandle to cease to manage its managed object (if</span></div>
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> * any), deleting it if this is the last SharedHandle object managing</span></div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> * it. If the argument passed is not NULL, the SharedHandle object</span></div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> * will manage the new object passed (which must not be managed by any</span></div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> * other SharedHandle object). This method is exception safe, but see</span></div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> * the comments below on std::bad_alloc.</span></div>
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> * @param ptr NULL (the default), or a new unmanaged object to manage.</span></div>
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"> * @exception std::bad_alloc This method will not throw if the 'ptr'</span></div>
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> * argument has a NULL value (the default) and the destructor of a</span></div>
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> * managed object does not throw, otherwise it might throw</span></div>
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws in that</span></div>
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> * case. Note that if such an exception is thrown then this method</span></div>
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> * will do nothing (it is strongly exception safe and will continue to</span></div>
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> * manage the object it was managing prior to the call), except that</span></div>
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> * it will delete the new managed object passed to it to avoid a</span></div>
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> * memory leak. If such automatic deletion in the event of such an</span></div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> * exception is not wanted, use the reset() method taking a</span></div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> * Cgu::SharedHandleAllocFail::Leave tag type as its second argument.</span></div>
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> * @note std::bad_alloc will not be thrown if the library has been</span></div>
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> * installed using the \--with-glib-memory-slices-no-compat</span></div>
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> * configuration option: instead glib will terminate the program if it</span></div>
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> * is unable to obtain memory from the operating system.</span></div>
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00679"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#ae9136ce2ffe6c3787f3ab28f23718659"> 679</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1SharedHandle.html#ae9136ce2ffe6c3787f3ab28f23718659">reset</a>(T ptr = 0) {</div>
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a> tmp(ptr);</div>
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(ref_items, tmp.ref_items);</div>
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>  }</div>
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment"></span></div>
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"> * Causes the SharedHandle to cease to manage its managed object (if</span></div>
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> * any), deleting it if this is the last SharedHandle object managing</span></div>
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> * it. The SharedHandle object will manage the new object passed</span></div>
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> * (which must not be managed by any other SharedHandle object). This</span></div>
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> * method is exception safe, but see the comments below on</span></div>
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> * Cgu::SharedHandleError.</span></div>
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> * @param ptr A new unmanaged object to manage (if no new object is to</span></div>
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> * be managed, use the version of reset() taking a default value of</span></div>
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"> * NULL).</span></div>
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> * @param tag Passing the tag emumerator</span></div>
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> * Cgu::SharedHandleAllocFail::leave causes this method not to delete</span></div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> * the new managed object passed as the 'ptr' argument in the event of</span></div>
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment"> * internal allocation in this method failing because of memory</span></div>
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment"> * exhaustion (in that event, Cgu::SharedHandleError will be thrown).</span></div>
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment"> * @exception Cgu::SharedHandleError This method might throw</span></div>
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment"> * Cgu::SharedHandleError if memory is exhausted and the system would</span></div>
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> * otherwise throw std::bad_alloc in that case. Note that if such an</span></div>
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment"> * exception is thrown then this method will do nothing (it is</span></div>
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"> * strongly exception safe and will continue to manage the object it</span></div>
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"> * was managing prior to the call), and it will not attempt to delete</span></div>
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> * the new managed object passed to it. Access to the object passed</span></div>
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> * to the 'ptr' argument can be obtained via the thrown</span></div>
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> * Cgu::SharedHandleError object.</span></div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment"> * @note 1. On systems with over-commit/lazy-commit combined with</span></div>
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment"> * virtual memory (swap), it is rarely useful to check for memory</span></div>
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"> * exhaustion, so in those cases this version of the reset() method</span></div>
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment"> * will not be useful.</span></div>
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"> * @note 2. If the library has been installed using the</span></div>
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option this</span></div>
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> * version of the reset() method will also not be useful: instead glib</span></div>
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment"> * will terminate the program if it is unable to obtain memory from</span></div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"> * the operating system.</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"><a class="code" href="classCgu_1_1SharedHandle.html#aec07a846d53089b8e0ef5f7da7b9c095"> 718</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1SharedHandle.html#aec07a846d53089b8e0ef5f7da7b9c095">reset</a>(T ptr, <a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165b">Cgu::SharedHandleAllocFail::Leave</a> tag) {</div>
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span>  <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a> tmp(ptr, tag);</div>
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(ref_items, tmp.ref_items);</div>
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span>  }</div>
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"></span></div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> * The copy constructor does not throw.</span></div>
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"> * @param sh_hand The handle to be copied.</span></div>
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00727"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#a55314bf87a12596bc469573ab6088be1"> 727</a></span>  <a class="code" href="classCgu_1_1SharedHandle.html#a55314bf87a12596bc469573ab6088be1">SharedHandle</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a>& sh_hand) noexcept {</div>
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span>  ref_items = sh_hand.ref_items;</div>
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span>  reference();</div>
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span>  }</div>
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment"></span></div>
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment"> * The move constructor does not throw. It has move semantics.</span></div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> * @param sh_hand The handle to be moved.</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"><a class="code" href="classCgu_1_1SharedHandle.html#a456a9691940c377a8598090c1648bac4"> 736</a></span>  <a class="code" href="classCgu_1_1SharedHandle.html#a456a9691940c377a8598090c1648bac4">SharedHandle</a>(<a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a>&& sh_hand) noexcept {</div>
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span>  ref_items = sh_hand.ref_items;</div>
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span>  sh_hand.ref_items.ref_count_p = 0;</div>
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span>  sh_hand.ref_items.obj = 0;</div>
<div class="line"><a name="l00740"></a><span class="lineno"> 740</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"> /**</span></div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="comment"> * This method (and so copy or move assignment) does not throw unless</span></div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="comment"> * the destructor of a managed object throws.</span></div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="comment"> * @param sh_hand the assignor.</span></div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment"> * @return The SharedHandle object after assignment.</span></div>
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span>  <span class="comment">// having a value type as the argument, rather than reference to const</span></div>
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span>  <span class="comment">// and then initialising a tmp object, gives the compiler more scope</span></div>
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span>  <span class="comment">// for optimisation, and also caters for r-values without a separate</span></div>
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span>  <span class="comment">// overload</span></div>
<div class="line"><a name="l00752"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#a211232192172ffc4f1395e7a9a2ef44d"> 752</a></span>  <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a>& <a class="code" href="classCgu_1_1SharedHandle.html#a211232192172ffc4f1395e7a9a2ef44d">operator=</a>(<a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle</a> sh_hand) {</div>
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(ref_items, sh_hand.ref_items);</div>
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</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"> /**</span></div>
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment"> * @return A pointer to the handled object (or NULL if none is</span></div>
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00762"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#ae77be2719195188101e976729f2a05e3"> 762</a></span>  T <span class="keyword">get</span>() <span class="keyword">const</span> noexcept {<span class="keywordflow">return</span> ref_items.obj;}</div>
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment"></span></div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"> * @return A pointer to the handled object (or NULL if none is</span></div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00769"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#a3c4ba8812ec93249414254428f59b67a"> 769</a></span>  <span class="keyword">operator</span> T() const noexcept {<span class="keywordflow">return</span> ref_items.obj;}</div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment"></span></div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment"> * @return The number of SharedHandle objects referencing the managed</span></div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment"> * object (or 0 if none is managed by this SharedHandle).</span></div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00776"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#a151885611f8037425190e5ee6ec308aa"> 776</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1SharedHandle.html#a151885611f8037425190e5ee6ec308aa">get_refcount</a>() const noexcept {<span class="keywordflow">return</span> (ref_items.ref_count_p) ? *ref_items.ref_count_p : 0;}</div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="comment"></span></div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment"> * The destructor does not throw unless the destructor of a handled</span></div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment"> * object throws - that should never happen.</span></div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00782"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedHandle.html#afaca9808657736fe90dcb75f837c9d95"> 782</a></span>  <a class="code" href="classCgu_1_1SharedHandle.html#afaca9808657736fe90dcb75f837c9d95">~SharedHandle</a>() {unreference();}</div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span> };</div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="comment"></span></div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment"> * @class ScopedHandle shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> * @brief This is a generic scoped class for managing the lifetime of objects</span></div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"> * allocated on freestore.</span></div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="comment"> * @sa SharedHandle SharedLockHandle SharedHandleError</span></div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment"> * @sa StandardArrayDelete CFree GFree GerrorFree GSliceFree GSliceFreeSize GSliceDestroy</span></div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment"> * This class deletes its object as soon as it goes out of scope. It</span></div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="comment"> * can be viewed as a SharedHandle which cannot be copy assigned to or</span></div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment"> * used as the argument to a copy constructor and therefore which</span></div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="comment"> * cannot have a reference count of more than 1.</span></div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="comment"> * ScopedHandle objects can be instantiated for pointers to constant</span></div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="comment"> * objects (such as ScopedHandle<const char*>), provided the deleter</span></div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="comment"> * functor will take such pointers.</span></div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment"> * This library provides StandardArrayDelete, CFree, GFree,</span></div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment"> * GerrorFree, GSliceFree, GSliceFreeSize and GSliceDestroy deleter</span></div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"> * functors, which can be used as the second template parameter of the</span></div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> * ScopedHandle class. StandardArrayDelete is the default, and some</span></div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> * typedef'ed instances of ScopedHandle for gchar (with the GFree</span></div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment"> * deleter) and for GError (with the GerrorFree deleter) are provided:</span></div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="comment"> * @ref GcharScopedHandleAnchor "GcharScopedHandle" and @ref</span></div>
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment"> * GerrorScopedHandleAnchor "GerrorScopedHandle")</span></div>
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="comment"> * @b Comparison @b with @b std::unique_ptr</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"> * This class is mainly retained to retain compatibility with series</span></div>
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"> * 1.2 of the library, since most of the things that can be done with</span></div>
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"> * it can also be done using std::unique_ptr. However, this class is</span></div>
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment"> * a little easier to use when managing objects with associated C</span></div>
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"> * functions (such as in glib), because it provides a type conversion</span></div>
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> * operator.</span></div>
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment"> * From version 2.2.2, this class has a move constructor and move</span></div>
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span> <span class="comment"> * assignment operator. Prior to that, it could not be moved from or</span></div>
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment"> * to.</span></div>
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> </div>
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc = StandardArrayDelete<T>> <span class="keyword">class </span>ScopedHandle {</div>
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span>  Dealloc deleter;</div>
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span>  T obj;</div>
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment"> * This class cannot be copied. The copy constructor is deleted.</span></div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>  <a class="code" href="classCgu_1_1ScopedHandle.html#ad2eb977f01fa77650f4bee7cd98e27bb">ScopedHandle</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1ScopedHandle.html#ad2eb977f01fa77650f4bee7cd98e27bb">ScopedHandle</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="comment"></span></div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment"> * This class cannot be copied. The copy assignment operator is</span></div>
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment"> * deleted.</span></div>
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span>  <a class="code" href="classCgu_1_1ScopedHandle.html#ad2eb977f01fa77650f4bee7cd98e27bb">ScopedHandle</a>& <a class="code" href="classCgu_1_1ScopedHandle.html#a99c84ced2d26f53ffe80ccca89a1b2e4">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1ScopedHandle.html#ad2eb977f01fa77650f4bee7cd98e27bb">ScopedHandle</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment"></span></div>
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment"> * The move constructor does not throw.</span></div>
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"> * @param sc_hand The handle to be moved.</span></div>
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="comment"> * Since 2.0.19/2.2.2</span></div>
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00846"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#a338dbeeb32e520f1dcc10924838bdb22"> 846</a></span>  <a class="code" href="classCgu_1_1ScopedHandle.html#a338dbeeb32e520f1dcc10924838bdb22">ScopedHandle</a>(<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>&& sc_hand) noexcept {</div>
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span>  obj = sc_hand.obj;</div>
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span>  sc_hand.obj = 0;</div>
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span>  }</div>
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment"></span></div>
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment"> * The move assignment operator. It will delete the object managed</span></div>
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment"> * prior to the move, if any. It does not throw unless the destructor</span></div>
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment"> * of that object throws.</span></div>
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"> * @param sc_hand The handle to be moved.</span></div>
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"> * @return The ScopedHandle object after move assignment.</span></div>
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"> * Since 2.0.19/2.2.2</span></div>
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00860"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#a296ee1fb0cc8d6b6dc6530aaf02115e3"> 860</a></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_1ScopedHandle.html#a296ee1fb0cc8d6b6dc6530aaf02115e3">operator=</a>(<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>&& sc_hand) {</div>
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span>  <a class="code" href="classCgu_1_1ScopedHandle.html#a1d3bbbe7039f33ffada38b1057947c3a">reset</a>(sc_hand.release());</div>
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span>  }</div>
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment"></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"> * This constructor does not throw.</span></div>
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment"> * @param ptr The object which the ScopedHandle is to manage (if</span></div>
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment"> * any).</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> <span class="comment"> * ScopedHandle objects can be instantiated for pointers to constant</span></div>
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="comment"> * objects (such as SharedHandle<const char*>), provided the deleter</span></div>
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span> <span class="comment"> * functor will take such pointers.</span></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"><a class="code" href="classCgu_1_1ScopedHandle.html#a5d2d5bcb098896007ea828ef36710013"> 874</a></span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1ScopedHandle.html#a5d2d5bcb098896007ea828ef36710013">ScopedHandle</a>(T ptr = 0) noexcept: obj(ptr) {}</div>
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span> <span class="comment"></span></div>
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="comment"> * Causes the ScopedHandle to delete its managed object (if any), and</span></div>
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span> <span class="comment"> * if the argument passed is not NULL, the ScopedHandle object will</span></div>
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment"> * manage the new object passed (which must not be managed by any</span></div>
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment"> * other ScopedHandle object). This method does not throw (assuming</span></div>
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment"> * the destructor of a managed object does not throw).</span></div>
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment"> * @param ptr NULL (the default), or a new unmanaged object to manage.</span></div>
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00884"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#a1d3bbbe7039f33ffada38b1057947c3a"> 884</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1ScopedHandle.html#a1d3bbbe7039f33ffada38b1057947c3a">reset</a>(T ptr = 0) {</div>
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(obj, ptr);</div>
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span>  <span class="keywordflow">if</span> (ptr) deleter(ptr); <span class="comment">// ptr now points to the original managed object</span></div>
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span>  }</div>
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="comment"></span></div>
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="comment"> * Causes the ScopedHandle to cease to manage the handled object, but</span></div>
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="comment"> * does not delete that object. This method does not throw.</span></div>
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment"> * @return A pointer to the previously handled object (or NULL if none</span></div>
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment"> * was handled).</span></div>
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00895"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#a5631c62579b6199a3c4812d488d8ad3f"> 895</a></span>  T <a class="code" href="classCgu_1_1ScopedHandle.html#a5631c62579b6199a3c4812d488d8ad3f">release</a>() noexcept {T tmp = obj; obj = 0; <span class="keywordflow">return</span> tmp;}</div>
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="comment"></span></div>
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="comment"> * @return A pointer to the handled object (or NULL if none is</span></div>
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00902"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#a6296e365ba6fa5741b6e17e2d8469c71"> 902</a></span>  T <span class="keyword">get</span>() <span class="keyword">const</span> noexcept {<span class="keywordflow">return</span> obj;}</div>
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span> <span class="comment"></span></div>
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="comment"> * @return A pointer to the handled object (or NULL if none is</span></div>
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#ac24cc52f591b4d25ddefc787d7b32174"> 909</a></span>  <span class="keyword">operator</span> T() const noexcept {<span class="keywordflow">return</span> obj;}</div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="comment"></span></div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="comment"> * The destructor does not throw unless the destructor of a handled</span></div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="comment"> * object throws - that should never happen.</span></div>
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00915"></a><span class="lineno"><a class="code" href="classCgu_1_1ScopedHandle.html#aa0d2b3335bcfa44d1ca1f23197133f90"> 915</a></span>  <a class="code" href="classCgu_1_1ScopedHandle.html#aa0d2b3335bcfa44d1ca1f23197133f90">~ScopedHandle</a>() {<span class="keywordflow">if</span> (obj) deleter(obj);}</div>
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span> };</div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span> </div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span> <span class="comment"></span></div>
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="comment"> * @class SharedLockHandle shared_handle.h c++-gtk-utils/shared_handle.h</span></div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="comment"> * @brief This is a generic class for managing the lifetime of objects</span></div>
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="comment"> * allocated on freestore, with a thread safe reference count..</span></div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="comment"> * @sa SharedHandle ScopedHandle SharedHandleError</span></div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="comment"> * @sa StandardArrayDelete CFree GFree GerrorFree GSliceFree GSliceFreeSize GSliceDestroy</span></div>
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment"> * Class SharedLockHandle is a version of the SharedHandle class which</span></div>
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment"> * includes synchronization so that it can handle objects accessed in</span></div>
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment"> * multiple threads (although the word Lock is in the title, by</span></div>
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment"> * default it uses glib atomic functions to access the reference count</span></div>
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment"> * rather than a mutex, so the overhead should be very small). Note</span></div>
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment"> * that only the reference count is protected, so this is thread safe</span></div>
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment"> * in the sense in which a raw pointer is thread safe. A shared</span></div>
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment"> * handle accessed in one thread referencing a particular object is</span></div>
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment"> * thread safe as against another shared handle accessing the same</span></div>
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment"> * object in a different thread. It is thus suitable for use in</span></div>
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"> * different standard C++ containers which exist in different threads</span></div>
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"> * but which contain shared objects by reference. But:</span></div>
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment"> * 1. If the referenced object is to be modified in one thread and</span></div>
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment"> * read or modified in another thread an appropriate mutex for the</span></div>
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment"> * referenced object is required (unless that referenced object</span></div>
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span> <span class="comment"> * does its own locking).</span></div>
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span> <span class="comment"> * 2. If the same instance of shared handle is to be modified in one</span></div>
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span> <span class="comment"> * thread (by assigning to the handle so that it references a</span></div>
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment"> * different object, or by moving from it), and copied (assigned</span></div>
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment"> * from or used as the argument of a copy constructor), accessed,</span></div>
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment"> * destroyed or modified in another thread, a mutex for that</span></div>
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment"> * instance of shared handle is required.</span></div>
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment"> * 3. Objects referenced by shared handles which are objects for</span></div>
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment"> * which POSIX provides no guarantees (in the main, those which</span></div>
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment"> * are not built-in types), such as strings and similar</span></div>
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span> <span class="comment"> * containers, may not support concurrent reads in different</span></div>
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span> <span class="comment"> * threads. That depends on the library implementation concerned.</span></div>
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span> <span class="comment"> * If that is the case, a mutex for the referenced object will</span></div>
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span> <span class="comment"> * also be required when reading any given instance of such an</span></div>
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span> <span class="comment"> * object in more than one thread by dereferencing any shared</span></div>
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span> <span class="comment"> * handles referencing it (and indeed, when not using shared</span></div>
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span> <span class="comment"> * handles at all).</span></div>
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span> <span class="comment"> * SharedLockHandle objects can be instantiated for pointers to</span></div>
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span> <span class="comment"> * constant objects (such as SharedLockHandle<const char*>), provided</span></div>
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment"> * the deleter functor will take such pointers.</span></div>
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment"> * This library provides StandardArrayDelete, CFree, GFree,</span></div>
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span> <span class="comment"> * GerrorFree, GSliceFree, GSliceFreeSize and GSliceDestroy deleter</span></div>
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span> <span class="comment"> * functors, which can be used as the second template parameter of the</span></div>
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span> <span class="comment"> * SharedLockHandle class. StandardArrayDelete is the default.</span></div>
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span> <span class="comment"> * As mentioned, by default glib atomic functions are used to provide</span></div>
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span> <span class="comment"> * thread-safe manipulation of the reference count. However, the</span></div>
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment"> * symbol CGU_SHARED_LOCK_HANDLE_USE_MUTEX can be defined so that the</span></div>
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"> * library uses mutexes instead, which might be useful for some</span></div>
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"> * debugging purposes. Note that if CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"> * is to be defined, this is best done by textually amending the</span></div>
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"> * shared_handle.h header file before the library is compiled. This</span></div>
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span> <span class="comment"> * will ensure that everything in the program and the library which</span></div>
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="comment"> * includes the shared_handle.h header is guaranteed to see the same</span></div>
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span> <span class="comment"> * definitions so that the C++ standard's one-definition-rule is</span></div>
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"> * complied with.</span></div>
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> * @b Comparison @b with @b std::shared_ptr</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"> * Although the semantics of std::shared_ptr in C++11 are not</span></div>
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment"> * particularly suited to managing either arrays or C objects with</span></div>
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="comment"> * accessor functions (such as in glib), most of the things that can</span></div>
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span> <span class="comment"> * be done by this class can be done by using std::shared_ptr with a</span></div>
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span> <span class="comment"> * specialised deleter. However, this class is retained in the</span></div>
<div class="line"><a name="l00989"></a><span class="lineno"> 989</span> <span class="comment"> * c++-gtk-utils library not only to retain compatibility with series</span></div>
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span> <span class="comment"> * 1.2 of the library, but also to cater for some cases not met (or</span></div>
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span> <span class="comment"> * not so easily met) by std::shared_ptr:</span></div>
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span> <span class="comment"> * 1. The Cgu::SharedLockHandle class takes its deleter as a template</span></div>
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span> <span class="comment"> * parameter, which means that typedefs can be used to enable</span></div>
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span> <span class="comment"> * handles for particular deleters to be easily created (and as</span></div>
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span> <span class="comment"> * mentioned, this library provides a number of pre-formed deleter</span></div>
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span> <span class="comment"> * functors and typedefs for them). With std::shared_ptr, custom</span></div>
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span> <span class="comment"> * deleters must be passed to the shared_ptr constructor on every</span></div>
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment"> * occasion a shared_ptr is constructed to manage a new object (and</span></div>
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment"> * they cannot be templated as a typedef).</span></div>
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> <span class="comment"> * 2. Glib memory slices provide an efficient small object allocator</span></div>
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span> <span class="comment"> * (they are likely to be significantly more efficient than global</span></div>
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> <span class="comment"> * operator new()/new[](), which generally hand off to malloc(),</span></div>
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="comment"> * and whilst malloc() is good for large block allocations it is</span></div>
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment"> * generally poor as a small object allocator). Internal</span></div>
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="comment"> * Cgu::SharedLockHandle allocation using glib memory slices can be</span></div>
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span> <span class="comment"> * achieved by compiling the library with the</span></div>
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option.</span></div>
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span> <span class="comment"> * 3. If glib memory slices are not used (which do not throw),</span></div>
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span> <span class="comment"> * constructing a shared pointer for a new managed object (or</span></div>
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span> <span class="comment"> * calling reset() for a new managed object) might throw if</span></div>
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span> <span class="comment"> * internal allocation fails. Although by default the</span></div>
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span> <span class="comment"> * Cgu::SharedLockHandle implementation will delete the new managed</span></div>
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span> <span class="comment"> * object in such a case, it also provides an alternative</span></div>
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span> <span class="comment"> * constructor and reset() method which instead enable the new</span></div>
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span> <span class="comment"> * object to be accessed via the thrown exception object so that</span></div>
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span> <span class="comment"> * user code can decide what to do; std::shared_ptr deletes the new</span></div>
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span> <span class="comment"> * object in every case.</span></div>
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span> <span class="comment"> * 4. A user can explicitly state whether the shared handle object is</span></div>
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span> <span class="comment"> * to have atomic increment and decrement-and-test with respect to</span></div>
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span> <span class="comment"> * the reference count so that the reference count is thread safe</span></div>
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span> <span class="comment"> * ('no' in the case of Cgu::SharedHandle, and 'yes' in the case of</span></div>
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment"> * Cgu::SharedLockHandle). Using atomic functions is unnecessary</span></div>
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> <span class="comment"> * if the managed object concerned is only addressed in one thread</span></div>
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span> <span class="comment"> * (and might cause unwanted cache flushing in certain</span></div>
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span> <span class="comment"> * circumstances). std::shared_ptr will generally always use</span></div>
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span> <span class="comment"> * atomic functions with respect to its reference count in a</span></div>
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span> <span class="comment"> * multi-threaded program.</span></div>
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span> <span class="comment"> * In favour of std::shared_ptr, it has an associated std::weak_ptr</span></div>
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> <span class="comment"> * class, which Cgu::SharedLockHandle does not (there is a</span></div>
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span> <span class="comment"> * Cgu::GobjWeakHandle class, but that is cognate with Cgu::GobjHandle</span></div>
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span> <span class="comment"> * and is only usable with GObjects). In addition shared_ptr objects</span></div>
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span> <span class="comment"> * have some atomic store, load and exchange functions provided for</span></div>
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span> <span class="comment"> * them which enable concurrent modifications of the same instance of</span></div>
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span> <span class="comment"> * shared_ptr in different threads to have defined results.</span></div>
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span> <span class="comment"> * If the library is compiled with the</span></div>
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option, as</span></div>
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span> <span class="comment"> * mentioned Cgu::SharedLockHandle constructs its reference counting</span></div>
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span> <span class="comment"> * internals using glib memory slices. Although it is safe in a</span></div>
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment"> * multi-threaded program if glib < 2.32 is installed to construct a</span></div>
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment"> * static SharedLockHandle object in global namespace (that is, prior</span></div>
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment"> * to g_thread_init() being called) by means of the default</span></div>
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment"> * constructor and/or a pointer argument of NULL, it is not safe if</span></div>
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment"> * constructed with a non-NULL pointer value. If glib >= 2.32 is</span></div>
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span> <span class="comment"> * installed, global objects with memory slices are safe in all</span></div>
<div class="line"><a name="l01048"></a><span class="lineno"> 1048</span> <span class="comment"> * circumstances. (Having said that, it would be highly unusual to</span></div>
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span> <span class="comment"> * have global SharedLockHandle objects.)</span></div>
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span> </div>
<div class="line"><a name="l01052"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html"> 1052</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc = StandardArrayDelete<T>> <span class="keyword">class </span><a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a> {</div>
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span> </div>
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span>  Dealloc deleter;</div>
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span> </div>
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span> <span class="preprocessor">#ifndef DOXYGEN_PARSING</span></div>
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span> <span class="preprocessor"></span> <span class="keyword">struct </span>RefItems {</div>
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span> <span class="preprocessor"></span> <a class="code" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Thread::Mutex</a>* mutex_p;</div>
<div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* ref_count_p;</div>
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span> <span class="preprocessor"></span> gint* ref_count_p;</div>
<div class="line"><a name="l01063"></a><span class="lineno"> 1063</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01064"></a><span class="lineno"> 1064</span> <span class="preprocessor"></span> T obj;</div>
<div class="line"><a name="l01065"></a><span class="lineno"> 1065</span>  } ref_items;</div>
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01068"></a><span class="lineno"> 1068</span>  <span class="comment">// SharedLockHandle<T, Dealloc>::unreference() does not throw exceptions</span></div>
<div class="line"><a name="l01069"></a><span class="lineno"> 1069</span>  <span class="comment">// because Thread::Mutex::~Mutex(), Thread::Mutex::lock() and Thread::Mutex::unlock()</span></div>
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>  <span class="comment">// do not throw</span></div>
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>  <span class="keywordtype">void</span> unreference() {</div>
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span>  <span class="comment">// we can (and should) check whether ref_items.ref_count_p is NULL without</span></div>
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span>  <span class="comment">// a lock, because that member is specific to this SharedLockHandle object.</span></div>
<div class="line"><a name="l01074"></a><span class="lineno"> 1074</span>  <span class="comment">// Only the integer pointed to by it is shared amongst SharedLockHandle</span></div>
<div class="line"><a name="l01075"></a><span class="lineno"> 1075</span>  <span class="comment">// objects and requires locking</span></div>
<div class="line"><a name="l01076"></a><span class="lineno"> 1076</span>  <span class="keywordflow">if</span> (!ref_items.ref_count_p) <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l01077"></a><span class="lineno"> 1077</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01078"></a><span class="lineno"> 1078</span> <span class="preprocessor"></span> ref_items.mutex_p-><a class="code" href="classCgu_1_1Thread_1_1Mutex.html#a4117ae4f42f0972dcd286d2cbb7e014c">lock</a>();</div>
<div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>  --(*ref_items.ref_count_p);</div>
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span>  <span class="keywordflow">if</span> (*ref_items.ref_count_p == 0) {</div>
<div class="line"><a name="l01081"></a><span class="lineno"> 1081</span> <span class="preprocessor"># ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l01082"></a><span class="lineno"> 1082</span> <span class="preprocessor"></span> g_slice_free(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, ref_items.ref_count_p);</div>
<div class="line"><a name="l01083"></a><span class="lineno"> 1083</span> <span class="preprocessor"># else</span></div>
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span> <span class="preprocessor"></span> <span class="keyword">delete</span> ref_items.ref_count_p;</div>
<div class="line"><a name="l01085"></a><span class="lineno"> 1085</span> <span class="preprocessor"># endif</span></div>
<div class="line"><a name="l01086"></a><span class="lineno"> 1086</span> <span class="preprocessor"></span> ref_items.mutex_p->unlock();</div>
<div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>  <span class="keyword">delete</span> ref_items.mutex_p;</div>
<div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>  deleter(ref_items.obj);</div>
<div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>  }</div>
<div class="line"><a name="l01090"></a><span class="lineno"> 1090</span>  <span class="keywordflow">else</span> ref_items.mutex_p->unlock();</div>
<div class="line"><a name="l01091"></a><span class="lineno"> 1091</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l01092"></a><span class="lineno"> 1092</span> <span class="preprocessor"></span> <span class="keywordflow">if</span> (g_atomic_int_dec_and_test(ref_items.ref_count_p)) {</div>
<div class="line"><a name="l01093"></a><span class="lineno"> 1093</span> <span class="preprocessor"># ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="preprocessor"></span> g_slice_free(gint, ref_items.ref_count_p);</div>
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> <span class="preprocessor"># else</span></div>
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="preprocessor"></span> <span class="keyword">delete</span> ref_items.ref_count_p;</div>
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> <span class="preprocessor"># endif</span></div>
<div class="line"><a name="l01098"></a><span class="lineno"> 1098</span> <span class="preprocessor"></span> deleter(ref_items.obj);</div>
<div class="line"><a name="l01099"></a><span class="lineno"> 1099</span>  }</div>
<div class="line"><a name="l01100"></a><span class="lineno"> 1100</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01101"></a><span class="lineno"> 1101</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l01102"></a><span class="lineno"> 1102</span>  </div>
<div class="line"><a name="l01103"></a><span class="lineno"> 1103</span>  <span class="comment">// SharedLockHandle<T, Dealloc>::reference() does not throw exceptions because</span></div>
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>  <span class="comment">// Thread::Mutex::Lock::Lock() and Thread::Mutex::Lock::~Lock() do not throw</span></div>
<div class="line"><a name="l01105"></a><span class="lineno"> 1105</span>  <span class="keywordtype">void</span> reference() noexcept {</div>
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span>  <span class="comment">// we can (and should) check whether ref_items.ref_count_p is NULL without</span></div>
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span>  <span class="comment">// a lock, because that member is specific to this SharedLockHandle object.</span></div>
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span>  <span class="comment">// Only the integer pointed to by it is shared amongst SharedLockHandle</span></div>
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span>  <span class="comment">// objects and requires locking</span></div>
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span>  <span class="keywordflow">if</span> (!ref_items.ref_count_p) <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span> <span class="preprocessor"></span> <a class="code" href="classCgu_1_1Thread_1_1Mutex_1_1Lock.html" title="A scoped locking class for exception safe Mutex locking. ">Thread::Mutex::Lock</a> lock(*ref_items.mutex_p);</div>
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span>  ++(*ref_items.ref_count_p);</div>
<div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span> <span class="preprocessor"></span> g_atomic_int_inc(ref_items.ref_count_p);</div>
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span> </div>
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> <span class="comment"> * Constructor taking an unmanaged object.</span></div>
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span> <span class="comment"> * @param ptr The object which the SharedLockHandle is to manage (if</span></div>
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> <span class="comment"> * any).</span></div>
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span> <span class="comment"> * @exception std::bad_alloc This constructor will not throw if the</span></div>
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span> <span class="comment"> * 'ptr' argument has a NULL value (the default), otherwise it might</span></div>
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> <span class="comment"> * throw std::bad_alloc if memory is exhausted and the system throws</span></div>
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span> <span class="comment"> * in that case. If such an exception is thrown, this constructor is</span></div>
<div class="line"><a name="l01128"></a><span class="lineno"> 1128</span> <span class="comment"> * exception safe (it does not leak resources), but as well as</span></div>
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span> <span class="comment"> * cleaning itself up this constructor will also delete the managed</span></div>
<div class="line"><a name="l01130"></a><span class="lineno"> 1130</span> <span class="comment"> * object passed to it to avoid a memory leak. If such automatic</span></div>
<div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> <span class="comment"> * deletion is not wanted in that case, use the version of this</span></div>
<div class="line"><a name="l01132"></a><span class="lineno"> 1132</span> <span class="comment"> * constructor taking a Cgu::SharedHandleAllocFail::Leave tag</span></div>
<div class="line"><a name="l01133"></a><span class="lineno"> 1133</span> <span class="comment"> * argument.</span></div>
<div class="line"><a name="l01134"></a><span class="lineno"> 1134</span> <span class="comment"> * @note 1. std::bad_alloc will not be thrown if the library has been</span></div>
<div class="line"><a name="l01135"></a><span class="lineno"> 1135</span> <span class="comment"> * installed using the \--with-glib-memory-slices-no-compat</span></div>
<div class="line"><a name="l01136"></a><span class="lineno"> 1136</span> <span class="comment"> * configuration option: instead glib will terminate the program if it</span></div>
<div class="line"><a name="l01137"></a><span class="lineno"> 1137</span> <span class="comment"> * is unable to obtain memory from the operating system.</span></div>
<div class="line"><a name="l01138"></a><span class="lineno"> 1138</span> <span class="comment"> * @note 2. By default, glib atomic functions are used to provide</span></div>
<div class="line"><a name="l01139"></a><span class="lineno"> 1139</span> <span class="comment"> * thread-safe manipulation of the reference count. However, the</span></div>
<div class="line"><a name="l01140"></a><span class="lineno"> 1140</span> <span class="comment"> * header file shared_handle.h can be textually amended before the</span></div>
<div class="line"><a name="l01141"></a><span class="lineno"> 1141</span> <span class="comment"> * library is compiled to define the symbol</span></div>
<div class="line"><a name="l01142"></a><span class="lineno"> 1142</span> <span class="comment"> * CGU_SHARED_LOCK_HANDLE_USE_MUTEX so as to use mutexes instead,</span></div>
<div class="line"><a name="l01143"></a><span class="lineno"> 1143</span> <span class="comment"> * which might be useful for some debugging purposes. Were that to be</span></div>
<div class="line"><a name="l01144"></a><span class="lineno"> 1144</span> <span class="comment"> * done, Cgu::Thread::MutexError might be thrown by this constructor</span></div>
<div class="line"><a name="l01145"></a><span class="lineno"> 1145</span> <span class="comment"> * if initialization of the mutex fails.</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"><a class="code" href="classCgu_1_1SharedLockHandle.html#a254ad1c94e68018d4fa1beacc0209665"> 1147</a></span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1SharedLockHandle.html#a254ad1c94e68018d4fa1beacc0209665">SharedLockHandle</a>(T ptr = 0) {</div>
<div class="line"><a name="l01148"></a><span class="lineno"> 1148</span> </div>
<div class="line"><a name="l01149"></a><span class="lineno"> 1149</span>  <span class="keywordflow">if</span> ((ref_items.obj = ptr)) { <span class="comment">// not NULL</span></div>
<div class="line"><a name="l01150"></a><span class="lineno"> 1150</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01151"></a><span class="lineno"> 1151</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l01152"></a><span class="lineno"> 1152</span>  ref_items.mutex_p = <span class="keyword">new</span> <a class="code" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Thread::Mutex</a>;</div>
<div class="line"><a name="l01153"></a><span class="lineno"> 1153</span>  }</div>
<div class="line"><a name="l01154"></a><span class="lineno"> 1154</span>  <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l01155"></a><span class="lineno"> 1155</span>  deleter(ptr); <span class="comment">// if allocating the object referenced by ref_items.mutex_p</span></div>
<div class="line"><a name="l01156"></a><span class="lineno"> 1156</span>  <span class="comment">// has failed then delete the object to be referenced to</span></div>
<div class="line"><a name="l01157"></a><span class="lineno"> 1157</span>  <span class="comment">// avoid a memory leak</span></div>
<div class="line"><a name="l01158"></a><span class="lineno"> 1158</span>  <span class="keywordflow">throw</span>;</div>
<div class="line"><a name="l01159"></a><span class="lineno"> 1159</span>  }</div>
<div class="line"><a name="l01160"></a><span class="lineno"> 1160</span> <span class="preprocessor"># ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l01161"></a><span class="lineno"> 1161</span> <span class="preprocessor"></span> ref_items.ref_count_p = g_slice_new(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>);</div>
<div class="line"><a name="l01162"></a><span class="lineno"> 1162</span>  *ref_items.ref_count_p = 1;</div>
<div class="line"><a name="l01163"></a><span class="lineno"> 1163</span> <span class="preprocessor"># else</span></div>
<div class="line"><a name="l01164"></a><span class="lineno"> 1164</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l01165"></a><span class="lineno"> 1165</span>  ref_items.ref_count_p = <span class="keyword">new</span> <span class="keywordtype">unsigned</span> int(1);</div>
<div class="line"><a name="l01166"></a><span class="lineno"> 1166</span>  }</div>
<div class="line"><a name="l01167"></a><span class="lineno"> 1167</span>  <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l01168"></a><span class="lineno"> 1168</span>  <span class="keyword">delete</span> ref_items.mutex_p;</div>
<div class="line"><a name="l01169"></a><span class="lineno"> 1169</span>  deleter(ptr);</div>
<div class="line"><a name="l01170"></a><span class="lineno"> 1170</span>  <span class="keywordflow">throw</span>;</div>
<div class="line"><a name="l01171"></a><span class="lineno"> 1171</span>  }</div>
<div class="line"><a name="l01172"></a><span class="lineno"> 1172</span> <span class="preprocessor"># endif</span></div>
<div class="line"><a name="l01173"></a><span class="lineno"> 1173</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l01174"></a><span class="lineno"> 1174</span> <span class="preprocessor"></span><span class="preprocessor"># ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l01175"></a><span class="lineno"> 1175</span> <span class="preprocessor"></span> ref_items.ref_count_p = g_slice_new(gint);</div>
<div class="line"><a name="l01176"></a><span class="lineno"> 1176</span>  *ref_items.ref_count_p = 1;</div>
<div class="line"><a name="l01177"></a><span class="lineno"> 1177</span> <span class="preprocessor"># else</span></div>
<div class="line"><a name="l01178"></a><span class="lineno"> 1178</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l01179"></a><span class="lineno"> 1179</span>  ref_items.ref_count_p = <span class="keyword">new</span> gint(1);</div>
<div class="line"><a name="l01180"></a><span class="lineno"> 1180</span>  }</div>
<div class="line"><a name="l01181"></a><span class="lineno"> 1181</span>  <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l01182"></a><span class="lineno"> 1182</span>  deleter(ptr); <span class="comment">// if allocating the int referenced by ref_items.ref_count_p</span></div>
<div class="line"><a name="l01183"></a><span class="lineno"> 1183</span>  <span class="comment">// has failed then delete the object to be referenced to</span></div>
<div class="line"><a name="l01184"></a><span class="lineno"> 1184</span>  <span class="comment">// avoid a memory leak</span></div>
<div class="line"><a name="l01185"></a><span class="lineno"> 1185</span>  <span class="keywordflow">throw</span>;</div>
<div class="line"><a name="l01186"></a><span class="lineno"> 1186</span>  }</div>
<div class="line"><a name="l01187"></a><span class="lineno"> 1187</span> <span class="preprocessor"># endif</span></div>
<div class="line"><a name="l01188"></a><span class="lineno"> 1188</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01189"></a><span class="lineno"> 1189</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l01190"></a><span class="lineno"> 1190</span>  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l01191"></a><span class="lineno"> 1191</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01192"></a><span class="lineno"> 1192</span> <span class="preprocessor"></span> ref_items.mutex_p = 0; <span class="comment">// make sure the value is valid as we may assign it</span></div>
<div class="line"><a name="l01193"></a><span class="lineno"> 1193</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01194"></a><span class="lineno"> 1194</span> <span class="preprocessor"></span> ref_items.ref_count_p = 0;</div>
<div class="line"><a name="l01195"></a><span class="lineno"> 1195</span>  }</div>
<div class="line"><a name="l01196"></a><span class="lineno"> 1196</span>  }</div>
<div class="line"><a name="l01197"></a><span class="lineno"> 1197</span> <span class="comment"></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> <span class="comment"> * Constructor taking an unmanaged object.</span></div>
<div class="line"><a name="l01200"></a><span class="lineno"> 1200</span> <span class="comment"> * @param ptr The object which the SharedLockHandle is to manage.</span></div>
<div class="line"><a name="l01201"></a><span class="lineno"> 1201</span> <span class="comment"> * @param tag Passing the tag emumerator</span></div>
<div class="line"><a name="l01202"></a><span class="lineno"> 1202</span> <span class="comment"> * Cgu::SharedHandleAllocFail::leave causes this constructor not to</span></div>
<div class="line"><a name="l01203"></a><span class="lineno"> 1203</span> <span class="comment"> * delete the new managed object passed as the 'ptr' argument in the</span></div>
<div class="line"><a name="l01204"></a><span class="lineno"> 1204</span> <span class="comment"> * event of internal allocation in this method failing because of</span></div>
<div class="line"><a name="l01205"></a><span class="lineno"> 1205</span> <span class="comment"> * memory exhaustion (in that event, Cgu::SharedHandleError will be</span></div>
<div class="line"><a name="l01206"></a><span class="lineno"> 1206</span> <span class="comment"> * thrown).</span></div>
<div class="line"><a name="l01207"></a><span class="lineno"> 1207</span> <span class="comment"> * @exception Cgu::SharedHandleError This constructor might throw</span></div>
<div class="line"><a name="l01208"></a><span class="lineno"> 1208</span> <span class="comment"> * Cgu::SharedHandleError if memory is exhausted and the system would</span></div>
<div class="line"><a name="l01209"></a><span class="lineno"> 1209</span> <span class="comment"> * otherwise throw std::bad_alloc in that case. This constructor is</span></div>
<div class="line"><a name="l01210"></a><span class="lineno"> 1210</span> <span class="comment"> * exception safe (it does not leak resources), and if such an</span></div>
<div class="line"><a name="l01211"></a><span class="lineno"> 1211</span> <span class="comment"> * exception is thrown it will clean itself up, but it will not</span></div>
<div class="line"><a name="l01212"></a><span class="lineno"> 1212</span> <span class="comment"> * attempt to delete the new managed object passed to it. Access to</span></div>
<div class="line"><a name="l01213"></a><span class="lineno"> 1213</span> <span class="comment"> * the object passed to the 'ptr' argument can be obtained via the</span></div>
<div class="line"><a name="l01214"></a><span class="lineno"> 1214</span> <span class="comment"> * thrown Cgu::SharedHandleError object.</span></div>
<div class="line"><a name="l01215"></a><span class="lineno"> 1215</span> <span class="comment"> * @note 1. On systems with over-commit/lazy-commit combined with</span></div>
<div class="line"><a name="l01216"></a><span class="lineno"> 1216</span> <span class="comment"> * virtual memory (swap), it is rarely useful to check for memory</span></div>
<div class="line"><a name="l01217"></a><span class="lineno"> 1217</span> <span class="comment"> * exhaustion, so in those cases this version of the constructor will</span></div>
<div class="line"><a name="l01218"></a><span class="lineno"> 1218</span> <span class="comment"> * not be useful.</span></div>
<div class="line"><a name="l01219"></a><span class="lineno"> 1219</span> <span class="comment"> * @note 2. If the library has been installed using the</span></div>
<div class="line"><a name="l01220"></a><span class="lineno"> 1220</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option this</span></div>
<div class="line"><a name="l01221"></a><span class="lineno"> 1221</span> <span class="comment"> * version of the constructor will also not be useful: instead glib</span></div>
<div class="line"><a name="l01222"></a><span class="lineno"> 1222</span> <span class="comment"> * will terminate the program if it is unable to obtain memory from</span></div>
<div class="line"><a name="l01223"></a><span class="lineno"> 1223</span> <span class="comment"> * the operating system.</span></div>
<div class="line"><a name="l01224"></a><span class="lineno"> 1224</span> <span class="comment"> * @note 3. By default, glib atomic functions are used to provide</span></div>
<div class="line"><a name="l01225"></a><span class="lineno"> 1225</span> <span class="comment"> * thread-safe manipulation of the reference count. However, the</span></div>
<div class="line"><a name="l01226"></a><span class="lineno"> 1226</span> <span class="comment"> * header file shared_handle.h can be textually amended before the</span></div>
<div class="line"><a name="l01227"></a><span class="lineno"> 1227</span> <span class="comment"> * library is compiled to define the symbol</span></div>
<div class="line"><a name="l01228"></a><span class="lineno"> 1228</span> <span class="comment"> * CGU_SHARED_LOCK_HANDLE_USE_MUTEX so as to use mutexes instead,</span></div>
<div class="line"><a name="l01229"></a><span class="lineno"> 1229</span> <span class="comment"> * which might be useful for some debugging purposes. Were that to be</span></div>
<div class="line"><a name="l01230"></a><span class="lineno"> 1230</span> <span class="comment"> * done, Cgu::SharedHandleError might be thrown by this constructor if</span></div>
<div class="line"><a name="l01231"></a><span class="lineno"> 1231</span> <span class="comment"> * initialization of the mutex fails (even if the</span></div>
<div class="line"><a name="l01232"></a><span class="lineno"> 1232</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option is</span></div>
<div class="line"><a name="l01233"></a><span class="lineno"> 1233</span> <span class="comment"> * chosen).</span></div>
<div class="line"><a name="l01234"></a><span class="lineno"> 1234</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01235"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#af3f909be6e779051cdbbaedf7617d4c0"> 1235</a></span>  <a class="code" href="classCgu_1_1SharedLockHandle.html#af3f909be6e779051cdbbaedf7617d4c0">SharedLockHandle</a>(T ptr, <a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165b">Cgu::SharedHandleAllocFail::Leave</a> tag) {</div>
<div class="line"><a name="l01236"></a><span class="lineno"> 1236</span> </div>
<div class="line"><a name="l01237"></a><span class="lineno"> 1237</span>  <span class="keywordflow">if</span> ((ref_items.obj = ptr)) { <span class="comment">// not NULL</span></div>
<div class="line"><a name="l01238"></a><span class="lineno"> 1238</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01239"></a><span class="lineno"> 1239</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l01240"></a><span class="lineno"> 1240</span>  ref_items.mutex_p = <span class="keyword">new</span> <a class="code" href="classCgu_1_1Thread_1_1Mutex.html" title="A wrapper class for pthread mutexes. ">Thread::Mutex</a>;</div>
<div class="line"><a name="l01241"></a><span class="lineno"> 1241</span>  }</div>
<div class="line"><a name="l01242"></a><span class="lineno"> 1242</span>  <span class="keywordflow">catch</span> (std::bad_alloc&) { <span class="comment">// as we are not rethrowing, make NPTL friendly</span></div>
<div class="line"><a name="l01243"></a><span class="lineno"> 1243</span>  <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1SharedHandleError.html" title="This is an exception struct thrown as an alternative to deleting a managed object when internal memor...">SharedHandleError<T></a>(ptr);</div>
<div class="line"><a name="l01244"></a><span class="lineno"> 1244</span>  }</div>
<div class="line"><a name="l01245"></a><span class="lineno"> 1245</span>  <span class="keywordflow">catch</span> (<a class="code" href="structCgu_1_1Thread_1_1MutexError.html">Thread::MutexError</a>&) { <span class="comment">// as we are not rethrowing, make NPTL friendly</span></div>
<div class="line"><a name="l01246"></a><span class="lineno"> 1246</span>  <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1SharedHandleError.html" title="This is an exception struct thrown as an alternative to deleting a managed object when internal memor...">SharedHandleError<T></a>(ptr);</div>
<div class="line"><a name="l01247"></a><span class="lineno"> 1247</span>  }</div>
<div class="line"><a name="l01248"></a><span class="lineno"> 1248</span> <span class="preprocessor"># ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l01249"></a><span class="lineno"> 1249</span> <span class="preprocessor"></span> ref_items.ref_count_p = g_slice_new(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>);</div>
<div class="line"><a name="l01250"></a><span class="lineno"> 1250</span>  *ref_items.ref_count_p = 1;</div>
<div class="line"><a name="l01251"></a><span class="lineno"> 1251</span> <span class="preprocessor"># else</span></div>
<div class="line"><a name="l01252"></a><span class="lineno"> 1252</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l01253"></a><span class="lineno"> 1253</span>  ref_items.ref_count_p = <span class="keyword">new</span> <span class="keywordtype">unsigned</span> int(1);</div>
<div class="line"><a name="l01254"></a><span class="lineno"> 1254</span>  }</div>
<div class="line"><a name="l01255"></a><span class="lineno"> 1255</span>  <span class="keywordflow">catch</span> (std::bad_alloc&) {</div>
<div class="line"><a name="l01256"></a><span class="lineno"> 1256</span>  <span class="keyword">delete</span> ref_items.mutex_p;</div>
<div class="line"><a name="l01257"></a><span class="lineno"> 1257</span>  <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1SharedHandleError.html" title="This is an exception struct thrown as an alternative to deleting a managed object when internal memor...">SharedHandleError<T></a>(ptr);</div>
<div class="line"><a name="l01258"></a><span class="lineno"> 1258</span>  }</div>
<div class="line"><a name="l01259"></a><span class="lineno"> 1259</span> <span class="preprocessor"># endif</span></div>
<div class="line"><a name="l01260"></a><span class="lineno"> 1260</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l01261"></a><span class="lineno"> 1261</span> <span class="preprocessor"></span><span class="preprocessor"># ifdef CGU_USE_GLIB_MEMORY_SLICES_NO_COMPAT</span></div>
<div class="line"><a name="l01262"></a><span class="lineno"> 1262</span> <span class="preprocessor"></span> ref_items.ref_count_p = g_slice_new(gint);</div>
<div class="line"><a name="l01263"></a><span class="lineno"> 1263</span>  *ref_items.ref_count_p = 1;</div>
<div class="line"><a name="l01264"></a><span class="lineno"> 1264</span> <span class="preprocessor"># else</span></div>
<div class="line"><a name="l01265"></a><span class="lineno"> 1265</span> <span class="preprocessor"></span> <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l01266"></a><span class="lineno"> 1266</span>  ref_items.ref_count_p = <span class="keyword">new</span> gint(1);</div>
<div class="line"><a name="l01267"></a><span class="lineno"> 1267</span>  }</div>
<div class="line"><a name="l01268"></a><span class="lineno"> 1268</span>  <span class="keywordflow">catch</span> (std::bad_alloc&) { <span class="comment">// as we are not rethrowing, make NPTL friendly</span></div>
<div class="line"><a name="l01269"></a><span class="lineno"> 1269</span>  <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1SharedHandleError.html" title="This is an exception struct thrown as an alternative to deleting a managed object when internal memor...">SharedHandleError<T></a>(ptr);</div>
<div class="line"><a name="l01270"></a><span class="lineno"> 1270</span>  }</div>
<div class="line"><a name="l01271"></a><span class="lineno"> 1271</span> <span class="preprocessor"># endif</span></div>
<div class="line"><a name="l01272"></a><span class="lineno"> 1272</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01273"></a><span class="lineno"> 1273</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l01274"></a><span class="lineno"> 1274</span>  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l01275"></a><span class="lineno"> 1275</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01276"></a><span class="lineno"> 1276</span> <span class="preprocessor"></span> ref_items.mutex_p = 0; <span class="comment">// make sure the value is valid as we may assign it</span></div>
<div class="line"><a name="l01277"></a><span class="lineno"> 1277</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01278"></a><span class="lineno"> 1278</span> <span class="preprocessor"></span> ref_items.ref_count_p = 0;</div>
<div class="line"><a name="l01279"></a><span class="lineno"> 1279</span>  }</div>
<div class="line"><a name="l01280"></a><span class="lineno"> 1280</span>  }</div>
<div class="line"><a name="l01281"></a><span class="lineno"> 1281</span> <span class="comment"></span></div>
<div class="line"><a name="l01282"></a><span class="lineno"> 1282</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01283"></a><span class="lineno"> 1283</span> <span class="comment"> * Causes the SharedLockHandle to cease to manage its managed object</span></div>
<div class="line"><a name="l01284"></a><span class="lineno"> 1284</span> <span class="comment"> * (if any), deleting it if this is the last ShareLockHandle object</span></div>
<div class="line"><a name="l01285"></a><span class="lineno"> 1285</span> <span class="comment"> * managing it. If the argument passed is not NULL, the</span></div>
<div class="line"><a name="l01286"></a><span class="lineno"> 1286</span> <span class="comment"> * SharedLockHandle object will manage the new object passed (which</span></div>
<div class="line"><a name="l01287"></a><span class="lineno"> 1287</span> <span class="comment"> * must not be managed by any other SharedLockHandle object).</span></div>
<div class="line"><a name="l01288"></a><span class="lineno"> 1288</span> <span class="comment"> * @param ptr NULL (the default), or a new unmanaged object to manage.</span></div>
<div class="line"><a name="l01289"></a><span class="lineno"> 1289</span> <span class="comment"> * @exception std::bad_alloc This method will not throw if the 'ptr'</span></div>
<div class="line"><a name="l01290"></a><span class="lineno"> 1290</span> <span class="comment"> * argument has a NULL value (the default) and the destructor of a</span></div>
<div class="line"><a name="l01291"></a><span class="lineno"> 1291</span> <span class="comment"> * managed object does not throw, otherwise it might throw</span></div>
<div class="line"><a name="l01292"></a><span class="lineno"> 1292</span> <span class="comment"> * std::bad_alloc if memory is exhausted and the system throws in that</span></div>
<div class="line"><a name="l01293"></a><span class="lineno"> 1293</span> <span class="comment"> * case. Note that if such an exception is thrown then this method</span></div>
<div class="line"><a name="l01294"></a><span class="lineno"> 1294</span> <span class="comment"> * will do nothing (it is strongly exception safe and will continue to</span></div>
<div class="line"><a name="l01295"></a><span class="lineno"> 1295</span> <span class="comment"> * manage the object it was managing prior to the call), except that</span></div>
<div class="line"><a name="l01296"></a><span class="lineno"> 1296</span> <span class="comment"> * it will delete the new managed object passed to it to avoid a</span></div>
<div class="line"><a name="l01297"></a><span class="lineno"> 1297</span> <span class="comment"> * memory leak. If such automatic deletion in the event of such an</span></div>
<div class="line"><a name="l01298"></a><span class="lineno"> 1298</span> <span class="comment"> * exception is not wanted, use the reset() method taking a</span></div>
<div class="line"><a name="l01299"></a><span class="lineno"> 1299</span> <span class="comment"> * Cgu::SharedHandleAllocFail::Leave tag type as its second argument.</span></div>
<div class="line"><a name="l01300"></a><span class="lineno"> 1300</span> <span class="comment"> * @note 1. std::bad_alloc will not be thrown if the library has been</span></div>
<div class="line"><a name="l01301"></a><span class="lineno"> 1301</span> <span class="comment"> * installed using the \--with-glib-memory-slices-no-compat</span></div>
<div class="line"><a name="l01302"></a><span class="lineno"> 1302</span> <span class="comment"> * configuration option: instead glib will terminate the program if it</span></div>
<div class="line"><a name="l01303"></a><span class="lineno"> 1303</span> <span class="comment"> * is unable to obtain memory from the operating system.</span></div>
<div class="line"><a name="l01304"></a><span class="lineno"> 1304</span> <span class="comment"> * @note 2. By default, glib atomic functions are used to provide</span></div>
<div class="line"><a name="l01305"></a><span class="lineno"> 1305</span> <span class="comment"> * thread-safe manipulation of the reference count. However, the</span></div>
<div class="line"><a name="l01306"></a><span class="lineno"> 1306</span> <span class="comment"> * header file shared_handle.h can be textually amended before the</span></div>
<div class="line"><a name="l01307"></a><span class="lineno"> 1307</span> <span class="comment"> * library is compiled to define the symbol</span></div>
<div class="line"><a name="l01308"></a><span class="lineno"> 1308</span> <span class="comment"> * CGU_SHARED_LOCK_HANDLE_USE_MUTEX so as to use mutexes instead,</span></div>
<div class="line"><a name="l01309"></a><span class="lineno"> 1309</span> <span class="comment"> * which might be useful for some debugging purposes. Were that to be</span></div>
<div class="line"><a name="l01310"></a><span class="lineno"> 1310</span> <span class="comment"> * done, Cgu::Thread::MutexError might be thrown by this method if</span></div>
<div class="line"><a name="l01311"></a><span class="lineno"> 1311</span> <span class="comment"> * initialization of the mutex fails.</span></div>
<div class="line"><a name="l01312"></a><span class="lineno"> 1312</span> <span class="comment"> * @note 3. A SharedLockHandle object protects its reference count but</span></div>
<div class="line"><a name="l01313"></a><span class="lineno"> 1313</span> <span class="comment"> * not the managed object or its other internals. The reset() method</span></div>
<div class="line"><a name="l01314"></a><span class="lineno"> 1314</span> <span class="comment"> * should not be called by one thread in respect of a particular</span></div>
<div class="line"><a name="l01315"></a><span class="lineno"> 1315</span> <span class="comment"> * SharedLockHandle object while another thread may be operating on,</span></div>
<div class="line"><a name="l01316"></a><span class="lineno"> 1316</span> <span class="comment"> * copying or dereferencing the same instance of SharedLockHandle. It</span></div>
<div class="line"><a name="l01317"></a><span class="lineno"> 1317</span> <span class="comment"> * is thread-safe as against another instance of SharedLockHandle</span></div>
<div class="line"><a name="l01318"></a><span class="lineno"> 1318</span> <span class="comment"> * managing the same object.</span></div>
<div class="line"><a name="l01319"></a><span class="lineno"> 1319</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01320"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#aef2d14ba2181d36db0cecd59e312b153"> 1320</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1SharedLockHandle.html#aef2d14ba2181d36db0cecd59e312b153">reset</a>(T ptr = 0) {</div>
<div class="line"><a name="l01321"></a><span class="lineno"> 1321</span>  <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a> tmp(ptr);</div>
<div class="line"><a name="l01322"></a><span class="lineno"> 1322</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(ref_items, tmp.ref_items);</div>
<div class="line"><a name="l01323"></a><span class="lineno"> 1323</span>  }</div>
<div class="line"><a name="l01324"></a><span class="lineno"> 1324</span> <span class="comment"></span></div>
<div class="line"><a name="l01325"></a><span class="lineno"> 1325</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01326"></a><span class="lineno"> 1326</span> <span class="comment"> * Causes the SharedLockHandle to cease to manage its managed object</span></div>
<div class="line"><a name="l01327"></a><span class="lineno"> 1327</span> <span class="comment"> * (if any), deleting it if this is the last ShareLockHandle object</span></div>
<div class="line"><a name="l01328"></a><span class="lineno"> 1328</span> <span class="comment"> * managing it. The SharedLockHandle object will manage the new</span></div>
<div class="line"><a name="l01329"></a><span class="lineno"> 1329</span> <span class="comment"> * object passed (which must not be managed by any other</span></div>
<div class="line"><a name="l01330"></a><span class="lineno"> 1330</span> <span class="comment"> * SharedLockHandle object). This method is exception safe, but see</span></div>
<div class="line"><a name="l01331"></a><span class="lineno"> 1331</span> <span class="comment"> * the comments below on Cgu::SharedHandleError.</span></div>
<div class="line"><a name="l01332"></a><span class="lineno"> 1332</span> <span class="comment"> * @param ptr A new unmanaged object to manage (if no new object is to</span></div>
<div class="line"><a name="l01333"></a><span class="lineno"> 1333</span> <span class="comment"> * be managed, use the version of reset() taking a default value of</span></div>
<div class="line"><a name="l01334"></a><span class="lineno"> 1334</span> <span class="comment"> * NULL).</span></div>
<div class="line"><a name="l01335"></a><span class="lineno"> 1335</span> <span class="comment"> * @param tag Passing the tag emumerator</span></div>
<div class="line"><a name="l01336"></a><span class="lineno"> 1336</span> <span class="comment"> * Cgu::SharedHandleAllocFail::leave causes this method not to delete</span></div>
<div class="line"><a name="l01337"></a><span class="lineno"> 1337</span> <span class="comment"> * the new managed object passed as the 'ptr' argument in the event of</span></div>
<div class="line"><a name="l01338"></a><span class="lineno"> 1338</span> <span class="comment"> * internal allocation in this method failing because of memory</span></div>
<div class="line"><a name="l01339"></a><span class="lineno"> 1339</span> <span class="comment"> * exhaustion (in that event, Cgu::SharedHandleError will be thrown).</span></div>
<div class="line"><a name="l01340"></a><span class="lineno"> 1340</span> <span class="comment"> * @exception Cgu::SharedHandleError This method might throw</span></div>
<div class="line"><a name="l01341"></a><span class="lineno"> 1341</span> <span class="comment"> * Cgu::SharedHandleError if memory is exhausted and the system would</span></div>
<div class="line"><a name="l01342"></a><span class="lineno"> 1342</span> <span class="comment"> * otherwise throw std::bad_alloc in that case. Note that if such an</span></div>
<div class="line"><a name="l01343"></a><span class="lineno"> 1343</span> <span class="comment"> * exception is thrown then this method will do nothing (it is</span></div>
<div class="line"><a name="l01344"></a><span class="lineno"> 1344</span> <span class="comment"> * strongly exception safe and will continue to manage the object it</span></div>
<div class="line"><a name="l01345"></a><span class="lineno"> 1345</span> <span class="comment"> * was managing prior to the call), and it will not attempt to delete</span></div>
<div class="line"><a name="l01346"></a><span class="lineno"> 1346</span> <span class="comment"> * the new managed object passed to it (if any). Access to the object</span></div>
<div class="line"><a name="l01347"></a><span class="lineno"> 1347</span> <span class="comment"> * passed to the 'ptr' argument can be obtained via the thrown</span></div>
<div class="line"><a name="l01348"></a><span class="lineno"> 1348</span> <span class="comment"> * Cgu::SharedHandleError object.</span></div>
<div class="line"><a name="l01349"></a><span class="lineno"> 1349</span> <span class="comment"> * @note 1. A SharedLockHandle object protects its reference count but</span></div>
<div class="line"><a name="l01350"></a><span class="lineno"> 1350</span> <span class="comment"> * not the managed object or its other internals. The reset() method</span></div>
<div class="line"><a name="l01351"></a><span class="lineno"> 1351</span> <span class="comment"> * should not be called by one thread in respect of a particular</span></div>
<div class="line"><a name="l01352"></a><span class="lineno"> 1352</span> <span class="comment"> * SharedLockHandle object while another thread may be operating on,</span></div>
<div class="line"><a name="l01353"></a><span class="lineno"> 1353</span> <span class="comment"> * copying or dereferencing the same instance of SharedLockHandle. It</span></div>
<div class="line"><a name="l01354"></a><span class="lineno"> 1354</span> <span class="comment"> * is thread-safe as against another instance of SharedLockHandle</span></div>
<div class="line"><a name="l01355"></a><span class="lineno"> 1355</span> <span class="comment"> * managing the same object.</span></div>
<div class="line"><a name="l01356"></a><span class="lineno"> 1356</span> <span class="comment"> * @note 2. On systems with over-commit/lazy-commit combined with</span></div>
<div class="line"><a name="l01357"></a><span class="lineno"> 1357</span> <span class="comment"> * virtual memory (swap), it is rarely useful to check for memory</span></div>
<div class="line"><a name="l01358"></a><span class="lineno"> 1358</span> <span class="comment"> * exhaustion, so in those cases this version of the reset() method</span></div>
<div class="line"><a name="l01359"></a><span class="lineno"> 1359</span> <span class="comment"> * will not be useful.</span></div>
<div class="line"><a name="l01360"></a><span class="lineno"> 1360</span> <span class="comment"> * @note 3. If the library has been installed using the</span></div>
<div class="line"><a name="l01361"></a><span class="lineno"> 1361</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option this</span></div>
<div class="line"><a name="l01362"></a><span class="lineno"> 1362</span> <span class="comment"> * version of the reset() method will also not be useful: instead glib</span></div>
<div class="line"><a name="l01363"></a><span class="lineno"> 1363</span> <span class="comment"> * will terminate the program if it is unable to obtain memory from</span></div>
<div class="line"><a name="l01364"></a><span class="lineno"> 1364</span> <span class="comment"> * the operating system.</span></div>
<div class="line"><a name="l01365"></a><span class="lineno"> 1365</span> <span class="comment"> * @note 4. By default, glib atomic functions are used to provide</span></div>
<div class="line"><a name="l01366"></a><span class="lineno"> 1366</span> <span class="comment"> * thread-safe manipulation of the reference count. However, the</span></div>
<div class="line"><a name="l01367"></a><span class="lineno"> 1367</span> <span class="comment"> * header file shared_handle.h can be textually amended before the</span></div>
<div class="line"><a name="l01368"></a><span class="lineno"> 1368</span> <span class="comment"> * library is compiled to define the symbol</span></div>
<div class="line"><a name="l01369"></a><span class="lineno"> 1369</span> <span class="comment"> * CGU_SHARED_LOCK_HANDLE_USE_MUTEX so as to use mutexes instead,</span></div>
<div class="line"><a name="l01370"></a><span class="lineno"> 1370</span> <span class="comment"> * which might be useful for some debugging purposes. Were that to be</span></div>
<div class="line"><a name="l01371"></a><span class="lineno"> 1371</span> <span class="comment"> * done, Cgu::SharedHandleError might be thrown by this method if</span></div>
<div class="line"><a name="l01372"></a><span class="lineno"> 1372</span> <span class="comment"> * initialization of the mutex fails (even if the</span></div>
<div class="line"><a name="l01373"></a><span class="lineno"> 1373</span> <span class="comment"> * \--with-glib-memory-slices-no-compat configuration option is</span></div>
<div class="line"><a name="l01374"></a><span class="lineno"> 1374</span> <span class="comment"> * chosen).</span></div>
<div class="line"><a name="l01375"></a><span class="lineno"> 1375</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01376"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#acb8c88abc488e201ee1f63c8365a18a2"> 1376</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1SharedLockHandle.html#acb8c88abc488e201ee1f63c8365a18a2">reset</a>(T ptr, <a class="code" href="namespaceCgu_1_1SharedHandleAllocFail.html#af5c4cd2e39804471ea3862a1dd18165b">Cgu::SharedHandleAllocFail::Leave</a> tag) {</div>
<div class="line"><a name="l01377"></a><span class="lineno"> 1377</span>  <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a> tmp(ptr, tag);</div>
<div class="line"><a name="l01378"></a><span class="lineno"> 1378</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(ref_items, tmp.ref_items);</div>
<div class="line"><a name="l01379"></a><span class="lineno"> 1379</span>  }</div>
<div class="line"><a name="l01380"></a><span class="lineno"> 1380</span> <span class="comment"></span></div>
<div class="line"><a name="l01381"></a><span class="lineno"> 1381</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01382"></a><span class="lineno"> 1382</span> <span class="comment"> * The copy constructor does not throw.</span></div>
<div class="line"><a name="l01383"></a><span class="lineno"> 1383</span> <span class="comment"> * @param sh_hand The handle to be copied.</span></div>
<div class="line"><a name="l01384"></a><span class="lineno"> 1384</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01385"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#a48e7c3d7fc7736208cf716dda585de82"> 1385</a></span>  <a class="code" href="classCgu_1_1SharedLockHandle.html#a48e7c3d7fc7736208cf716dda585de82">SharedLockHandle</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a>& sh_hand) noexcept {</div>
<div class="line"><a name="l01386"></a><span class="lineno"> 1386</span>  ref_items = sh_hand.ref_items;</div>
<div class="line"><a name="l01387"></a><span class="lineno"> 1387</span>  reference();</div>
<div class="line"><a name="l01388"></a><span class="lineno"> 1388</span>  }</div>
<div class="line"><a name="l01389"></a><span class="lineno"> 1389</span> <span class="comment"></span></div>
<div class="line"><a name="l01390"></a><span class="lineno"> 1390</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01391"></a><span class="lineno"> 1391</span> <span class="comment"> * The move constructor does not throw. It has move semantics.</span></div>
<div class="line"><a name="l01392"></a><span class="lineno"> 1392</span> <span class="comment"> * @param sh_hand The handle to be moved.</span></div>
<div class="line"><a name="l01393"></a><span class="lineno"> 1393</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01394"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#ae4aa6e9ddffab4af9ace68c41b790073"> 1394</a></span>  <a class="code" href="classCgu_1_1SharedLockHandle.html#ae4aa6e9ddffab4af9ace68c41b790073">SharedLockHandle</a>(<a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a>&& sh_hand) noexcept {</div>
<div class="line"><a name="l01395"></a><span class="lineno"> 1395</span>  ref_items = sh_hand.ref_items;</div>
<div class="line"><a name="l01396"></a><span class="lineno"> 1396</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01397"></a><span class="lineno"> 1397</span> <span class="preprocessor"></span> sh_hand.ref_items.mutex_p = 0; <span class="comment">// make sure the value is valid as we may assign it</span></div>
<div class="line"><a name="l01398"></a><span class="lineno"> 1398</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01399"></a><span class="lineno"> 1399</span> <span class="preprocessor"></span> sh_hand.ref_items.ref_count_p = 0;</div>
<div class="line"><a name="l01400"></a><span class="lineno"> 1400</span>  sh_hand.ref_items.obj = 0;</div>
<div class="line"><a name="l01401"></a><span class="lineno"> 1401</span>  }</div>
<div class="line"><a name="l01402"></a><span class="lineno"> 1402</span> <span class="comment"></span></div>
<div class="line"><a name="l01403"></a><span class="lineno"> 1403</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01404"></a><span class="lineno"> 1404</span> <span class="comment"> * This method (and so copy or move assignment) does not throw unless</span></div>
<div class="line"><a name="l01405"></a><span class="lineno"> 1405</span> <span class="comment"> * the destructor of a managed object throws.</span></div>
<div class="line"><a name="l01406"></a><span class="lineno"> 1406</span> <span class="comment"> * @param sh_hand the assignor.</span></div>
<div class="line"><a name="l01407"></a><span class="lineno"> 1407</span> <span class="comment"> * @return The SharedLockHandle object after assignment.</span></div>
<div class="line"><a name="l01408"></a><span class="lineno"> 1408</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01409"></a><span class="lineno"> 1409</span>  <span class="comment">// having a value type as the argument, rather than reference to const</span></div>
<div class="line"><a name="l01410"></a><span class="lineno"> 1410</span>  <span class="comment">// and then initialising a tmp object, gives the compiler more scope</span></div>
<div class="line"><a name="l01411"></a><span class="lineno"> 1411</span>  <span class="comment">// for optimisation</span></div>
<div class="line"><a name="l01412"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#a6518142e137af1200fb1b16f173faf12"> 1412</a></span>  <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a>& <a class="code" href="classCgu_1_1SharedLockHandle.html#a6518142e137af1200fb1b16f173faf12">operator=</a>(<a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle</a> sh_hand) {</div>
<div class="line"><a name="l01413"></a><span class="lineno"> 1413</span>  <a class="code" href="namespaceCgu.html#af7fd3a7ee74c9924a1449a3acad2f821">std::swap</a>(ref_items, sh_hand.ref_items);</div>
<div class="line"><a name="l01414"></a><span class="lineno"> 1414</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l01415"></a><span class="lineno"> 1415</span>  }</div>
<div class="line"><a name="l01416"></a><span class="lineno"> 1416</span> <span class="comment"></span></div>
<div class="line"><a name="l01417"></a><span class="lineno"> 1417</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01418"></a><span class="lineno"> 1418</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l01419"></a><span class="lineno"> 1419</span> <span class="comment"> * @return A pointer to the handled object (or NULL if none is</span></div>
<div class="line"><a name="l01420"></a><span class="lineno"> 1420</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l01421"></a><span class="lineno"> 1421</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01422"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#ac3c1d1f41e275bf021055ceac2419592"> 1422</a></span>  T <span class="keyword">get</span>() <span class="keyword">const</span> noexcept {<span class="keywordflow">return</span> ref_items.obj;}</div>
<div class="line"><a name="l01423"></a><span class="lineno"> 1423</span> <span class="comment"></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"> * This method does not throw.</span></div>
<div class="line"><a name="l01426"></a><span class="lineno"> 1426</span> <span class="comment"> * @return A pointer to the handled object (or NULL if none is</span></div>
<div class="line"><a name="l01427"></a><span class="lineno"> 1427</span> <span class="comment"> * handled).</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"><a class="code" href="classCgu_1_1SharedLockHandle.html#a56e539f82122df951b30062a3cd1ed24"> 1429</a></span>  <span class="keyword">operator</span> T() const noexcept {<span class="keywordflow">return</span> ref_items.obj;}</div>
<div class="line"><a name="l01430"></a><span class="lineno"> 1430</span> <span class="comment"></span></div>
<div class="line"><a name="l01431"></a><span class="lineno"> 1431</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l01432"></a><span class="lineno"> 1432</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l01433"></a><span class="lineno"> 1433</span> <span class="comment"> * @return The number of SharedLockHandle objects referencing the</span></div>
<div class="line"><a name="l01434"></a><span class="lineno"> 1434</span> <span class="comment"> * managed object (or 0 if none is managed by this SharedLockHandle).</span></div>
<div class="line"><a name="l01435"></a><span class="lineno"> 1435</span> <span class="comment"> * @note The return value may not be valid if another thread has</span></div>
<div class="line"><a name="l01436"></a><span class="lineno"> 1436</span> <span class="comment"> * changed the reference count before the value returned by this</span></div>
<div class="line"><a name="l01437"></a><span class="lineno"> 1437</span> <span class="comment"> * method is acted on. It is provided as a utility, but may not be</span></div>
<div class="line"><a name="l01438"></a><span class="lineno"> 1438</span> <span class="comment"> * meaningful, depending on the intended usage.</span></div>
<div class="line"><a name="l01439"></a><span class="lineno"> 1439</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01440"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#aacfb662d60523040da18768c3bb21e08"> 1440</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classCgu_1_1SharedLockHandle.html#aacfb662d60523040da18768c3bb21e08">get_refcount</a>() const noexcept {</div>
<div class="line"><a name="l01441"></a><span class="lineno"> 1441</span>  <span class="keywordflow">if</span> (!ref_items.ref_count_p) <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l01442"></a><span class="lineno"> 1442</span> <span class="preprocessor">#ifdef CGU_SHARED_LOCK_HANDLE_USE_MUTEX</span></div>
<div class="line"><a name="l01443"></a><span class="lineno"> 1443</span> <span class="preprocessor"></span> <a class="code" href="classCgu_1_1Thread_1_1Mutex_1_1Lock.html" title="A scoped locking class for exception safe Mutex locking. ">Thread::Mutex::Lock</a> lock(*ref_items.mutex_p);</div>
<div class="line"><a name="l01444"></a><span class="lineno"> 1444</span>  <span class="keywordflow">return</span> *ref_items.ref_count_p;</div>
<div class="line"><a name="l01445"></a><span class="lineno"> 1445</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l01446"></a><span class="lineno"> 1446</span> <span class="preprocessor"></span> <span class="keywordflow">return</span> g_atomic_int_get(ref_items.ref_count_p);</div>
<div class="line"><a name="l01447"></a><span class="lineno"> 1447</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01448"></a><span class="lineno"> 1448</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l01449"></a><span class="lineno"> 1449</span> <span class="comment"></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"> * The destructor does not throw unless the destructor of a handled</span></div>
<div class="line"><a name="l01452"></a><span class="lineno"> 1452</span> <span class="comment"> * object throws - that should never happen.</span></div>
<div class="line"><a name="l01453"></a><span class="lineno"> 1453</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01454"></a><span class="lineno"><a class="code" href="classCgu_1_1SharedLockHandle.html#abd3141dcb093eb4ecca2bc258f6695cc"> 1454</a></span>  <a class="code" href="classCgu_1_1SharedLockHandle.html#abd3141dcb093eb4ecca2bc258f6695cc">~SharedLockHandle</a>() {unreference();}</div>
<div class="line"><a name="l01455"></a><span class="lineno"> 1455</span> };</div>
<div class="line"><a name="l01456"></a><span class="lineno"> 1456</span> </div>
<div class="line"><a name="l01457"></a><span class="lineno"> 1457</span> <span class="preprocessor">#if defined(CGU_USE_SMART_PTR_COMPARISON) || defined(DOXYGEN_PARSING)</span></div>
<div class="line"><a name="l01458"></a><span class="lineno"> 1458</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01459"></a><span class="lineno"> 1459</span> <span class="comment">// we can use built-in operator == when comparing pointers referencing</span></div>
<div class="line"><a name="l01460"></a><span class="lineno"> 1460</span> <span class="comment">// different objects of the same type</span><span class="comment"></span></div>
<div class="line"><a name="l01461"></a><span class="lineno"> 1461</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01462"></a><span class="lineno"> 1462</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l01463"></a><span class="lineno"> 1463</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01464"></a><span class="lineno"> 1464</span> <span class="comment"> * This comparison operator does not throw. It compares the addresses</span></div>
<div class="line"><a name="l01465"></a><span class="lineno"> 1465</span> <span class="comment"> * of the managed objects.</span></div>
<div class="line"><a name="l01466"></a><span class="lineno"> 1466</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01467"></a><span class="lineno"> 1467</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l01468"></a><span class="lineno"> 1468</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01469"></a><span class="lineno"> 1469</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01470"></a><span class="lineno"><a class="code" href="group__handles.html#ga3f19a81b00acd90392712e2c6fbc3a46"> 1470</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__handles.html#gae31f500ae48d467e4f19a85238317aeb">operator==</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle<T, Dealloc></a>& s1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle<T, Dealloc></a>& s2) noexcept {</div>
<div class="line"><a name="l01471"></a><span class="lineno"> 1471</span>  <span class="keywordflow">return</span> (s1.get() == s2.get());</div>
<div class="line"><a name="l01472"></a><span class="lineno"> 1472</span> }</div>
<div class="line"><a name="l01473"></a><span class="lineno"> 1473</span> <span class="comment"></span></div>
<div class="line"><a name="l01474"></a><span class="lineno"> 1474</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01475"></a><span class="lineno"> 1475</span> <span class="comment"> * @ingroup handles</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"> * This comparison operator does not throw. It compares the addresses</span></div>
<div class="line"><a name="l01478"></a><span class="lineno"> 1478</span> <span class="comment"> * of the managed objects.</span></div>
<div class="line"><a name="l01479"></a><span class="lineno"> 1479</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01480"></a><span class="lineno"> 1480</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l01481"></a><span class="lineno"> 1481</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01482"></a><span class="lineno"> 1482</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01483"></a><span class="lineno"><a class="code" href="group__handles.html#ga08be91dd7a32508819f469e0fcfc1814"> 1483</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__handles.html#ga1a3dd375618ebb42260ee6c4c2478bd4">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle<T, Dealloc></a>& s1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle<T, Dealloc></a>& s2) noexcept {</div>
<div class="line"><a name="l01484"></a><span class="lineno"> 1484</span>  <span class="keywordflow">return</span> !(s1 == s2);</div>
<div class="line"><a name="l01485"></a><span class="lineno"> 1485</span> }</div>
<div class="line"><a name="l01486"></a><span class="lineno"> 1486</span> </div>
<div class="line"><a name="l01487"></a><span class="lineno"> 1487</span> <span class="comment">// we must use std::less rather than the < built-in operator for</span></div>
<div class="line"><a name="l01488"></a><span class="lineno"> 1488</span> <span class="comment">// pointers to objects not within the same array or object: "For</span></div>
<div class="line"><a name="l01489"></a><span class="lineno"> 1489</span> <span class="comment">// templates greater, less, greater_equal, and less_equal, the</span></div>
<div class="line"><a name="l01490"></a><span class="lineno"> 1490</span> <span class="comment">// specializations for any pointer type yield a total order, even if</span></div>
<div class="line"><a name="l01491"></a><span class="lineno"> 1491</span> <span class="comment">// the built-in operators <, >, <=, >= do not." (para 20.3.3/8).</span><span class="comment"></span></div>
<div class="line"><a name="l01492"></a><span class="lineno"> 1492</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01493"></a><span class="lineno"> 1493</span> <span class="comment"> * @ingroup handles</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"> * This comparison operator does not throw unless std::less applied to</span></div>
<div class="line"><a name="l01496"></a><span class="lineno"> 1496</span> <span class="comment"> * pointer types throws (which it would not do with any sane</span></div>
<div class="line"><a name="l01497"></a><span class="lineno"> 1497</span> <span class="comment"> * implementation). It compares the addresses of the managed objects.</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"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l01500"></a><span class="lineno"> 1500</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01501"></a><span class="lineno"> 1501</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01502"></a><span class="lineno"><a class="code" href="group__handles.html#ga71dcc43354a4522f2a681ef752f87f46"> 1502</a></span> <span class="keywordtype">bool</span> operator<(const SharedHandle<T, Dealloc>& s1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle<T, Dealloc></a>& s2) {</div>
<div class="line"><a name="l01503"></a><span class="lineno"> 1503</span>  <span class="keywordflow">return</span> std::less<T>()(s1.get(), s2.get());</div>
<div class="line"><a name="l01504"></a><span class="lineno"> 1504</span> }</div>
<div class="line"><a name="l01505"></a><span class="lineno"> 1505</span> <span class="comment"></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"> * @ingroup handles</span></div>
<div class="line"><a name="l01508"></a><span class="lineno"> 1508</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01509"></a><span class="lineno"> 1509</span> <span class="comment"> * This comparison operator does not throw. It compares the addresses</span></div>
<div class="line"><a name="l01510"></a><span class="lineno"> 1510</span> <span class="comment"> * of the managed objects.</span></div>
<div class="line"><a name="l01511"></a><span class="lineno"> 1511</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01512"></a><span class="lineno"> 1512</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l01513"></a><span class="lineno"> 1513</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01514"></a><span class="lineno"> 1514</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01515"></a><span class="lineno"><a class="code" href="group__handles.html#gaa863801d0226381e8ff971e91984e59d"> 1515</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__handles.html#gae31f500ae48d467e4f19a85238317aeb">operator==</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle<T, Dealloc></a>& s1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle<T, Dealloc></a>& s2) noexcept {</div>
<div class="line"><a name="l01516"></a><span class="lineno"> 1516</span>  <span class="keywordflow">return</span> (s1.get() == s2.get());</div>
<div class="line"><a name="l01517"></a><span class="lineno"> 1517</span> }</div>
<div class="line"><a name="l01518"></a><span class="lineno"> 1518</span> <span class="comment"></span></div>
<div class="line"><a name="l01519"></a><span class="lineno"> 1519</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01520"></a><span class="lineno"> 1520</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l01521"></a><span class="lineno"> 1521</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01522"></a><span class="lineno"> 1522</span> <span class="comment"> * This comparison operator does not throw. It compares the addresses</span></div>
<div class="line"><a name="l01523"></a><span class="lineno"> 1523</span> <span class="comment"> * of the managed objects.</span></div>
<div class="line"><a name="l01524"></a><span class="lineno"> 1524</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01525"></a><span class="lineno"> 1525</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l01526"></a><span class="lineno"> 1526</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01527"></a><span class="lineno"> 1527</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01528"></a><span class="lineno"><a class="code" href="group__handles.html#ga3ae4ed3b191ea31a097d2bfceeed8e5e"> 1528</a></span> <span class="keywordtype">bool</span> <a class="code" href="group__handles.html#ga1a3dd375618ebb42260ee6c4c2478bd4">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle<T, Dealloc></a>& s1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle<T, Dealloc></a>& s2) noexcept {</div>
<div class="line"><a name="l01529"></a><span class="lineno"> 1529</span>  <span class="keywordflow">return</span> !(s1 == s2);</div>
<div class="line"><a name="l01530"></a><span class="lineno"> 1530</span> }</div>
<div class="line"><a name="l01531"></a><span class="lineno"> 1531</span> <span class="comment"></span></div>
<div class="line"><a name="l01532"></a><span class="lineno"> 1532</span> <span class="comment">/**</span></div>
<div class="line"><a name="l01533"></a><span class="lineno"> 1533</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l01534"></a><span class="lineno"> 1534</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01535"></a><span class="lineno"> 1535</span> <span class="comment"> * This comparison operator does not throw unless std::less applied to</span></div>
<div class="line"><a name="l01536"></a><span class="lineno"> 1536</span> <span class="comment"> * pointer types throws (which it would not do with any sane</span></div>
<div class="line"><a name="l01537"></a><span class="lineno"> 1537</span> <span class="comment"> * implementation). It compares the addresses of the managed objects.</span></div>
<div class="line"><a name="l01538"></a><span class="lineno"> 1538</span> <span class="comment"> *</span></div>
<div class="line"><a name="l01539"></a><span class="lineno"> 1539</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l01540"></a><span class="lineno"> 1540</span> <span class="comment"> */</span></div>
<div class="line"><a name="l01541"></a><span class="lineno"> 1541</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01542"></a><span class="lineno"><a class="code" href="group__handles.html#ga69fd3c33f1297830ab9319039e8c4939"> 1542</a></span> <span class="keywordtype">bool</span> operator<(const SharedLockHandle<T, Dealloc>& s1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">SharedLockHandle<T, Dealloc></a>& s2) {</div>
<div class="line"><a name="l01543"></a><span class="lineno"> 1543</span>  <span class="keywordflow">return</span> std::less<T>()(s1.get(), s2.get());</div>
<div class="line"><a name="l01544"></a><span class="lineno"> 1544</span> }</div>
<div class="line"><a name="l01545"></a><span class="lineno"> 1545</span> </div>
<div class="line"><a name="l01546"></a><span class="lineno"> 1546</span> <span class="preprocessor">#endif // CGU_USE_SMART_PTR_COMPARISON</span></div>
<div class="line"><a name="l01547"></a><span class="lineno"> 1547</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01548"></a><span class="lineno"> 1548</span> } <span class="comment">// namespace Cgu</span></div>
<div class="line"><a name="l01549"></a><span class="lineno"> 1549</span> </div>
<div class="line"><a name="l01550"></a><span class="lineno"> 1550</span> <span class="comment">// doxygen produces long filenames that tar can't handle:</span></div>
<div class="line"><a name="l01551"></a><span class="lineno"> 1551</span> <span class="comment">// we have generic documentation for std::hash specialisations</span></div>
<div class="line"><a name="l01552"></a><span class="lineno"> 1552</span> <span class="comment">// in doxygen.main.in</span></div>
<div class="line"><a name="l01553"></a><span class="lineno"> 1553</span> <span class="preprocessor">#if defined(CGU_USE_SMART_PTR_COMPARISON) && !defined(DOXYGEN_PARSING)</span></div>
<div class="line"><a name="l01554"></a><span class="lineno"> 1554</span> <span class="preprocessor"></span><span class="comment">/* These structs allow SharedHandle and SharedLockHandle objects to be</span></div>
<div class="line"><a name="l01555"></a><span class="lineno"> 1555</span> <span class="comment"> keys in unordered associative containers */</span></div>
<div class="line"><a name="l01556"></a><span class="lineno"> 1556</span> <span class="keyword">namespace </span>std {</div>
<div class="line"><a name="l01557"></a><span class="lineno"> 1557</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01558"></a><span class="lineno"> 1558</span> <span class="keyword">struct </span>hash<Cgu::SharedHandle<T, Dealloc>> {</div>
<div class="line"><a name="l01559"></a><span class="lineno"> 1559</span>  <span class="keyword">typedef</span> std::size_t result_type;</div>
<div class="line"><a name="l01560"></a><span class="lineno"> 1560</span>  <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">Cgu::SharedHandle<T, Dealloc></a> argument_type;</div>
<div class="line"><a name="l01561"></a><span class="lineno"> 1561</span>  result_type operator()(<span class="keyword">const</span> argument_type& s)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l01562"></a><span class="lineno"> 1562</span>  <span class="comment">// this is fine: std::hash structs do not normally contain data and</span></div>
<div class="line"><a name="l01563"></a><span class="lineno"> 1563</span>  <span class="comment">// std::hash<T*> certainly won't, so we don't have overhead constructing</span></div>
<div class="line"><a name="l01564"></a><span class="lineno"> 1564</span>  <span class="comment">// std::hash<T*> on the fly</span></div>
<div class="line"><a name="l01565"></a><span class="lineno"> 1565</span>  <span class="keywordflow">return</span> <a class="code" href="classstd_1_1hash.html" title="A specialization of std::hash for Cgu::Callback::FunctorArg, Cgu::Callback::SafeFunctorArg, Cgu::GobjHandle, Cgu::GvarHandle, Cgu::IntrusivePtr, Cgu::SharedHandle, Cgu::SharedLockHandle, Cgu::SharedPtr and Cgu::SharedLockPtr so that such objects may be keys of unordered associative containers. ">std::hash<T></a>()(s.get());</div>
<div class="line"><a name="l01566"></a><span class="lineno"> 1566</span>  }</div>
<div class="line"><a name="l01567"></a><span class="lineno"> 1567</span> };</div>
<div class="line"><a name="l01568"></a><span class="lineno"> 1568</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> Dealloc></div>
<div class="line"><a name="l01569"></a><span class="lineno"> 1569</span> <span class="keyword">struct </span>hash<Cgu::SharedLockHandle<T, Dealloc>> {</div>
<div class="line"><a name="l01570"></a><span class="lineno"> 1570</span>  <span class="keyword">typedef</span> std::size_t result_type;</div>
<div class="line"><a name="l01571"></a><span class="lineno"> 1571</span>  <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1SharedLockHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore, with a thread safe reference count.. ">Cgu::SharedLockHandle<T, Dealloc></a> argument_type;</div>
<div class="line"><a name="l01572"></a><span class="lineno"> 1572</span>  result_type operator()(<span class="keyword">const</span> argument_type& s)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l01573"></a><span class="lineno"> 1573</span>  <span class="comment">// this is fine: std::hash structs do not normally contain data and</span></div>
<div class="line"><a name="l01574"></a><span class="lineno"> 1574</span>  <span class="comment">// std::hash<T*> certainly won't, so we don't have overhead constructing</span></div>
<div class="line"><a name="l01575"></a><span class="lineno"> 1575</span>  <span class="comment">// std::hash<T*> on the fly</span></div>
<div class="line"><a name="l01576"></a><span class="lineno"> 1576</span>  <span class="keywordflow">return</span> <a class="code" href="classstd_1_1hash.html" title="A specialization of std::hash for Cgu::Callback::FunctorArg, Cgu::Callback::SafeFunctorArg, Cgu::GobjHandle, Cgu::GvarHandle, Cgu::IntrusivePtr, Cgu::SharedHandle, Cgu::SharedLockHandle, Cgu::SharedPtr and Cgu::SharedLockPtr so that such objects may be keys of unordered associative containers. ">std::hash<T></a>()(s.get());</div>
<div class="line"><a name="l01577"></a><span class="lineno"> 1577</span>  }</div>
<div class="line"><a name="l01578"></a><span class="lineno"> 1578</span> };</div>
<div class="line"><a name="l01579"></a><span class="lineno"> 1579</span> } <span class="comment">// namespace std</span></div>
<div class="line"><a name="l01580"></a><span class="lineno"> 1580</span> <span class="preprocessor">#endif // CGU_USE_SMART_PTR_COMPARISON</span></div>
<div class="line"><a name="l01581"></a><span class="lineno"> 1581</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l01582"></a><span class="lineno"> 1582</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 16 2013 20:45:30 for c++-gtk-utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
