<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csutil/cowwrapper.h Source File (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <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="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csutil/cowwrapper.h</h1><a href="cowwrapper_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2006 by Frank Richter</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span> <a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00017"></a>00017 <span class="comment">*/</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_CSUTIL_COWWRAPPER_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_COWWRAPPER_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="custom__new__disable_8h.html" title="Include file to disable CrystalSpace&#39;s &#39;operator new&#39; override, which...">csutil/custom_new_disable.h</a>"</span> <a name="l00023"></a>00023 <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="allocator_8h.html" title="Basic allocator classes.">csutil/allocator.h</a>"</span> <a name="l00025"></a>00025 <a name="l00030"></a>00030 <span class="keyword">namespace </span>CS <a name="l00031"></a>00031 { <a name="l00032"></a>00032 <a name="l00061"></a>00061 <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">class</span> MemoryAllocator = Memory::AllocatorMalloc> <a name="l00062"></a><a class="code" href="classCS_1_1CowWrapper.html">00062</a> <span class="keyword">class </span><a class="code" href="classCS_1_1CowWrapper.html" title="Copy-on-write wrapper for arbitrary types.">CowWrapper</a> <a name="l00063"></a>00063 { <a name="l00065"></a>00065 <span class="keyword">struct </span>WrappedData <a name="l00066"></a>00066 { <a name="l00067"></a>00067 <span class="keywordtype">int</span> refcount; <a name="l00068"></a>00068 <a name="l00069"></a>00069 <span class="keywordtype">void</span> IncRef () { refcount++; } <a name="l00070"></a>00070 <span class="keywordtype">void</span> DecRef () <a name="l00071"></a>00071 { <a name="l00072"></a>00072 refcount--; <a name="l00073"></a>00073 <span class="keywordflow">if</span> (refcount == 0) <a name="l00074"></a>00074 { <a name="l00075"></a>00075 this->~WrappedData(); <a name="l00076"></a>00076 MemoryAllocator::Free (<span class="keyword">this</span>); <a name="l00077"></a>00077 } <a name="l00078"></a>00078 } <a name="l00079"></a>00079 <span class="keywordtype">int</span> GetRefCount ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> refcount; } <a name="l00080"></a>00080 <a name="l00081"></a>00081 T data; <a name="l00082"></a>00082 <span class="keyword">public</span>: <a name="l00083"></a>00083 WrappedData (<span class="keyword">const</span> T& other) : refcount (1), data (other) {} <a name="l00084"></a>00084 WrappedData (<span class="keyword">const</span> WrappedData& other) : refcount (1), data (other.data) {} <a name="l00085"></a>00085 }; <a name="l00086"></a>00086 <span class="keyword">public</span>: <a name="l00087"></a><a class="code" href="classCS_1_1CowWrapper.html#d67ec763181398cbbba500f71b04fbe0">00087</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classCS_1_1CowWrapper.html#d67ec763181398cbbba500f71b04fbe0">allocSize</a> = <span class="keyword">sizeof</span> (WrappedData); <a name="l00088"></a>00088 <span class="keyword">private</span>: <a name="l00089"></a>00089 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<WrappedData></a> data; <a name="l00090"></a>00090 <span class="keyword">inline</span> WrappedData* NewData (<span class="keyword">const</span> T& other) <a name="l00091"></a>00091 { <a name="l00092"></a>00092 WrappedData* p = (WrappedData*)MemoryAllocator::Alloc (<a class="code" href="classCS_1_1CowWrapper.html#d67ec763181398cbbba500f71b04fbe0">allocSize</a>); <a name="l00093"></a>00093 <span class="keyword">new</span> (p) WrappedData (other); <a name="l00094"></a>00094 <span class="keywordflow">return</span> p; <a name="l00095"></a>00095 } <a name="l00096"></a>00096 <span class="keyword">public</span>: <a name="l00098"></a><a class="code" href="classCS_1_1CowWrapper.html#9bed6919141dbe1aac3708367e8641d9">00098</a> <a class="code" href="classCS_1_1CowWrapper.html#9bed6919141dbe1aac3708367e8641d9" title="Copy reference to data from other.">CowWrapper</a> (<span class="keyword">const</span> <a class="code" href="classCS_1_1CowWrapper.html" title="Copy-on-write wrapper for arbitrary types.">CowWrapper</a>& other) : data (other.data) {} <a name="l00100"></a><a class="code" href="classCS_1_1CowWrapper.html#041c1152ca5b28f7808b5041f319ec9c">00100</a> <a class="code" href="classCS_1_1CowWrapper.html#9bed6919141dbe1aac3708367e8641d9" title="Copy reference to data from other.">CowWrapper</a> (<span class="keyword">const</span> T& other) <a name="l00101"></a>00101 { <a name="l00102"></a>00102 data.AttachNew (NewData (other)); <a name="l00103"></a>00103 } <a name="l00104"></a>00104 <a name="l00106"></a><a class="code" href="classCS_1_1CowWrapper.html#803d8ead4e91477282bcc9e6ec4c794d">00106</a> <span class="keyword">const</span> T& <a class="code" href="classCS_1_1CowWrapper.html#803d8ead4e91477282bcc9e6ec4c794d" title="Return a const reference to the contained data.">operator* </a>()<span class="keyword"> const</span> <a name="l00107"></a>00107 <span class="keyword"> </span>{ <a name="l00108"></a>00108 <span class="keywordflow">return</span> data->data; <a name="l00109"></a>00109 } <a name="l00115"></a><a class="code" href="classCS_1_1CowWrapper.html#649b992bc45e17dbe3a76223c061d9bc">00115</a> T& <a class="code" href="classCS_1_1CowWrapper.html#803d8ead4e91477282bcc9e6ec4c794d" title="Return a const reference to the contained data.">operator* </a>() <a name="l00116"></a>00116 { <a name="l00117"></a>00117 <span class="keywordflow">if</span> (data->GetRefCount() > 1) <a name="l00118"></a>00118 { <a name="l00119"></a>00119 WrappedData* newData = NewData (data->data); <a name="l00120"></a>00120 data.AttachNew (newData); <a name="l00121"></a>00121 } <a name="l00122"></a>00122 <span class="keywordflow">return</span> data->data; <a name="l00123"></a>00123 } <a name="l00125"></a><a class="code" href="classCS_1_1CowWrapper.html#5a11d334c8fc1946bc530e8ad8ff3959">00125</a> <span class="keyword">const</span> T* <a class="code" href="classCS_1_1CowWrapper.html#5a11d334c8fc1946bc530e8ad8ff3959" title="Return a const pointer to the contained data.">operator -> </a>()<span class="keyword"> const</span> <a name="l00126"></a>00126 <span class="keyword"> </span>{ <span class="keywordflow">return</span> &(<a class="code" href="classCS_1_1CowWrapper.html#803d8ead4e91477282bcc9e6ec4c794d" title="Return a const reference to the contained data.">operator*</a>()); } <a name="l00132"></a><a class="code" href="classCS_1_1CowWrapper.html#071b643a9ec30d989db6fcb68e3a4acf">00132</a> T* <a class="code" href="classCS_1_1CowWrapper.html#5a11d334c8fc1946bc530e8ad8ff3959" title="Return a const pointer to the contained data.">operator -> </a>() <a name="l00133"></a>00133 { <span class="keywordflow">return</span> &(<a class="code" href="classCS_1_1CowWrapper.html#803d8ead4e91477282bcc9e6ec4c794d" title="Return a const reference to the contained data.">operator*</a>()); } <a name="l00134"></a>00134 }; <a name="l00135"></a>00135 <a name="l00136"></a>00136 } <span class="comment">// namespace CS</span> <a name="l00137"></a>00137 <a name="l00138"></a>00138 <span class="preprocessor">#include "<a class="code" href="custom__new__enable_8h.html" title="Include file to re-enable CrystalSpace&#39;s &#39;operator new&#39; override after...">csutil/custom_new_enable.h</a>"</span> <a name="l00139"></a>00139 <a name="l00140"></a>00140 <span class="preprocessor">#endif // __CS_CSUTIL_COWWRAPPER_H__</span> </pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>