<!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: gerror_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">gerror_handle.h</div> </div> </div><!--header--> <div class="contents"> <a href="gerror__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) 2007 and 2009 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">*/</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CGU_GERROR_HANDLE_H</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define CGU_GERROR_HANDLE_H</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <glib.h></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="shared__handle_8h.html">c++-gtk-utils/shared_handle.h</a>></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</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="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/**</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @addtogroup handles handles and smart pointers</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>Cgu {</div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/**</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @class GerrorFree gerror_handle.h c++-gtk-utils/gerror_handle.h</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @brief A deleter functor for use as the second (Dealloc) template</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * parameter of the SharedHandle, SharedLockHandle or ScopedHandle</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * template classes, which calls glib's g_error_free().</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @ingroup handles</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @details This functor enables those classes to manage GError</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * objects in memory which require to be freed with g_error_free().</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * It is used in the typedefs @ref GerrorSharedHandleAnchor</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * "GerrorSharedHandle" and @ref GerrorScopedHandleAnchor</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * "GcharScopedHandle".</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"><a class="code" href="classCgu_1_1GerrorFree.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="classCgu_1_1GerrorFree.html" title="A deleter functor for use as the second (Dealloc) template parameter of the SharedHandle, SharedLockHandle or ScopedHandle template classes, which calls glib's g_error_free(). ">GerrorFree</a> {</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="classCgu_1_1GerrorFree.html#ad29ee3719dd202511d1d067972a40247"> 52</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCgu_1_1GerrorFree.html#ad29ee3719dd202511d1d067972a40247">operator()</a>(<span class="keyword">const</span> GError* obj_p) noexcept {</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">if</span> (obj_p) {</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  g_error_free(const_cast<GError*>(obj_p));</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/**</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @typedef GerrorScopedHandle.</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @brief A handle comprising a typed instance of the ScopedHandle class for managing GError objects.</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @anchor GerrorScopedHandleAnchor</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @ingroup handles</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * \#include <c++-gtk-utils/gerror_handle.h></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"><a class="code" href="group__handles.html#ga25675b7aee8fab0891dbf9c62edbd504"> 67</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1ScopedHandle.html" title="This is a generic scoped class for managing the lifetime of objects allocated on freestore. ">ScopedHandle<GError*, GerrorFree></a> <a class="code" href="group__handles.html#ga25675b7aee8fab0891dbf9c62edbd504" title="A handle comprising a typed instance of the ScopedHandle class for managing GError objects...">GerrorScopedHandle</a>;</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/**</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @typedef GerrorSharedHandle.</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @brief A handle comprising a typed instance of the SharedHandle class for managing GError objects.</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @anchor GerrorSharedHandleAnchor</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @ingroup handles</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * \#include <c++-gtk-utils/gerror_handle.h></span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> */</span></div> <div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="group__handles.html#ga9bf816def623f25f6918dc5f196aad9c"> 76</a></span> <span class="keyword">typedef</span> <a class="code" href="classCgu_1_1SharedHandle.html" title="This is a generic class for managing the lifetime of objects allocated on freestore. ">SharedHandle<GError*, GerrorFree></a> <a class="code" href="group__handles.html#ga9bf816def623f25f6918dc5f196aad9c" title="A handle comprising a typed instance of the SharedHandle class for managing GError objects...">GerrorSharedHandle</a>;</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace Cgu</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</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>