Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 4057

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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/weakreferenced.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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/weakreferenced.h</h1><a href="weakreferenced_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">    Crystal Space Weak Reference Counting Implementation</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2006 by Jorrit Tyberghein</span>
<a name="l00004"></a>00004 <span class="comment">              (C) 2006 by Amir Taaki</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment">    Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00017"></a>00017 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00018"></a>00018 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __CS_CSUTIL_WEAKREFERENCED_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_WEAKREFERENCED_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">array.h</a>"</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="keyword">namespace </span>CS
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Utility
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 
<a name="l00042"></a><a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html">00042</a> <span class="keyword">class </span><a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html" title="This is a class which provides basic weak reference-counting semantics.">WeakReferenced</a>
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a><a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#1080f565d43eba9ffd4f2d96bf3e0224">00045</a>   <a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#1080f565d43eba9ffd4f2d96bf3e0224">WeakReferenced</a> () : weakref_owners (0) {}
<a name="l00046"></a><a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#9c59e9232411167da21655aec5c5a959">00046</a>   <a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#9c59e9232411167da21655aec5c5a959">~WeakReferenced</a> ()
<a name="l00047"></a>00047   {
<a name="l00048"></a>00048     <span class="keywordflow">if</span> (weakref_owners)
<a name="l00049"></a>00049     {
<a name="l00050"></a>00050       <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; weakref_owners-&gt;<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>(); i++)
<a name="l00051"></a>00051       {
<a name="l00052"></a>00052         *((*weakref_owners)[i]) = 0;
<a name="l00053"></a>00053       }
<a name="l00054"></a>00054       <span class="keyword">delete</span> weakref_owners;
<a name="l00055"></a>00055     }
<a name="l00056"></a>00056   }
<a name="l00057"></a>00057 
<a name="l00058"></a><a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#653acb880fae2eb1f470f2542772d68c">00058</a>   <span class="keywordtype">void</span> <a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#653acb880fae2eb1f470f2542772d68c">AddRefOwner</a> (<span class="keywordtype">void</span>** ref_owner)
<a name="l00059"></a>00059   {
<a name="l00060"></a>00060     <span class="keywordflow">if</span> (!weakref_owners)
<a name="l00061"></a>00061       weakref_owners = <span class="keyword">new</span> <a class="code" href="classcsArray.html" title="A templated array class.">WeakRefOwnerArray</a> (0);
<a name="l00062"></a>00062     weakref_owners-&gt;<a class="code" href="classcsArray.html#be2ff9bd078ded1a2b2f4dec2b35c1fa" title="Insert an element at a sorted position, using an element comparison function.">InsertSorted</a> (ref_owner);
<a name="l00063"></a>00063   }
<a name="l00064"></a><a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#69b911275b22d521ce5cf12232299e27">00064</a>   <span class="keywordtype">void</span> <a class="code" href="classCS_1_1Utility_1_1WeakReferenced.html#69b911275b22d521ce5cf12232299e27">RemoveRefOwner</a> (<span class="keywordtype">void</span>** ref_owner)
<a name="l00065"></a>00065   {
<a name="l00066"></a>00066     <span class="keywordflow">if</span> (!weakref_owners)
<a name="l00067"></a>00067       <span class="keywordflow">return</span>;
<a name="l00068"></a>00068 
<a name="l00069"></a>00069     <span class="keywordtype">size_t</span> index = weakref_owners-&gt;<a class="code" href="classcsArray.html#eb23011335b0d46ead40440ecd53d59b" title="Find an element based on some key, using a comparison function.">FindSortedKey</a> (
<a name="l00070"></a>00070       <a class="code" href="classcsArrayCmp.html" title="A functor template which encapsulates a key and a comparison function for use with...">csArrayCmp&lt;void**, void**&gt;</a>(ref_owner));
<a name="l00071"></a>00071 
<a name="l00072"></a>00072     <span class="keywordflow">if</span> (index != <a class="code" href="group__util__containers.html#g7477ed9887527029069ab5d5c79e2f70" title="This value is returned whenever an array item could not be located or does not exist...">csArrayItemNotFound</a>)
<a name="l00073"></a>00073       weakref_owners-&gt;<a class="code" href="classcsArray.html#10a2afd5172c671fb32c70b4f6e538e8" title="Delete an element from the array.">DeleteIndex</a> (index);
<a name="l00074"></a>00074   }
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keyword">private</span>:
<a name="l00077"></a>00077   <span class="keyword">typedef</span> <a class="code" href="classcsArray.html" title="A templated array class.">csArray</a>&lt;<span class="keywordtype">void</span>**,
<a name="l00078"></a>00078     <a class="code" href="classcsArrayElementHandler.html" title="The default element handler for csArray.">csArrayElementHandler&lt;void**&gt;</a>,
<a name="l00079"></a>00079     <a class="code" href="classCS_1_1Memory_1_1AllocatorMalloc.html" title="A default memory allocator that allocates with cs_malloc().">CS::Memory::AllocatorMalloc</a>,
<a name="l00080"></a>00080     <a class="code" href="classcsArrayCapacityLinear.html" title="csArray capacity handler.">csArrayCapacityLinear&lt;csArrayThresholdFixed&lt;4&gt;</a> &gt; &gt; WeakRefOwnerArray;
<a name="l00081"></a>00081   WeakRefOwnerArray* weakref_owners;
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083 
<a name="l00084"></a>00084 } <span class="comment">// namespace Utility</span>
<a name="l00085"></a>00085 } <span class="comment">// namespace CS</span>
<a name="l00086"></a>00086 
<a name="l00087"></a>00087 <span class="preprocessor">#endif // __CS_CSUTIL_WEAKREFERENCED_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>