source: OGRE/trunk/ogrenew/Docs/api/html/OgreSharedPtr_8h-source.html @ 692

Revision 692, 17.3 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreSharedPtr.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>OgreSharedPtr.h</h1><a href="OgreSharedPtr_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef __SharedPtr_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __SharedPtr_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029
3900030 <span class="keyword">namespace </span>Ogre {
4000031
41<a name="l00044"></a><a class="code" href="classOgre_1_1SharedPtr.html">00044</a>     <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span><a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr</a> {
4200045     <span class="keyword">protected</span>:
43<a name="l00046"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp0">00046</a>         T* pRep;
44<a name="l00047"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp1">00047</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* pUseCount;
4500048     <span class="keyword">public</span>:
4600049         <a class="code" href="OgrePrerequisites_8h.html#a16">OGRE_AUTO_SHARED_MUTEX</a> <span class="comment">// public to allow external locking</span>
47<a name="l00054"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra0">00054</a> <span class="comment"></span>        <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra0">SharedPtr</a>() : pRep(0), pUseCount(0) {}
48<a name="l00055"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra1">00055</a>         <span class="keyword">explicit</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra0">SharedPtr</a>(T* rep) : pRep(rep), pUseCount(new unsigned int(1))
4900056         {
5000057             <a class="code" href="OgrePrerequisites_8h.html#a18">OGRE_NEW_AUTO_SHARED_MUTEX</a>
5100058         }
52<a name="l00059"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra2">00059</a>         <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra0">SharedPtr</a>(<span class="keyword">const</span> SharedPtr&amp; r)
5300060         {
5400061             <span class="comment">// lock &amp; copy other mutex pointer</span>
5500062             <a class="code" href="OgrePrerequisites_8h.html#a15">OGRE_LOCK_MUTEX</a>(*r.OGRE_AUTO_MUTEX_NAME)
5600063             <a class="code" href="OgrePrerequisites_8h.html#a20">OGRE_COPY_AUTO_SHARED_MUTEX</a>(r.OGRE_AUTO_MUTEX_NAME)
5700064             pRep = r.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp0">pRep</a>;
5800065             pUseCount = r.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp1">pUseCount</a>;
5900066             <span class="comment">// Handle zero pointer gracefully to manage STL containers</span>
6000067             <span class="keywordflow">if</span>(pUseCount)
6100068             {
6200069                 ++(*pUseCount);
6300070             }
6400071         }
65<a name="l00072"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra3">00072</a>         SharedPtr&amp; <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra3">operator=</a>(<span class="keyword">const</span> SharedPtr&amp; r) {
6600073             <span class="keywordflow">if</span> (pRep == r.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp0">pRep</a>)
6700074                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
6800075             <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb0">release</a>();
6900076             <span class="comment">// lock &amp; copy other mutex pointer</span>
7000077             <a class="code" href="OgrePrerequisites_8h.html#a15">OGRE_LOCK_MUTEX</a>(*r.OGRE_AUTO_MUTEX_NAME)
7100078             <a class="code" href="OgrePrerequisites_8h.html#a20">OGRE_COPY_AUTO_SHARED_MUTEX</a>(r.OGRE_AUTO_MUTEX_NAME)
7200079             pRep = r.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp0">pRep</a>;
7300080             pUseCount = r.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrp1">pUseCount</a>;
7400081             <span class="keywordflow">if</span> (pUseCount)
7500082             {
7600083                 ++(*pUseCount);
7700084             }
7800085             <span class="keywordflow">return</span> *<span class="keyword">this</span>;
7900086         }
80<a name="l00087"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra4">00087</a>         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra4">~SharedPtr</a>() {
8100088             <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb0">release</a>();
8200089         }
8300090
8400091
85<a name="l00092"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra5">00092</a>         <span class="keyword">inline</span> T&amp; <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra5">operator*</a>()<span class="keyword"> const </span>{ assert(pRep); <span class="keywordflow">return</span> *pRep; }
86<a name="l00093"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra6">00093</a>         <span class="keyword">inline</span> T* <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra6">operator-&gt;</a>()<span class="keyword"> const </span>{ assert(pRep); <span class="keywordflow">return</span> pRep; }
87<a name="l00094"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra7">00094</a>         <span class="keyword">inline</span> T* <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra7">get</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pRep; }
8800095
89<a name="l00100"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra8">00100</a>         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra8">bind</a>(T* rep) {
9000101             assert(!pRep &amp;&amp; !pUseCount);
9100102             <a class="code" href="OgrePrerequisites_8h.html#a18">OGRE_NEW_AUTO_SHARED_MUTEX</a>
9200103             <a class="code" href="OgrePrerequisites_8h.html#a17">OGRE_LOCK_AUTO_SHARED_MUTEX</a>
9300104             pUseCount = <span class="keyword">new</span> <span class="keywordtype">unsigned</span> int(1);
9400105             pRep = rep;
9500106         }
9600107
97<a name="l00108"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra9">00108</a>         <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra9">unique</a>()<span class="keyword"> const </span>{ assert(pUseCount); <a class="code" href="OgrePrerequisites_8h.html#a17">OGRE_LOCK_AUTO_SHARED_MUTEX</a> <span class="keywordflow">return</span> *pUseCount == 1; }
98<a name="l00109"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra10">00109</a>         <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra10">useCount</a>()<span class="keyword"> const </span>{ assert(pUseCount); <a class="code" href="OgrePrerequisites_8h.html#a17">OGRE_LOCK_AUTO_SHARED_MUTEX</a> <span class="keywordflow">return</span> *pUseCount; }
99<a name="l00110"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra11">00110</a>         <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra11">useCountPointer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pUseCount; }
10000111
101<a name="l00112"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra12">00112</a>         <span class="keyword">inline</span> T* <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra12">getPointer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pRep; }
10200113
103<a name="l00114"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra13">00114</a>         <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra13">isNull</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pRep == 0; }
10400115
105<a name="l00116"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra14">00116</a>         <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra14">setNull</a>(<span class="keywordtype">void</span>) {
10600117             <span class="keywordflow">if</span> (pRep)
10700118             {
10800119                 <span class="comment">// can't scope lock mutex before release incase deleted</span>
10900120                 <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb0">release</a>();
11000121                 pRep = 0;
11100122                 pUseCount = 0;
11200123                 <a class="code" href="OgrePrerequisites_8h.html#a20">OGRE_COPY_AUTO_SHARED_MUTEX</a>(0)
11300124             }
11400125         }
11500126
11600127     <span class="keyword">protected</span>:
11700128
118<a name="l00129"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb0">00129</a>         <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb0">release</a>(<span class="keywordtype">void</span>) {
11900130             <span class="keywordtype">bool</span> destroyThis = <span class="keyword">false</span>;
12000131             {
12100132                 <span class="comment">// lock own mutex in limited scope (must unlock before destroy)</span>
12200133                 <a class="code" href="OgrePrerequisites_8h.html#a17">OGRE_LOCK_AUTO_SHARED_MUTEX</a>
12300134                 <span class="keywordflow">if</span> (pUseCount)
12400135                 {
12500136                     <span class="keywordflow">if</span> (--(*pUseCount) == 0)
12600137                     {
12700138                         destroyThis = <span class="keyword">true</span>;
12800139                     }
12900140                 }
13000141             }
13100142             <span class="keywordflow">if</span> (destroyThis)
13200143                 <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb1">destroy</a>();
13300144         }
13400145
135<a name="l00146"></a><a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb1">00146</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtrb1">destroy</a>(<span class="keywordtype">void</span>)
13600147         {
13700148             <span class="comment">// IF YOU GET A CRASH HERE, YOU FORGOT TO FREE UP POINTERS</span>
13800149             <span class="comment">// BEFORE SHUTTING OGRE DOWN</span>
13900150             <span class="comment">// Use setNull() before shutdown or make sure your pointer goes</span>
14000151             <span class="comment">// out of scope before OGRE shuts down to avoid this.</span>
14100152             <span class="keyword">delete</span> pRep;
14200153             <span class="keyword">delete</span> pUseCount;
14300154             <a class="code" href="OgrePrerequisites_8h.html#a19">OGRE_DELETE_AUTO_SHARED_MUTEX</a>
14400155         }
14500156     };
14600157
147<a name="l00158"></a><a class="code" href="namespaceOgre.html#a623">00158</a>     <span class="keyword">template</span>&lt;<span class="keyword">class</span> T, <span class="keyword">class</span> U&gt; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceOgre.html#a623">operator==</a>(<a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr&lt;T&gt;</a> <span class="keyword">const</span>&amp; a, <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr&lt;U&gt;</a> <span class="keyword">const</span>&amp; b)
14800159     {
14900160         <span class="keywordflow">return</span> a.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra7">get</a>() == b.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra7">get</a>();
15000161     }
15100162
152<a name="l00163"></a><a class="code" href="namespaceOgre.html#a624">00163</a>     <span class="keyword">template</span>&lt;<span class="keyword">class</span> T, <span class="keyword">class</span> U&gt; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespaceOgre.html#a624">operator!=</a>(<a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr&lt;T&gt;</a> <span class="keyword">const</span>&amp; a, <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr&lt;U&gt;</a> <span class="keyword">const</span>&amp; b)
15300164     {
15400165         <span class="keywordflow">return</span> a.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra7">get</a>() != b.<a class="code" href="classOgre_1_1SharedPtr.html#Ogre_1_1SharedPtra7">get</a>();
15500166     }
15600167
15700168 }
15800169
15900170 <span class="preprocessor">#endif</span>
160</pre></div><hr>
161<p>
162Copyright &copy; 2000-2005 by The OGRE Team<br />
163<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
164This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
165                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
166                <Work rdf:about="">
167                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
168        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
169                </Work>
170                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
171
172Last modified Sun Mar 12 14:37:49 2006
173</p>
174</body>
175</html>
Note: See TracBrowser for help on using the repository browser.