root/library/doc/html/shared__ptr_8h-source.html @ 538

Revision 538, 19.1 kB (checked in by smidl, 16 years ago)

Documentation regenerated

RevLine 
[538]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>mixpp: shared_ptr.h Source File</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="annotated.html"><span>Classes</span></a></li>
55      <li class="current"><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
61      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
62    </ul>
63  </div>
64<h1>shared_ptr.h</h1><a href="shared__ptr_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
65<a name="l00013"></a>00013 <span class="preprocessor">#ifndef shared_ptr_h</span>
66<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define shared_ptr_h</span>
67<a name="l00015"></a>00015 <span class="preprocessor"></span>
68<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;limits.h&gt;</span>
69<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;algorithm&gt;</span>
70<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;stdexcept&gt;</span>
71<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;string&gt;</span>
72<a name="l00020"></a>00020 <span class="preprocessor">#include "itpp_ext.h"</span>
73<a name="l00021"></a>00021
74<a name="l00022"></a>00022 <span class="keyword">namespace </span>bdm {
75<a name="l00023"></a>00023
76<a name="l00033"></a>00033 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
77<a name="l00034"></a><a class="code" href="classbdm_1_1shared__ptr.html">00034</a> <span class="keyword">class </span><a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a> {
78<a name="l00035"></a>00035         <span class="keyword">template</span>&lt;<span class="keyword">class</span> U&gt; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>;
79<a name="l00036"></a>00036
80<a name="l00037"></a>00037 <span class="keyword">private</span>:
81<a name="l00038"></a>00038         T *payload;
82<a name="l00039"></a>00039         <span class="keywordtype">unsigned</span> *refCnt;
83<a name="l00040"></a>00040
84<a name="l00041"></a>00041 <span class="keyword">public</span>:
85<a name="l00043"></a><a class="code" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11">00043</a>         <a class="code" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11" title="Creates an empty shared_ptr - one that doesn&amp;#39;t point anywhere.">shared_ptr</a>() :
86<a name="l00044"></a>00044                         payload ( 0 ),
87<a name="l00045"></a>00045                         refCnt ( 0 ) {
88<a name="l00046"></a>00046         }
89<a name="l00047"></a>00047
90<a name="l00054"></a><a class="code" href="classbdm_1_1shared__ptr.html#c8b7f0a813173581530c80d7ac4fc7c2">00054</a>         <a class="code" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11" title="Creates an empty shared_ptr - one that doesn&amp;#39;t point anywhere.">shared_ptr</a> ( T *p ) :
91<a name="l00055"></a>00055                         payload ( p ),
92<a name="l00056"></a>00056                         refCnt ( p ? new unsigned ( 1 ) : 0 ) {
93<a name="l00057"></a>00057         }
94<a name="l00058"></a>00058
95<a name="l00061"></a><a class="code" href="classbdm_1_1shared__ptr.html#357702d12bfd608a08b46e4a194aa4b5">00061</a>         <a class="code" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11" title="Creates an empty shared_ptr - one that doesn&amp;#39;t point anywhere.">shared_ptr</a> ( <span class="keyword">const</span> <a class="code" href="classbdm_1_1shared__ptr.html">shared_ptr&lt;T&gt;</a> &amp;other ) :
96<a name="l00062"></a>00062                         payload ( other.payload ),
97<a name="l00063"></a>00063                         refCnt ( other.refCnt ) {
98<a name="l00064"></a>00064                 add_ref();
99<a name="l00065"></a>00065         }
100<a name="l00066"></a>00066
101<a name="l00069"></a>00069         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> U&gt;
102<a name="l00070"></a><a class="code" href="classbdm_1_1shared__ptr.html#affa5b17385493f4102c52cf75d3b509">00070</a>         <a class="code" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11" title="Creates an empty shared_ptr - one that doesn&amp;#39;t point anywhere.">shared_ptr</a> ( <span class="keyword">const</span> <a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr&lt;U&gt;</a> &amp;other ) :
103<a name="l00071"></a>00071                         payload ( other.payload ),
104<a name="l00072"></a>00072                         refCnt ( other.refCnt ) {
105<a name="l00073"></a>00073                 add_ref();
106<a name="l00074"></a>00074         }
107<a name="l00075"></a>00075
108<a name="l00076"></a>00076         ~<a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>() {
109<a name="l00077"></a>00077                 del_ref();
110<a name="l00078"></a>00078         }
111<a name="l00079"></a>00079
112<a name="l00080"></a>00080         shared_ptr&lt;T&gt; &amp;operator= ( <span class="keyword">const</span> shared_ptr&lt;T&gt; &amp;other ) {
113<a name="l00081"></a>00081                 other.add_ref();
114<a name="l00082"></a>00082                 del_ref();
115<a name="l00083"></a>00083
116<a name="l00084"></a>00084                 payload = other.payload;
117<a name="l00085"></a>00085                 refCnt = other.refCnt;
118<a name="l00086"></a>00086
119<a name="l00087"></a>00087                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
120<a name="l00088"></a>00088         }
121<a name="l00089"></a>00089
122<a name="l00092"></a><a class="code" href="classbdm_1_1shared__ptr.html#37ebcfb6750dd7b5630f1d2354c07a96">00092</a>         T *<span class="keyword">get</span>() {
123<a name="l00093"></a>00093                 <span class="keywordflow">return</span> payload;
124<a name="l00094"></a>00094         }
125<a name="l00095"></a>00095
126<a name="l00099"></a><a class="code" href="classbdm_1_1shared__ptr.html#bcaae812868eacbad050beda465d2327">00099</a>         T *<a class="code" href="classbdm_1_1shared__ptr.html#bcaae812868eacbad050beda465d2327">operator-&gt;</a>() {
127<a name="l00100"></a>00100                 it_assert_debug ( payload, <span class="stringliteral">"dereferencing NULL"</span> );
128<a name="l00101"></a>00101                 <span class="keywordflow">return</span> payload;
129<a name="l00102"></a>00102         }
130<a name="l00103"></a>00103
131<a name="l00107"></a><a class="code" href="classbdm_1_1shared__ptr.html#de38de837267becf5eed2839fea42c45">00107</a>         T &amp;<a class="code" href="classbdm_1_1shared__ptr.html#de38de837267becf5eed2839fea42c45">operator*</a>() {
132<a name="l00108"></a>00108                 it_assert_debug ( payload, <span class="stringliteral">"dereferencing NULL"</span> );
133<a name="l00109"></a>00109                 <span class="keywordflow">return</span> *payload;
134<a name="l00110"></a>00110         }
135<a name="l00111"></a>00111
136<a name="l00114"></a><a class="code" href="classbdm_1_1shared__ptr.html#fff45e4841b2921cd42ce0691f8c1196">00114</a>         <span class="keyword">const</span> T* <span class="keyword">get</span>() <span class="keyword">const</span> {
137<a name="l00115"></a>00115                 <span class="keywordflow">return</span> payload;
138<a name="l00116"></a>00116         }
139<a name="l00117"></a>00117
140<a name="l00121"></a><a class="code" href="classbdm_1_1shared__ptr.html#d89ec7ceb318241d833c7d278444396d">00121</a>         <span class="keyword">const</span> T *<a class="code" href="classbdm_1_1shared__ptr.html#d89ec7ceb318241d833c7d278444396d">operator-&gt;</a>()<span class="keyword"> const </span>{
141<a name="l00122"></a>00122                 it_assert_debug ( payload, <span class="stringliteral">"dereferencing NULL"</span> );
142<a name="l00123"></a>00123                 <span class="keywordflow">return</span> payload;
143<a name="l00124"></a>00124         }
144<a name="l00125"></a>00125
145<a name="l00129"></a><a class="code" href="classbdm_1_1shared__ptr.html#de000a72fe73804aa26962432f264800">00129</a>         <span class="keyword">const</span> T &amp;<a class="code" href="classbdm_1_1shared__ptr.html#de000a72fe73804aa26962432f264800">operator*</a>()<span class="keyword"> const </span>{
146<a name="l00130"></a>00130                 it_assert_debug ( payload, <span class="stringliteral">"dereferencing NULL"</span> );
147<a name="l00131"></a>00131                 <span class="keywordflow">return</span> *payload;
148<a name="l00132"></a>00132         }
149<a name="l00133"></a>00133
150<a name="l00134"></a>00134         <span class="keywordtype">bool</span> unique()<span class="keyword"> const </span>{
151<a name="l00135"></a>00135                 <span class="keywordflow">return</span> refCnt &amp;&amp; ( *refCnt == 1 );
152<a name="l00136"></a>00136         }
153<a name="l00137"></a>00137
154<a name="l00138"></a>00138         <span class="keywordtype">long</span> use_count()<span class="keyword"> const </span>{
155<a name="l00139"></a>00139                 <span class="keywordflow">return</span> refCnt ? *refCnt : 0;
156<a name="l00140"></a>00140         }
157<a name="l00141"></a>00141
158<a name="l00142"></a>00142         operator bool()<span class="keyword"> const </span>{
159<a name="l00143"></a>00143                 <span class="keywordflow">return</span> payload;
160<a name="l00144"></a>00144         }
161<a name="l00145"></a>00145
162<a name="l00146"></a>00146         <span class="keywordtype">void</span> swap ( <a class="code" href="classbdm_1_1shared__ptr.html#66a4d41031e37618f1a9bb3c81814c11" title="Creates an empty shared_ptr - one that doesn&amp;#39;t point anywhere.">shared_ptr</a> &amp;other ) {
163<a name="l00147"></a>00147                 std::swap ( payload, other.payload );
164<a name="l00148"></a>00148                 std::swap ( refCnt, other.refCnt );
165<a name="l00149"></a>00149         }
166<a name="l00150"></a>00150
167<a name="l00151"></a>00151 <span class="keyword">private</span>:
168<a name="l00152"></a>00152         <span class="keywordtype">void</span> add_ref()<span class="keyword"> const </span>{
169<a name="l00153"></a>00153                 <span class="keywordflow">if</span> ( refCnt ) {
170<a name="l00154"></a>00154                         <span class="keywordflow">if</span> ( *refCnt == UINT_MAX ) {
171<a name="l00155"></a>00155                                 <span class="keywordflow">throw</span> std::overflow_error (
172<a name="l00156"></a>00156                                     std::string ( <span class="stringliteral">"Shared pointer has too many references."</span> ) );
173<a name="l00157"></a>00157                         }
174<a name="l00158"></a>00158
175<a name="l00159"></a>00159                         ++*refCnt;
176<a name="l00160"></a>00160                 }
177<a name="l00161"></a>00161         }
178<a name="l00162"></a>00162
179<a name="l00163"></a>00163         <span class="keywordtype">void</span> del_ref() {
180<a name="l00164"></a>00164                 <span class="keywordflow">if</span> ( refCnt ) {
181<a name="l00165"></a>00165                         <span class="keywordflow">if</span> ( ! ( --*refCnt ) ) {
182<a name="l00166"></a>00166                                 <span class="keyword">delete</span> payload;
183<a name="l00167"></a>00167                                 <span class="keyword">delete</span> refCnt;
184<a name="l00168"></a>00168                         }
185<a name="l00169"></a>00169                 }
186<a name="l00170"></a>00170         }
187<a name="l00171"></a>00171 };
188<a name="l00172"></a>00172
189<a name="l00174"></a>00174 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U&gt;
190<a name="l00175"></a>00175 <span class="keywordtype">bool</span> operator== ( shared_ptr&lt;T&gt; <span class="keyword">const</span> &amp;a, shared_ptr&lt;U&gt; <span class="keyword">const</span> &amp;b ) {
191<a name="l00176"></a>00176         <span class="keywordflow">return</span> a.get() == b.get();
192<a name="l00177"></a>00177 }
193<a name="l00178"></a>00178
194<a name="l00180"></a>00180 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U&gt;
195<a name="l00181"></a>00181 <span class="keywordtype">bool</span> operator!= ( shared_ptr&lt;T&gt; <span class="keyword">const</span> &amp;a, shared_ptr&lt;U&gt; <span class="keyword">const</span> &amp;b ) {
196<a name="l00182"></a>00182         <span class="keywordflow">return</span> a.get() != b.get();
197<a name="l00183"></a>00183 }
198<a name="l00184"></a>00184
199<a name="l00186"></a>00186 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U&gt;
200<a name="l00187"></a>00187 <span class="keywordtype">bool</span> operator&lt; ( shared_ptr&lt;T&gt; <span class="keyword">const</span> &amp;a, shared_ptr&lt;U&gt; <span class="keyword">const</span> &amp;b ) {
201<a name="l00188"></a>00188         <span class="keywordflow">return</span> a.get() &lt; b.get();
202<a name="l00189"></a>00189 }
203<a name="l00190"></a>00190
204<a name="l00198"></a>00198 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
205<a name="l00199"></a><a class="code" href="classbdm_1_1object__ptr.html">00199</a> <span class="keyword">class </span><a class="code" href="classbdm_1_1object__ptr.html" title="A wrapper of shared_ptr which is never empty.">object_ptr</a> : <span class="keyword">public</span> <a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>&lt;T&gt;
206<a name="l00200"></a>00200 {
207<a name="l00201"></a>00201 <span class="keyword">public</span>:
208<a name="l00207"></a><a class="code" href="classbdm_1_1object__ptr.html#9f1016ff2bbfa497d1cc0a4497c1fba4">00207</a>         <a class="code" href="classbdm_1_1object__ptr.html#9f1016ff2bbfa497d1cc0a4497c1fba4" title="Default constructor.">object_ptr</a>() : <a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>&lt;T&gt; ( new T() ) { }
209<a name="l00208"></a>00208
210<a name="l00214"></a><a class="code" href="classbdm_1_1object__ptr.html#dcb20017177c98274c16087b2c0067dc">00214</a>         <a class="code" href="classbdm_1_1object__ptr.html#dcb20017177c98274c16087b2c0067dc" title="Upcast from shared_ptr&amp;lt;T&amp;gt; to object_ptr&amp;lt;T&amp;gt;.">object_ptr</a> ( <span class="keyword">const</span> <a class="code" href="classbdm_1_1shared__ptr.html">shared_ptr&lt;T&gt;</a> &amp;b ) : <a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>&lt;T&gt; ( b ) {
211<a name="l00215"></a>00215                 it_assert_debug ( this-&gt;<span class="keyword">get</span>(), <span class="stringliteral">"object_ptr cannot be empty"</span> );
212<a name="l00216"></a>00216         }
213<a name="l00217"></a>00217
214<a name="l00222"></a><a class="code" href="classbdm_1_1object__ptr.html#a9eb00600d8640711eadeed98c7892e9">00222</a>         <a class="code" href="classbdm_1_1object__ptr.html#a9eb00600d8640711eadeed98c7892e9">object_ptr</a> ( T *p ) : <a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr</a>&lt;T&gt; ( p ) {
215<a name="l00223"></a>00223                 it_assert_debug ( p, <span class="stringliteral">"object_ptr cannot be empty"</span> );
216<a name="l00224"></a>00224         }
217<a name="l00225"></a>00225
218<a name="l00226"></a>00226         <a class="code" href="classbdm_1_1object__ptr.html" title="A wrapper of shared_ptr which is never empty.">object_ptr&lt;T&gt;</a> &amp;operator= ( <span class="keyword">const</span> <a class="code" href="classbdm_1_1object__ptr.html" title="A wrapper of shared_ptr which is never empty.">object_ptr&lt;T&gt;</a> &amp;other ) {
219<a name="l00227"></a>00227                 <a class="code" href="classbdm_1_1shared__ptr.html" title="A naive implementation of roughly a subset of the std::tr1:shared_ptr spec.">shared_ptr&lt;T&gt;::operator= </a>( other );
220<a name="l00228"></a>00228                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
221<a name="l00229"></a>00229         }
222<a name="l00230"></a>00230 };
223<a name="l00231"></a>00231
224<a name="l00232"></a>00232 <span class="preprocessor">#define SHAREDPTR(class_name) typedef bdm::object_ptr&lt; class_name &gt; class_name##_ptr</span>
225<a name="l00233"></a>00233 <span class="preprocessor"></span>
226<a name="l00234"></a>00234 <span class="preprocessor">#define SHAREDPTR2(template_class_name, template_parameter_name) typedef bdm::object_ptr&lt; template_class_name &lt; template_parameter_name &gt; &gt; template_class_name##_##template_parameter_name##_ptr</span>
227<a name="l00235"></a>00235 <span class="preprocessor"></span>
228<a name="l00236"></a>00236 }
229<a name="l00237"></a>00237
230<a name="l00238"></a>00238 <span class="preprocessor">#endif</span>
231</pre></div></div>
232<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:18 2009 for mixpp by&nbsp;
233<a href="http://www.doxygen.org/index.html">
234<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
235</body>
236</html>
Note: See TracBrowser for help on using the browser.