<!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: gobj_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">gobj_handle.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gobj__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) 2005 to 2013 Chris Vine</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">The library comprised in this file or of which this file is part is</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">distributed by Chris Vine under the GNU Lesser General Public</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">License as follows:</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1 of</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> Lesser General Public License, version 2.1, for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> License, version 2.1, along with this library (see the file LGPL.TXT</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> which came with this source code package in the 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_GOBJ_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_GOBJ_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="preprocessor">#include <exception></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include <functional></span> <span class="comment">// for std::less and std::hash<T*></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include <cstddef></span> <span class="comment">// for std::size_t</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include <glib-object.h></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include <<a class="code" href="cgu__config_8h.html">c++-gtk-utils/cgu_config.h</a>></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @addtogroup handles handles and smart pointers</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">namespace </span>Cgu {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @class GobjHandle gobj_handle.h c++-gtk-utils/gobj_handle.h</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @brief This is a handle for managing the reference count of</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * GObjects.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @sa MainWidgetBase GobjWeakHandle</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"> * This is a class which manages the reference count of GObjects. It</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * does not maintain its own reference count, but interfaces with that</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * kept by the glib object system.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * GobjHandles are most useful to manage GObjects which are not also</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * GtkWidgets or GInitiallyUnowned objects - GtkWidgets and</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * GInitiallyUnowned objects have initial floating references which</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * will result in them being automatically managed by the container in</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * which they are held. Nonetheless, GobjHandles can be used to hold</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * GtkWidgets and GInitiallyUnowned objects, as the constructor of a</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * GobjHandle which takes a pointer will automatically take ownership</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * of a newly created GtkWidget or GInitiallyUnowned object, by</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * calling g_object_ref_sink(). Plain GObjects do not need to be sunk</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * to be owned by the GobjHandle.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * Note that g_object_ref_sink() is not called by the constructor</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * taking a pointer if the floating reference has already been sunk,</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * so if that constructor is passed an object already owned by a GTK+</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * container it will be necessary to call g_object_ref() on it</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * explicitly. This behaviour will ensure that the handle behaves the</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * same whether it is holding a plain GObject, or it is holding a</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * GInitiallyUnowned/GtkWidget object. Generally however, where an</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * object is already owned by a container, the object should be passed</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * by another handle - ie by the copy constructor (or by the</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * assignment operator), as those always increment the reference count</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * automatically.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * In other words, invoke the constructor taking a pointer only with a</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * newly created object (whether a GObject, GInitiallyUnowned or</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * GtkWidget object), and everything else will take care of itself. In</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * this respect, GobjHandles work the same way as conventional shared</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * pointer implementations managing objects allocated on free store.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * The same applies to the reset() method. (Care is required however</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * if initializing a Cgu::GobjHandle with a widget or GObject object</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * obtained from GtkBuilder, since these are not "newly created" in</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * this sense. It is necessary to call g_object_ref() by hand in that</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * case, since GtkBuilder does not by itself pass ownership of any</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * objects it creates.)</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * Because any GTK+ containers themselves increment the reference</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * count of a GObject or GtkWidget where they need to take ownership,</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * an already-managed object held by a GobjHandle can safely be passed</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * by pointer to a GTK+ container, and that is one of the intended</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * usages. For that purpose, although the class has operator*() and</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * operator->() dereferencing operators, and so has normal smart</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * pointer functionality, as it is intended for use with the normal C</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * GObject/pango/GTK+ interfaces, ordinary use would involve passing</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * the handle to a function taking a pointer by means of the</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * operatorT*() type conversion operator (which returns the underlying</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * pointer), or by explicitly calling the get() method to obtain the</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * underlying pointer.</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * The principal intended usage of GobjHandle is to automatically</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * handle GObject reference counts and therefore to make GObjects</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * exception-safe, but they also permit GObjects/GtkWidgets to be kept</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * in standard C++ containers.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * As of glib-2.8, g_object_ref() and g_object_unref() are thread</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * safe, so with glib-2.8 or greater there can be different GobjHandle</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * instances in different threads referencing the same GObject object.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * Of course, if that is done, this does not affect the need (or</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * otherwise) in the particular use in question to lock anything other</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * than the reference count - say when accessing the referenced object</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * itself in different threads.</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * Typical usage might be, for example, as follows:</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * GobjHandle<GtkListStore> store(gtk_list_store_new(1, G_TYPE_STRING));</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * [ ... fill the list store ... ]</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * GobjHandle<GtkWidget> view(gtk_tree_view_new_with_model(GTK_TREE_MODEL(store.get()));</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * // 'view' will take sole ownership of the list store when 'store' goes out of scope, or</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * // 'store' could be kept alive so that the list store will survive removal from the view</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * [ ... set up an interface including a GtkVBox 'vbox' which will hold the tree view ... ]</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * gtk_container_add(GTK_CONTAINER(vbox), view);</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * // 'vbox' will take sole ownership of the tree view when 'view' goes out of scope, or</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * // 'view' could be kept alive so that the tree view will survive removal from the vbox</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html"> 148</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a> {</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  T* obj_p;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">void</span> unreference() {</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">if</span> (obj_p) g_object_unref(obj_p);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">void</span> reference() noexcept {</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordflow">if</span> (obj_p) g_object_ref(obj_p);</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  }</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * The constructor does not throw. g_object_ref_sink() is called if</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * the managed object has a floating reference.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @param ptr The object which the GobjHandle is to manage (if any).</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @note The object passed should not normally be already owned by a</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * GTK+ container or managed by any other GobjHandle object. If it</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * is, g_object_ref() must be called explicitly by the user code.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#ac93d923d4899beca947f82e4dd2b01e1"> 170</a></span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1GobjHandle.html#ac93d923d4899beca947f82e4dd2b01e1">GobjHandle</a>(T* ptr = 0) noexcept {</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  obj_p = ptr;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// if an object with a floating reference has been passed to this constructor,</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="comment">// take ownership of it</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordflow">if</span> (ptr && g_object_is_floating(ptr)) {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  g_object_ref_sink(ptr);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  }</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  }</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"></span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * Causes the handle to cease to manage its managed object (if any)</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * and decrements its reference count, so destroying it if the</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * reference count thereby becomes 0. If the argument passed is not</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * NULL, the handle will manage the new object passed and</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * g_object_ref_sink() is called if the new object has a floating</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * reference. This method does not throw (unless this method</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * destroys a sub-classed GObject which has a member object whose</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * destructor throws).</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param ptr NULL (the default), or a new object to manage.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @note The new object passed should not normally be already owned</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * by a GTK+ container or managed by any other GobjHandle object. If</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * it is, g_object_ref() must be called explicitly by the user code.</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a93e0943687dc51f7bbb115cee4138629"> 194</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GobjHandle.html#a93e0943687dc51f7bbb115cee4138629">reset</a>(T* ptr = 0) {</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  unreference();</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  obj_p = ptr;</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="comment">// if an object with a floating reference has been passed to this method,</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="comment">// take ownership of it</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keywordflow">if</span> (ptr && g_object_is_floating(ptr)) {</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  g_object_ref_sink(ptr);</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  }</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</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"> /**</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * The copy constructor does not throw. It increments the reference</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * count of the managed object.</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * @param gobj The handle to be copied.</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a2bbd77d0e3b0f2bb1e96cc03e02b15be"> 211</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html#a2bbd77d0e3b0f2bb1e96cc03e02b15be">GobjHandle</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a>& gobj) noexcept {</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  obj_p = gobj.obj_p;</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  reference();</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  }</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"></span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * The move constructor does not throw. It has move semantics.</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * @param gobj The handle to be moved.</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a73aa088c57f9a3793a66c22bb6f76dd3"> 220</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html#a73aa088c57f9a3793a66c22bb6f76dd3">GobjHandle</a>(<a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a>&& gobj) noexcept {</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  obj_p = gobj.obj_p;</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  gobj.obj_p = 0;</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  }</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="comment">// We don't have a constructor for GobjHandle taking a GobjWeakHandle</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="comment">// object. If we did that, we would have to remove the GobjWeakHandle</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="comment">// constructor taking a pointer so we know that its tracked object</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="comment">// always has an owner when initialising a new GobjHandle with the</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="comment">// GobjWeakHandle, so we can in turn know we can increase the reference</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">// count when initialising the GobjHandle. However, removing that</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="comment">// constructor would be inconsistent with one of the purposes of having</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="comment">// a GobjWeakHandle class. For the same reason, we don't have an</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="comment">// assignment operator for GobjHandle taking such an object.</span><span class="comment"></span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * This method decrements the reference count of the former managed</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * object (if any), so destroying it if the reference count thereby</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * becomes 0, and increments the reference count of the new managed</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * object. This method does not throw (unless this method destroys a</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * sub-classed GObject which has a member object whose destructor</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * throws).</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * @param gobj The assignor.</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @return The GobjHandle object after assignment.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a8cd42c69b5eea1725b891ee3b81e4995"> 244</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a>& <a class="code" href="classCgu_1_1GobjHandle.html#a8cd42c69b5eea1725b891ee3b81e4995">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a>& gobj) {</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="comment">// check whether we are already referencing this object -</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="comment">// if so make this a null op. This will also deal with</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="comment">// self-assignment</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keywordflow">if</span> (obj_p != gobj.obj_p) {</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="comment">// first unreference any object referenced by this handle</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  unreference();</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">// now inherit the GObject from the assigning handle</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="comment">// and reference it</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  obj_p = gobj.obj_p;</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  reference();</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  }</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  }</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"></span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * This method decrements the reference count of the former managed</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * object (if any), so destroying it if the reference count thereby</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * becomes 0, and has move semantics with respect to the new managed</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * object. This method does not throw (unless this method destroys a</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * sub-classed GObject which has a member object whose destructor</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * throws).</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @param gobj The handle to be moved.</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * @return The GobjHandle object after the move operation.</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a03be4ca53ebef146acc19b42b89676f6"> 272</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a>& <a class="code" href="classCgu_1_1GobjHandle.html#a03be4ca53ebef146acc19b42b89676f6">operator=</a>(<a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle</a>&& gobj) {</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="comment">// check for self-assignment</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keywordflow">if</span> (<span class="keyword">this</span> != &gobj) {</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="comment">// first unreference any object referenced by this handle</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  unreference();</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="comment">// now inherit the GObject from the moving handle</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  obj_p = gobj.obj_p;</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  gobj.obj_p = 0;</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  }</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  }</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"></span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * @return A pointer to the handled GObject (or NULL if none is</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#ab3084128f75535d4a0260dd055c5f01e"> 292</a></span>  T* <span class="keyword">get</span>() <span class="keyword">const</span> noexcept {<span class="keywordflow">return</span> obj_p;}</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"> /**</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * @return A reference to the handled GObject.</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#af93d18a058f5eb8ea2f6234c9c0bccc6"> 298</a></span>  T& <a class="code" href="classCgu_1_1GobjHandle.html#af93d18a058f5eb8ea2f6234c9c0bccc6">operator*</a>() const noexcept {<span class="keywordflow">return</span> *obj_p;}</div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"></span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * @return A pointer to the handled GObject (or NULL if none is</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a7aeaeada0661ce711c1767861e98c4c4"> 305</a></span>  T* <a class="code" href="classCgu_1_1GobjHandle.html#a7aeaeada0661ce711c1767861e98c4c4">operator-></a>() const noexcept {<span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"></span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * @return A pointer to the handled GObject (or NULL if none is</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * handled).</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#ad9815db18f4baa77a8176335b09317ca"> 312</a></span>  <span class="keyword">operator</span> T*() <span class="keyword">const</span> noexcept {<span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"></span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * The destructor does not throw. It decrements the reference count</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * of the managed object (if any), so destroying it if the reference</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * count thereby becomes 0.</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjHandle.html#a85ac74d4fa9650241e2480ff1308b1bd"> 319</a></span>  <a class="code" href="classCgu_1_1GobjHandle.html#a85ac74d4fa9650241e2480ff1308b1bd">~GobjHandle</a>() {unreference();}</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> };</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"></span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * @class GobjWeakHandle gobj_handle.h c++-gtk-utils/gobj_handle.h</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * @brief This is a handle for managing weak references to GObjects.</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * @sa GobjHandle</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * This class tracks a GObject, so that if that GObject no longer</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * exists then operator bool() or the valid() method will return</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> * false, but does not take a strong reference by incrementing the</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * reference count to the GObject and so take ownership of it. It has</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * two main use areas: first, in order to break reference cycles that</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * may otherwise arise if two classes would otherwise hold strong</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * references to each other. Secondly, to manage a pointer to a</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * GObject returned by a GTK+ getter function where ownership is not</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * passed (that is, where the user is not expected to call</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * g_object_unref() when finished with the return value). A typical</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * example of this is the GtkTreeSelection object returned by</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * gtk_tree_view_get_selection(). The GtkTreeSelection object is part</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * of the GtkTreeView's implemention and will become invalid as soon</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * as the GtkTreeView object is finalized.</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * As in the case of the GobjHandle class, although this class has</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * operator*() and operator->() dereferencing operators, and so has</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * normal smart pointer functionality, as it is intended for use with</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * the normal C GObject/pango/GTK+ interfaces, ordinary use would</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * involve passing the handle to a function taking a pointer by means</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * of the operatorT*() type conversion operator (which returns the</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> * underlying pointer), or by explicitly calling the get() method to</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * obtain the underlying pointer.</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * Typical usage is as follows:</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * @code</span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * GobjWeakHandle<GtkTreeSelection> s(gtk_tree_view_get_selection(tree_view));</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * gtk_tree_selection_set_mode(s, GTK_SELECTION_SINGLE);</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * [some code blocks later]</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * if (s) { // check that the GtkTreeSelection object still exists.</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> * GtkTreeIter iter;</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * GtkTreeModel* model = 0;</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * gtk_tree_selection_get_selected(s, &model, &iter);</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> * ...</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"> * else [report error];</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * @endcode</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"> * Or instead of an 'if' block, GobjWeakHandleError could be caught:</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"> * @code</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * using namespace Cgu;</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * GobjWeakHandle<GtkTreeSelection> s(gtk_tree_view_get_selection(tree_view));</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> * gtk_tree_selection_set_mode(s, GTK_SELECTION_SINGLE);</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"> 377</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * [some code blocks later]</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * GtkTreeIter iter;</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * GtkTreeModel* model = 0;</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> * try {</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * gtk_tree_selection_get_selected(s, &model, &iter);</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * ...</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * }</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> * catch (GobjWeakHandleError&) {[report error]}</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> * @b Thread-safe @b use</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * This class wraps</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * g_object_add_weak_pointer()/g_object_remove_weak_pointer(), and as</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> * those GObject functions have practical limitations concerning</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * thread-safe use, this class has the same practical limitations. As</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> * shown above, typical usage for a weak pointer 's' would be 'if (s)</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> * do_it(s)', but if the thread calling that sequence (thread A) were</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"> * not the thread controlling the lifetime of the referenced GObject</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> * (thread B), then thread B may have destroyed the GObject between</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> * thread A testing 's' and then calling the referenced object. The</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * same applies to the test leading to GobjWeakHandleError being</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * thrown.</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * In other words, in the GtkTreeSelection code example above, if the</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * thread calling gtk_tree_selection_get_selected() were not the main</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * GUI thread (which would anyway require the use of</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * gdk_threads_enter()/gdk_threads_leave()), then the calling thread</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * must ensure that the main GUI thread does not destroy the relevant</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * tree view, and so the GtkTreeSelection object, from the beginning</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * of the 'if' test to the end of the 'if' block, or for the duration</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> * of the try block. (This cannot be done just by incrementing the</span></div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> * reference count of the tree view or the tree selection in the</span></div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> * calling thread before the 'if' test or the try block is entered,</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> * because by the time the reference is incremented and the weak</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * pointer tested, the tree view and tree selection may already be in</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * their dispose functions but the tree selection's dispose function</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * may not yet have reached the point of dispatching the callback</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * NULLing the weak pointer. As a general design issue, it is usually</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * best only to call GTK+ functions in one thread, and in order to</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> * make that straightforward, this library contains a number of</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> * classes and functions for inter-thread communication.)</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> </div>
<div class="line"><a name="l00422"></a><span class="lineno"><a class="code" href="structCgu_1_1GobjWeakHandleError.html"> 422</a></span> <span class="keyword">struct </span><a class="code" href="structCgu_1_1GobjWeakHandleError.html">GobjWeakHandleError</a>: <span class="keyword">public</span> std::exception {</div>
<div class="line"><a name="l00423"></a><span class="lineno"><a class="code" href="structCgu_1_1GobjWeakHandleError.html#a8490ab5ae0cd61c3b6fb38b8225b8b2c"> 423</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structCgu_1_1GobjWeakHandleError.html#a8490ab5ae0cd61c3b6fb38b8225b8b2c">what</a>() <span class="keyword">const</span> throw() {<span class="keywordflow">return</span> <span class="stringliteral">"GobjWeakHandleError\n"</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> </div>
<div class="line"><a name="l00426"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html"> 426</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="classCgu_1_1GobjWeakHandle.html" title="This is a handle for managing weak references to GObjects. ">GobjWeakHandle</a> {</div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> </div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  T* obj_p;</div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> </div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"></span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * This constructor does not throw.</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * @param ptr The object which the GobjWeakHandle is to track (if any).</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"><a class="code" href="classCgu_1_1GobjWeakHandle.html#ae632149e0669e3987d68cef8cb0afa25"> 436</a></span>  <span class="keyword">explicit</span> <a class="code" href="classCgu_1_1GobjWeakHandle.html#ae632149e0669e3987d68cef8cb0afa25">GobjWeakHandle</a>(T* ptr = 0) noexcept {</div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  obj_p = ptr;</div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  <span class="keywordflow">if</span> (ptr) g_object_add_weak_pointer((GObject*)ptr,</div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  (<span class="keywordtype">void</span>**)&obj_p);</div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  }</div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"></span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> * Causes the handle to cease to track its tracked object (if any).</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> * If the argument passed is not NULL, the handle will track the new</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> * object passed. This method does not throw.</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> * @param ptr NULL (the default), or a new object to track.</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00448"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a710d142d3e2f25a25f9883f9a279d531"> 448</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GobjWeakHandle.html#a710d142d3e2f25a25f9883f9a279d531">reset</a>(T* ptr = 0) noexcept {</div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  </div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keywordflow">if</span> (obj_p) g_object_remove_weak_pointer((GObject*)obj_p,</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  (<span class="keywordtype">void</span>**)&obj_p);</div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  obj_p = ptr;</div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  <span class="keywordflow">if</span> (ptr) g_object_add_weak_pointer((GObject*)ptr,</div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  (<span class="keywordtype">void</span>**)&obj_p);</div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  }</div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"></span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> * The copy constructor does not throw. It constructs a new weak</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> * pointer tracking the same GObject as that tracked by the existing</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> * weak pointer.</span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> * @param gobj The handle to be copied.</span></div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00463"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#ad4e5c7224b293708097fbddd18390198"> 463</a></span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html#ad4e5c7224b293708097fbddd18390198">GobjWeakHandle</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjWeakHandle.html" title="This is a handle for managing weak references to GObjects. ">GobjWeakHandle</a>& gobj) noexcept {</div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  obj_p = gobj.obj_p;</div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  <span class="keywordflow">if</span> (obj_p) g_object_add_weak_pointer((GObject*)obj_p,</div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  (<span class="keywordtype">void</span>**)&obj_p);</div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</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"> 469</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> * This constructor constructs a weak pointer for a GObject managed</span></div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> * by a GobjHandle handle. It does not throw.</span></div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> * @param gobj The GobjHandle managing the GObject which the</span></div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"> * GobjWeakHandle is to track.</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"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a121643b6472003c5345608c70d918372"> 475</a></span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html#a121643b6472003c5345608c70d918372">GobjWeakHandle</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& gobj) noexcept {</div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  obj_p = gobj.get();</div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  <span class="keywordflow">if</span> (obj_p) g_object_add_weak_pointer((GObject*)obj_p,</div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  (<span class="keywordtype">void</span>**)&obj_p);</div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  }</div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"></span></div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> * This method does not throw. It causes the handle to cease to</span></div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> * track its tracked object (if any), and begin tracking the same</span></div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> * GObject as that tracked by the assignor. This method does not</span></div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> * throw.</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> * @param gobj The assignor.</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> * @return The GobjWeakHandle object after assignment.</span></div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00489"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#ac59bf139838f3c43a6d20006f134591e"> 489</a></span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html" title="This is a handle for managing weak references to GObjects. ">GobjWeakHandle</a>& <a class="code" href="classCgu_1_1GobjWeakHandle.html#ac59bf139838f3c43a6d20006f134591e">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjWeakHandle.html" title="This is a handle for managing weak references to GObjects. ">GobjWeakHandle</a>& gobj) noexcept {</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="comment">// self assignment takes care of itself</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html#a710d142d3e2f25a25f9883f9a279d531">reset</a>(gobj.obj_p);</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  }</div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"></span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> * This method does not throw. It causes the handle to cease to</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> * track its tracked object (if any), and begin tracking the GObject</span></div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> * managed by the GobjHandle argument. This method does not throw.</span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * @param gobj The assignor GobjHandle.</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * @return The GobjWeakHandle object after assignment.</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a8115232812af59deae9f1b3e6ef7bfc1"> 502</a></span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html" title="This is a handle for managing weak references to GObjects. ">GobjWeakHandle</a>& <a class="code" href="classCgu_1_1GobjWeakHandle.html#a8115232812af59deae9f1b3e6ef7bfc1">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& gobj) noexcept {</div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html#a710d142d3e2f25a25f9883f9a279d531">reset</a>(gobj.get());</div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</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"> /**</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> * @return True if the tracked GObject still exists, or false if it</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> * does not or no GObject is being tracked.</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> * @note The valid() method is a synonym for this method.</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"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a40b81e9485a31920c30f6141cd703320"> 513</a></span>  <span class="keyword">operator</span> bool() const noexcept {<span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> </div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="preprocessor">#ifndef DOXYGEN_PARSING</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="preprocessor"></span> <span class="comment">/*</span></div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> * DEPRECATED: Do not use this method as it is only retained for</span></div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> * source compatibility. Its semantics are the wrong way around:</span></div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> * expired() returns true if the GObject still exists, instead of</span></div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> * false. Use operator bool() or the valid() method instead, which</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> * have the correct semantics. This method does not throw.</span></div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  <span class="keywordtype">bool</span> expired() const noexcept {<span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> * @return True if the tracked GObject still exists, or false if it</span></div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> * does not or no GObject is being tracked.</span></div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> * @note operator bool() is a synonym for this method.</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> * Since 2.0.5</span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00534"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#accc28e4f5c9b9c05ed328e166b8096b3"> 534</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCgu_1_1GobjWeakHandle.html#accc28e4f5c9b9c05ed328e166b8096b3">valid</a>() const noexcept {<span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"></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"> 537</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> * @return A pointer to the tracked GObject.</span></div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> * @exception GobjWeakHandleError This method will throw</span></div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> * GobjWeakHandleError if the tracked object no longer exists or none</span></div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> * is being tracked. There is no need to check for this exception if</span></div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> * the status of the tracked object has been established with</span></div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> * operator bool() or valid().</span></div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00545"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#af2f7af5374905d3455c21b6604a2ebc2"> 545</a></span>  T* <span class="keyword">get</span>() <span class="keyword">const</span> {<span class="keywordflow">if</span> (!obj_p) <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1GobjWeakHandleError.html">GobjWeakHandleError</a>(); <span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"></span></div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> * @return A reference to the tracked GObject.</span></div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> * @exception GobjWeakHandleError This method will throw</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> * GobjWeakHandleError if the tracked object no longer exists or none</span></div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> * is being tracked. There is no need to check for this exception if</span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> * the status of the tracked object has been established with</span></div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> * operator bool() or valid().</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00556"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a3b771b8d830f6645ed7cf4de21645237"> 556</a></span>  T& <a class="code" href="classCgu_1_1GobjWeakHandle.html#a3b771b8d830f6645ed7cf4de21645237">operator*</a>()<span class="keyword"> const </span>{<span class="keywordflow">if</span> (!obj_p) <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1GobjWeakHandleError.html">GobjWeakHandleError</a>(); <span class="keywordflow">return</span> *obj_p;}</div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"></span></div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> * @return A pointer to the tracked GObject.</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> * @exception GobjWeakHandleError This method will throw</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> * GobjWeakHandleError if the tracked object no longer exists or none</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> * is being tracked. There is no need to check for this exception if</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> * the status of the tracked object has been established with</span></div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> * operator bool() or valid().</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00567"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a5d89f9287f8ec51d430664eedcfe1d84"> 567</a></span>  T* <a class="code" href="classCgu_1_1GobjWeakHandle.html#a5d89f9287f8ec51d430664eedcfe1d84">operator-></a>()<span class="keyword"> const </span>{<span class="keywordflow">if</span> (!obj_p) <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1GobjWeakHandleError.html">GobjWeakHandleError</a>(); <span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"></span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> * This method does not throw.</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> * @return A pointer to the tracked GObject.</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * @exception GobjWeakHandleError This method will throw</span></div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> * GobjWeakHandleError if the tracked object no longer exists or none</span></div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> * is being tracked. There is no need to check for this exception if</span></div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> * the status of the tracked object has been established with</span></div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> * operator bool() or valid().</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00578"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#adbb0fb409983c07cee2951d979efbdaf"> 578</a></span>  <span class="keyword">operator</span> T*() <span class="keyword">const</span> {<span class="keywordflow">if</span> (!obj_p) <span class="keywordflow">throw</span> <a class="code" href="structCgu_1_1GobjWeakHandleError.html">GobjWeakHandleError</a>(); <span class="keywordflow">return</span> obj_p;}</div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"></span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> * The destructor does not throw.</span></div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00583"></a><span class="lineno"><a class="code" href="classCgu_1_1GobjWeakHandle.html#a8029d4ca55421db20872ec1753fa3d58"> 583</a></span>  <a class="code" href="classCgu_1_1GobjWeakHandle.html#a8029d4ca55421db20872ec1753fa3d58">~GobjWeakHandle</a>() {<span class="keywordflow">if</span> (obj_p) g_object_remove_weak_pointer((GObject*)obj_p,</div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  (<span class="keywordtype">void</span>**)&obj_p);}</div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> };</div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> </div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="preprocessor">#if defined(CGU_USE_SMART_PTR_COMPARISON) || defined(DOXYGEN_PARSING)</span></div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment">// we can use built-in operator == when comparing pointers referencing</span></div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment">// different objects of the same type</span><span class="comment"></span></div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> * This comparison operator does not throw. It compares the addresses</span></div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> * of the managed objects.</span></div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
<div class="line"><a name="l00600"></a><span class="lineno"><a class="code" href="group__handles.html#gae31f500ae48d467e4f19a85238317aeb"> 600</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_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& h1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& h2) noexcept {</div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  <span class="keywordflow">return</span> (h1.get() == h2.get());</div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> }</div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"></span></div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> * This comparison operator does not throw. It compares the addresses</span></div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> * of the managed objects.</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"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
<div class="line"><a name="l00613"></a><span class="lineno"><a class="code" href="group__handles.html#ga1a3dd375618ebb42260ee6c4c2478bd4"> 613</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_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& h1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& h2) noexcept {</div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  <span class="keywordflow">return</span> !(h1 == h2);</div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> }</div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> </div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment">// we must use std::less rather than the < built-in operator for</span></div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment">// pointers to objects not within the same array or object: "For</span></div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment">// templates greater, less, greater_equal, and less_equal, the</span></div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment">// specializations for any pointer type yield a total order, even if</span></div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</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="l00622"></a><span class="lineno"> 622</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> * @ingroup handles</span></div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> * This comparison operator does not throw unless std::less applied to</span></div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> * pointer types throws (which it would not do with any sane</span></div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> * implementation). It compares the addresses of the managed objects.</span></div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> * Since 2.0.0-rc2</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
<div class="line"><a name="l00632"></a><span class="lineno"><a class="code" href="group__handles.html#gae28b173eb28864721ad19cf0b511aa1a"> 632</a></span> <span class="keywordtype">bool</span> operator<(const GobjHandle<T>& h1, <span class="keyword">const</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">GobjHandle<T></a>& h2) {</div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span>  <span class="keywordflow">return</span> std::less<T*>()(h1.get(), h2.get());</div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> }</div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> </div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="preprocessor">#endif // CGU_USE_SMART_PTR_COMPARISON</span></div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> } <span class="comment">// namespace Cgu</span></div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> </div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment">// doxygen produces long filenames that tar can't handle:</span></div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment">// we have generic documentation for std::hash specialisations</span></div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment">// in doxygen.main.in</span></div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="preprocessor">#if defined(CGU_USE_SMART_PTR_COMPARISON) && !defined(DOXYGEN_PARSING)</span></div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="preprocessor"></span><span class="comment">/* This struct allows GobjHandle objects to be keys in unordered</span></div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> associative containers */</span></div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="keyword">namespace </span>std {</div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="keyword">struct </span>hash<Cgu::GobjHandle<T>> {</div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span>  <span class="keyword">typedef</span> std::size_t result_type;</div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span>  <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1GobjHandle.html" title="This is a handle for managing the reference count of GObjects. ">Cgu::GobjHandle<T></a> argument_type;</div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span>  result_type operator()(<span class="keyword">const</span> argument_type& h)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span>  <span class="comment">// this is fine: std::hash structs do not normally contain data and</span></div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>  <span class="comment">// std::hash<T*> certainly won't, so we don't have overhead constructing</span></div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>  <span class="comment">// std::hash<T*> on the fly</span></div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</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>()(h.get());</div>
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span>  }</div>
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> };</div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> } <span class="comment">// namespace std</span></div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="preprocessor">#endif // CGU_USE_SMART_PTR_COMPARISON</span></div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</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>
