<!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"/>
<title>Barry: vsmartptr.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>vsmartptr.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file vsmartptr</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Variable 'free' smart pointer</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2006-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_VSMARTPTR_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_VSMARTPTR_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="keyword">namespace </span>Barry {
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="comment">//</span>
<a name="l00028"></a>00028 <span class="comment">// vSmartPtr</span>
<a name="l00029"></a>00029 <span class="comment">//</span><span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/// A special smart pointer for variables that have their own</span>
<a name="l00031"></a>00031 <span class="comment">/// special 'free' functions. Behaves like std::auto_ptr<></span>
<a name="l00032"></a>00032 <span class="comment">/// in that only one object at a time owns the pointer,</span>
<a name="l00033"></a>00033 <span class="comment">/// and destruction frees it by calling the given FreeFunc.</span>
<a name="l00034"></a>00034 <span class="comment">///</span>
<a name="l00035"></a>00035 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> FT, <span class="keywordtype">void</span> (*FreeFunc)(FT *pt)>
<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 &#39;free&#39;...">vSmartPtr</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">mutable</span> T *m_pt;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<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 &#39;free&#39;...">vSmartPtr</a>() : m_pt(0) {}
<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 &#39;free&#39;...">vSmartPtr</a>(T *pt) : m_pt(pt) {}
<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 &#39;free&#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 &#39;free&#39;...">vSmartPtr</a> &sp) : m_pt(sp.m_pt)
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 sp.m_pt = 0;
<a name="l00046"></a>00046 }
<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 &#39;free&#39;...">vSmartPtr</a>()
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 reset();
<a name="l00050"></a>00050 }
<a name="l00051"></a>00051
<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 &#39;free&#39;...">vSmartPtr</a>& operator=(T *pt)
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 reset(pt);
<a name="l00055"></a>00055 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057
<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 &#39;free&#39;...">vSmartPtr</a>& 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 &#39;free&#39;...">vSmartPtr</a> &sp)
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 reset(sp.release());
<a name="l00061"></a>00061 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">// Some non-standard APIs used by Barry</span>
<a name="l00065"></a>00065 T* Extract()
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067 <span class="keywordflow">return</span> this->release();
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069
<a name="l00070"></a>00070 T* Get()
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 <span class="keywordflow">return</span> this-><span class="keyword">get</span>();
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// std::auto_ptr<> style API</span>
<a name="l00076"></a>00076 T* <span class="keyword">get</span>()
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="keywordflow">return</span> m_pt;
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080
<a name="l00081"></a>00081 T* release()
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 T *rp = m_pt;
<a name="l00084"></a>00084 m_pt = 0;
<a name="l00085"></a>00085 <span class="keywordflow">return</span> rp;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">void</span> reset(T *new_obj = 0)
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090 <span class="keywordflow">if</span>( m_pt )
<a name="l00091"></a>00091 FreeFunc(m_pt);
<a name="l00092"></a>00092 m_pt = new_obj;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">//</span>
<a name="l00097"></a>00097 <span class="comment">// vLateSmartPtr</span>
<a name="l00098"></a>00098 <span class="comment">//</span><span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">/// Variation of the above smart pointer that allows the user to</span>
<a name="l00100"></a>00100 <span class="comment">/// assign a free function after construction, in the case of</span>
<a name="l00101"></a>00101 <span class="comment">/// dlopen()'d frees.</span>
<a name="l00102"></a>00102 <span class="comment">///</span>
<a name="l00103"></a>00103 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> FreeFuncPtrT>
<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>
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 <span class="keyword">mutable</span> T *m_pt;
<a name="l00107"></a>00107 FreeFuncPtrT m_FreeFuncPtr;
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">public</span>:
<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)
<a name="l00111"></a>00111 : m_pt(0)
<a name="l00112"></a>00112 , m_FreeFuncPtr(freefunc)
<a name="l00113"></a>00113 {
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115
<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)
<a name="l00117"></a>00117 : m_pt(pt)
<a name="l00118"></a>00118 , m_FreeFuncPtr(freefunc)
<a name="l00119"></a>00119 {
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<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> &sp)
<a name="l00123"></a>00123 : m_pt(sp.m_pt)
<a name="l00124"></a>00124 , m_FreeFuncPtr(sp.m_FreeFuncPtr)
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126 sp.m_pt = 0;
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128
<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>()
<a name="l00130"></a>00130 {
<a name="l00131"></a>00131 reset();
<a name="l00132"></a>00132 }
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keywordtype">void</span> SetFreeFunc(FreeFuncPtrT freefunc)
<a name="l00135"></a>00135 {
<a name="l00136"></a>00136 m_FreeFuncPtr = freefunc;
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<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>& operator=(T *pt)
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141 reset(pt);
<a name="l00142"></a>00142 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<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>& 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> &sp)
<a name="l00146"></a>00146 {
<a name="l00147"></a>00147 reset(sp.release());
<a name="l00148"></a>00148 m_FreeFuncPtr = sp.m_FreeFuncPtr;
<a name="l00149"></a>00149 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00150"></a>00150 }
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="comment">// Some non-standard APIs used by Barry</span>
<a name="l00153"></a>00153 T* Extract()
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155 <span class="keywordflow">return</span> this->release();
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157
<a name="l00158"></a>00158 T* Get()
<a name="l00159"></a>00159 {
<a name="l00160"></a>00160 <span class="keywordflow">return</span> this-><span class="keyword">get</span>();
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// std::auto_ptr<> style API</span>
<a name="l00164"></a>00164 T* <span class="keyword">get</span>()
<a name="l00165"></a>00165 {
<a name="l00166"></a>00166 <span class="keywordflow">return</span> m_pt;
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168
<a name="l00169"></a>00169 T* release()
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171 T *rp = m_pt;
<a name="l00172"></a>00172 m_pt = 0;
<a name="l00173"></a>00173 <span class="keywordflow">return</span> rp;
<a name="l00174"></a>00174 }
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="keywordtype">void</span> reset(T *new_obj = 0)
<a name="l00177"></a>00177 {
<a name="l00178"></a>00178 <span class="comment">// don't check for null m_FreeFuncPtr, since</span>
<a name="l00179"></a>00179 <span class="comment">// that should be an obvious crash and requires fixing</span>
<a name="l00180"></a>00180 <span class="keywordflow">if</span>( m_pt )
<a name="l00181"></a>00181 (*m_FreeFuncPtr)(m_pt);
<a name="l00182"></a>00182 m_pt = new_obj;
<a name="l00183"></a>00183 }
<a name="l00184"></a>00184 };
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="comment">/*</span>
<a name="l00187"></a>00187 <span class="comment"></span>
<a name="l00188"></a>00188 <span class="comment">Example usage:</span>
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment">typedef vSmartPtr<b_VFormatAttribute, b_VFormatAttribute, &b_vformat_attribute_free> vAttrPtr;</span>
<a name="l00191"></a>00191 <span class="comment">typedef vSmartPtr<b_VFormatParam, b_VFormatParam, &b_vformat_attribute_param_free> vParamPtr;</span>
<a name="l00192"></a>00192 <span class="comment">typedef vSmartPtr<char, void, &g_free> gStringPtr;</span>
<a name="l00193"></a>00193 <span class="comment"></span>
<a name="l00194"></a>00194 <span class="comment">*/</span>
<a name="l00195"></a>00195
<a name="l00196"></a>00196 } <span class="comment">// namespace Barry</span>
<a name="l00197"></a>00197
<a name="l00198"></a>00198 <span class="preprocessor">#endif</span>
<a name="l00199"></a>00199 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
