doc/www/doxygen/html/vsmartptr_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: vsmartptr.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>vsmartptr.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       vsmartptr</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Variable 'free' smart pointer</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2006-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_VSMARTPTR_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_VSMARTPTR_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <a name="l00025"></a>00025 <span class="keyword">namespace </span>Barry {
  48 <a name="l00026"></a>00026
  49 <a name="l00027"></a>00027 <span class="comment">//</span>
  50 <a name="l00028"></a>00028 <span class="comment">// vSmartPtr</span>
  51 <a name="l00029"></a>00029 <span class="comment">//</span><span class="comment"></span>
  52 <a name="l00030"></a>00030 <span class="comment">/// A special smart pointer for variables that have their own</span>
  53 <a name="l00031"></a>00031 <span class="comment">/// special 'free' functions.  Behaves like std::auto_ptr&lt;&gt;</span>
  54 <a name="l00032"></a>00032 <span class="comment">/// in that only one object at a time owns the pointer,</span>
  55 <a name="l00033"></a>00033 <span class="comment">/// and destruction frees it by calling the given FreeFunc.</span>
  56 <a name="l00034"></a>00034 <span class="comment">///</span>
  57 <a name="l00035"></a>00035 <span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> FT, <span class="keywordtype">void</span> (*FreeFunc)(FT *pt)&gt;
  58 <a name="l00036"></a><a class="code" href="classBarry_1_1vSmartPtr.html">00036</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>
  59 <a name="l00037"></a>00037 {
  60 <a name="l00038"></a>00038         <span class="keyword">mutable</span> T *m_pt;
  61 <a name="l00039"></a>00039
  62 <a name="l00040"></a>00040 <span class="keyword">public</span>:
  63 <a name="l00041"></a>00041         <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>() : m_pt(0) {}
  64 <a name="l00042"></a>00042         <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>(T *pt) : m_pt(pt) {}
  65 <a name="l00043"></a>00043         <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a> &amp;sp) : m_pt(sp.<a class="code" href="classBarry_1_1vSmartPtr.html#913b0bcbdf44da291a1b2e11e5dabc7a">m_pt</a>)
  66 <a name="l00044"></a>00044         {
  67 <a name="l00045"></a>00045                 sp.<a class="code" href="classBarry_1_1vSmartPtr.html#913b0bcbdf44da291a1b2e11e5dabc7a">m_pt</a> = 0;
  68 <a name="l00046"></a>00046         }
  69 <a name="l00047"></a>00047         ~<a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>()
  70 <a name="l00048"></a>00048         {
  71 <a name="l00049"></a>00049                 reset();
  72 <a name="l00050"></a>00050         }
  73 <a name="l00051"></a>00051
  74 <a name="l00052"></a>00052         <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>&amp; operator=(T *pt)
  75 <a name="l00053"></a>00053         {
  76 <a name="l00054"></a>00054                 reset(pt);
  77 <a name="l00055"></a>00055                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
  78 <a name="l00056"></a>00056         }
  79 <a name="l00057"></a>00057
  80 <a name="l00058"></a>00058         <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vSmartPtr</a> &amp;sp)
  81 <a name="l00059"></a>00059         {
  82 <a name="l00060"></a>00060                 reset(sp.<a class="code" href="classBarry_1_1vSmartPtr.html#f25cd1abf6d9a59df30c59326bc58aac">release</a>());
  83 <a name="l00061"></a>00061                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
  84 <a name="l00062"></a>00062         }
  85 <a name="l00063"></a>00063
  86 <a name="l00064"></a>00064         <span class="comment">// Some non-standard APIs used by Barry</span>
  87 <a name="l00065"></a>00065         T* Extract()
  88 <a name="l00066"></a>00066         {
  89 <a name="l00067"></a>00067                 <span class="keywordflow">return</span> this-&gt;release();
  90 <a name="l00068"></a>00068         }
  91 <a name="l00069"></a>00069
  92 <a name="l00070"></a>00070         T* Get()
  93 <a name="l00071"></a>00071         {
  94 <a name="l00072"></a>00072                 <span class="keywordflow">return</span> this-&gt;<span class="keyword">get</span>();
  95 <a name="l00073"></a>00073         }
  96 <a name="l00074"></a>00074
  97 <a name="l00075"></a>00075         <span class="comment">// std::auto_ptr&lt;&gt; style API</span>
  98 <a name="l00076"></a>00076         T* <span class="keyword">get</span>()
  99 <a name="l00077"></a>00077         {
 100 <a name="l00078"></a>00078                 <span class="keywordflow">return</span> m_pt;
 101 <a name="l00079"></a>00079         }
 102 <a name="l00080"></a>00080
 103 <a name="l00081"></a>00081         T* release()
 104 <a name="l00082"></a>00082         {
 105 <a name="l00083"></a>00083                 T *rp = m_pt;
 106 <a name="l00084"></a>00084                 m_pt = 0;
 107 <a name="l00085"></a>00085                 <span class="keywordflow">return</span> rp;
 108 <a name="l00086"></a>00086         }
 109 <a name="l00087"></a>00087
 110 <a name="l00088"></a>00088         <span class="keywordtype">void</span> reset(T *new_obj = 0)
 111 <a name="l00089"></a>00089         {
 112 <a name="l00090"></a>00090                 <span class="keywordflow">if</span>( m_pt )
 113 <a name="l00091"></a>00091                         FreeFunc(m_pt);
 114 <a name="l00092"></a>00092                 m_pt = new_obj;
 115 <a name="l00093"></a>00093         }
 116 <a name="l00094"></a>00094 };
 117 <a name="l00095"></a>00095
 118 <a name="l00096"></a>00096 <span class="comment">//</span>
 119 <a name="l00097"></a>00097 <span class="comment">// vLateSmartPtr</span>
 120 <a name="l00098"></a>00098 <span class="comment">//</span><span class="comment"></span>
 121 <a name="l00099"></a>00099 <span class="comment">/// Variation of the above smart pointer that allows the user to</span>
 122 <a name="l00100"></a>00100 <span class="comment">/// assign a free function after construction, in the case of</span>
 123 <a name="l00101"></a>00101 <span class="comment">/// dlopen()'d frees.</span>
 124 <a name="l00102"></a>00102 <span class="comment">///</span>
 125 <a name="l00103"></a>00103 <span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> FreeFuncPtrT&gt;
 126 <a name="l00104"></a><a class="code" href="classBarry_1_1vLateSmartPtr.html">00104</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>
 127 <a name="l00105"></a>00105 {
 128 <a name="l00106"></a>00106         <span class="keyword">mutable</span> T *m_pt;
 129 <a name="l00107"></a>00107         FreeFuncPtrT m_FreeFuncPtr;
 130 <a name="l00108"></a>00108
 131 <a name="l00109"></a>00109 <span class="keyword">public</span>:
 132 <a name="l00110"></a>00110         <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>(FreeFuncPtrT freefunc = 0)
 133 <a name="l00111"></a>00111                 : m_pt(0)
 134 <a name="l00112"></a>00112                 , m_FreeFuncPtr(freefunc)
 135 <a name="l00113"></a>00113         {
 136 <a name="l00114"></a>00114         }
 137 <a name="l00115"></a>00115
 138 <a name="l00116"></a>00116         <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>(T *pt, FreeFuncPtrT freefunc = 0)
 139 <a name="l00117"></a>00117                 : m_pt(pt)
 140 <a name="l00118"></a>00118                 , m_FreeFuncPtr(freefunc)
 141 <a name="l00119"></a>00119         {
 142 <a name="l00120"></a>00120         }
 143 <a name="l00121"></a>00121
 144 <a name="l00122"></a>00122         <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a> &amp;sp)
 145 <a name="l00123"></a>00123                 : m_pt(sp.<a class="code" href="classBarry_1_1vLateSmartPtr.html#15f237967aac83a3fb3b8bfa9e64cb48">m_pt</a>)
 146 <a name="l00124"></a>00124                 , m_FreeFuncPtr(sp.<a class="code" href="classBarry_1_1vLateSmartPtr.html#8f9a82034c76eb06b6bb76e564e9061b">m_FreeFuncPtr</a>)
 147 <a name="l00125"></a>00125         {
 148 <a name="l00126"></a>00126                 sp.<a class="code" href="classBarry_1_1vLateSmartPtr.html#15f237967aac83a3fb3b8bfa9e64cb48">m_pt</a> = 0;
 149 <a name="l00127"></a>00127         }
 150 <a name="l00128"></a>00128
 151 <a name="l00129"></a>00129         ~<a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>()
 152 <a name="l00130"></a>00130         {
 153 <a name="l00131"></a>00131                 reset();
 154 <a name="l00132"></a>00132         }
 155 <a name="l00133"></a>00133
 156 <a name="l00134"></a>00134         <span class="keywordtype">void</span> SetFreeFunc(FreeFuncPtrT freefunc)
 157 <a name="l00135"></a>00135         {
 158 <a name="l00136"></a>00136                 m_FreeFuncPtr = freefunc;
 159 <a name="l00137"></a>00137         }
 160 <a name="l00138"></a>00138
 161 <a name="l00139"></a>00139         <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>&amp; operator=(T *pt)
 162 <a name="l00140"></a>00140         {
 163 <a name="l00141"></a>00141                 reset(pt);
 164 <a name="l00142"></a>00142                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
 165 <a name="l00143"></a>00143         }
 166 <a name="l00144"></a>00144
 167 <a name="l00145"></a>00145         <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classBarry_1_1vLateSmartPtr.html" title="Variation of the above smart pointer that allows the user to assign a free function...">vLateSmartPtr</a> &amp;sp)
 168 <a name="l00146"></a>00146         {
 169 <a name="l00147"></a>00147                 reset(sp.<a class="code" href="classBarry_1_1vLateSmartPtr.html#90ff1b547b520eb46d083fa24ac56bb1">release</a>());
 170 <a name="l00148"></a>00148                 m_FreeFuncPtr = sp.<a class="code" href="classBarry_1_1vLateSmartPtr.html#8f9a82034c76eb06b6bb76e564e9061b">m_FreeFuncPtr</a>;
 171 <a name="l00149"></a>00149                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
 172 <a name="l00150"></a>00150         }
 173 <a name="l00151"></a>00151
 174 <a name="l00152"></a>00152         <span class="comment">// Some non-standard APIs used by Barry</span>
 175 <a name="l00153"></a>00153         T* Extract()
 176 <a name="l00154"></a>00154         {
 177 <a name="l00155"></a>00155                 <span class="keywordflow">return</span> this-&gt;release();
 178 <a name="l00156"></a>00156         }
 179 <a name="l00157"></a>00157
 180 <a name="l00158"></a>00158         T* Get()
 181 <a name="l00159"></a>00159         {
 182 <a name="l00160"></a>00160                 <span class="keywordflow">return</span> this-&gt;<span class="keyword">get</span>();
 183 <a name="l00161"></a>00161         }
 184 <a name="l00162"></a>00162
 185 <a name="l00163"></a>00163         <span class="comment">// std::auto_ptr&lt;&gt; style API</span>
 186 <a name="l00164"></a>00164         T* <span class="keyword">get</span>()
 187 <a name="l00165"></a>00165         {
 188 <a name="l00166"></a>00166                 <span class="keywordflow">return</span> m_pt;
 189 <a name="l00167"></a>00167         }
 190 <a name="l00168"></a>00168
 191 <a name="l00169"></a>00169         T* release()
 192 <a name="l00170"></a>00170         {
 193 <a name="l00171"></a>00171                 T *rp = m_pt;
 194 <a name="l00172"></a>00172                 m_pt = 0;
 195 <a name="l00173"></a>00173                 <span class="keywordflow">return</span> rp;
 196 <a name="l00174"></a>00174         }
 197 <a name="l00175"></a>00175
 198 <a name="l00176"></a>00176         <span class="keywordtype">void</span> reset(T *new_obj = 0)
 199 <a name="l00177"></a>00177         {
 200 <a name="l00178"></a>00178                 <span class="comment">// don't check for null m_FreeFuncPtr, since</span>
 201 <a name="l00179"></a>00179                 <span class="comment">// that should be an obvious crash and requires fixing</span>
 202 <a name="l00180"></a>00180                 <span class="keywordflow">if</span>( m_pt )
 203 <a name="l00181"></a>00181                         (*m_FreeFuncPtr)(m_pt);
 204 <a name="l00182"></a>00182                 m_pt = new_obj;
 205 <a name="l00183"></a>00183         }
 206 <a name="l00184"></a>00184 };
 207 <a name="l00185"></a>00185
 208 <a name="l00186"></a>00186 <span class="comment">/*</span>
 209 <a name="l00187"></a>00187 <span class="comment"></span>
 210 <a name="l00188"></a>00188 <span class="comment">Example usage:</span>
 211 <a name="l00189"></a>00189 <span class="comment"></span>
 212 <a name="l00190"></a>00190 <span class="comment">typedef vSmartPtr&lt;b_VFormatAttribute, b_VFormatAttribute, &amp;b_vformat_attribute_free&gt; vAttrPtr;</span>
 213 <a name="l00191"></a>00191 <span class="comment">typedef vSmartPtr&lt;b_VFormatParam, b_VFormatParam, &amp;b_vformat_attribute_param_free&gt; vParamPtr;</span>
 214 <a name="l00192"></a>00192 <span class="comment">typedef vSmartPtr&lt;char, void, &amp;g_free&gt; gStringPtr;</span>
 215 <a name="l00193"></a>00193 <span class="comment"></span>
 216 <a name="l00194"></a>00194 <span class="comment">*/</span>
 217 <a name="l00195"></a>00195
 218 <a name="l00196"></a>00196 } <span class="comment">// namespace Barry</span>
 219 <a name="l00197"></a>00197
 220 <a name="l00198"></a>00198 <span class="preprocessor">#endif</span>
 221 <a name="l00199"></a>00199 <span class="preprocessor"></span>
 222 </pre></div></div>
 223 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:59 2011 for Barry by&nbsp;
 224 <a href="http://www.doxygen.org/index.html">
 225 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 226 </body>
 227 </html>