Sophie

Sophie

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

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/refarr.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/refarr.h</h1><a href="refarr_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 Smart Pointers</span>
<a name="l00003"></a>00003 <span class="comment">  Copyright (C) 2002 by Jorrit Tyberghein and Matthias Braun</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">  This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">  modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">  License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">  version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">  This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">  Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">  You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">  License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_REFARR_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_REFARR_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00028"></a>00028 <span class="comment">// Note *1*: The explicit "this-&gt;" is needed by modern compilers (such as gcc</span>
<a name="l00029"></a>00029 <span class="comment">// 3.4.x) which distinguish between dependent and non-dependent names in</span>
<a name="l00030"></a>00030 <span class="comment">// templates.  See: http://gcc.gnu.org/onlinedocs/gcc/Name-lookup.html</span>
<a name="l00031"></a>00031 <span class="comment">//-----------------------------------------------------------------------------</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="ref_8h.html" title="Smart Pointers.">csutil/ref.h</a>"</span>
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="preprocessor">#ifdef CS_REF_TRACKER</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor"> #include &lt;typeinfo&gt;</span>
<a name="l00038"></a>00038 <span class="preprocessor"> #include "<a class="code" href="reftrackeraccess_8h.html" title="Reference tracker access.">csutil/reftrackeraccess.h</a>"</span>
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="preprocessor"> #define CSREFARR_TRACK(x, cmd, refCount, obj, tag) \</span>
<a name="l00041"></a>00041 <span class="preprocessor">  {                                                 \</span>
<a name="l00042"></a>00042 <span class="preprocessor">    const int rc = obj ? refCount : -1;             \</span>
<a name="l00043"></a>00043 <span class="preprocessor">    if (obj) cmd;                                   \</span>
<a name="l00044"></a>00044 <span class="preprocessor">    if (obj)                                        \</span>
<a name="l00045"></a>00045 <span class="preprocessor">    {                                               \</span>
<a name="l00046"></a>00046 <span class="preprocessor">      csRefTrackerAccess::SetDescription (obj,      \</span>
<a name="l00047"></a>00047 <span class="preprocessor">        typeid(T).name());                          \</span>
<a name="l00048"></a>00048 <span class="preprocessor">      csRefTrackerAccess::Match ## x (obj, rc, tag);\</span>
<a name="l00049"></a>00049 <span class="preprocessor">    }                                               \</span>
<a name="l00050"></a>00050 <span class="preprocessor">  }</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor"> #define CSREFARR_TRACK_INCREF(obj,tag) \</span>
<a name="l00052"></a>00052 <span class="preprocessor">  CSREFARR_TRACK(IncRef, obj-&gt;IncRef(), obj-&gt;GetRefCount(), obj, tag);</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor"> #define CSREFARR_TRACK_DECREF(obj,tag) \</span>
<a name="l00054"></a>00054 <span class="preprocessor">  CSREFARR_TRACK(DecRef, obj-&gt;DecRef(), obj-&gt;GetRefCount(), obj, tag);</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00056"></a><a class="code" href="refarr_8h.html#c385815c5f51bd292cced2f3ceb388e8">00056</a> <span class="preprocessor"></span><span class="preprocessor"> #define CSREFARR_TRACK_INCREF(obj,tag) \</span>
<a name="l00057"></a>00057 <span class="preprocessor">  if (obj) obj-&gt;IncRef();</span>
<a name="l00058"></a><a class="code" href="refarr_8h.html#dc294013152a4535b8b50e7037b7db1c">00058</a> <span class="preprocessor"></span><span class="preprocessor"> #define CSREFARR_TRACK_DECREF(obj,tag) \</span>
<a name="l00059"></a>00059 <span class="preprocessor">  if (obj) obj-&gt;DecRef();</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span>
<a name="l00062"></a>00062 <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;
<a name="l00063"></a><a class="code" href="classcsRefArrayElementHandler.html">00063</a> <span class="keyword">class </span><a class="code" href="classcsRefArrayElementHandler.html">csRefArrayElementHandler</a> : <span class="keyword">public</span> <a class="code" href="classcsArrayElementHandler.html" title="The default element handler for csArray.">csArrayElementHandler</a>&lt;T&gt;
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 <span class="keyword">public</span>:
<a name="l00066"></a><a class="code" href="classcsRefArrayElementHandler.html#a54457ee9db9ab66a2533143cac9b5ef">00066</a>   <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcsRefArrayElementHandler.html#a54457ee9db9ab66a2533143cac9b5ef" title="Copy-construct an element.">Construct</a> (T* address, T <span class="keyword">const</span>&amp; src)
<a name="l00067"></a>00067   {
<a name="l00068"></a>00068     *address = src;
<a name="l00069"></a>00069     <a class="code" href="refarr_8h.html#c385815c5f51bd292cced2f3ceb388e8">CSREFARR_TRACK_INCREF</a> (src, address);
<a name="l00070"></a>00070   }
<a name="l00071"></a>00071 
<a name="l00072"></a><a class="code" href="classcsRefArrayElementHandler.html#3c12fc20c90e47e1199e317fedd8d77f">00072</a>   <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcsRefArrayElementHandler.html#3c12fc20c90e47e1199e317fedd8d77f" title="Destroy an element.">Destroy</a> (T* address)
<a name="l00073"></a>00073   {
<a name="l00074"></a>00074     <a class="code" href="refarr_8h.html#dc294013152a4535b8b50e7037b7db1c">CSREFARR_TRACK_DECREF</a> ((*address), address);
<a name="l00075"></a>00075   }
<a name="l00076"></a>00076 
<a name="l00077"></a><a class="code" href="classcsRefArrayElementHandler.html#f82a782da2985f814c65864fa39a57fa">00077</a>   <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcsRefArrayElementHandler.html#f82a782da2985f814c65864fa39a57fa" title="Construct a number of elements.">InitRegion</a> (T* address, <span class="keywordtype">size_t</span> count)
<a name="l00078"></a>00078   {
<a name="l00079"></a>00079     memset (address, 0, count*<span class="keyword">sizeof</span> (T));
<a name="l00080"></a>00080   }
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082 
<a name="l00091"></a>00091 <span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> Allocator = CS::Memory::AllocatorMalloc&gt;
<a name="l00092"></a><a class="code" href="classcsRefArray.html">00092</a> <span class="keyword">class </span><a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray</a> : <span class="keyword">public</span> <a class="code" href="classcsArray.html" title="A templated array class.">csArray</a>&lt;T*, csRefArrayElementHandler&lt;T*&gt;, Allocator&gt;
<a name="l00093"></a>00093 {
<a name="l00094"></a>00094 <span class="keyword">public</span>:
<a name="l00099"></a><a class="code" href="classcsRefArray.html#aa2d8d414df976427e7cc1eb77e39731">00099</a>   <a class="code" href="classcsRefArray.html#aa2d8d414df976427e7cc1eb77e39731" title="Initialize object to hold initially &amp;#39;ilimit&amp;#39; elements, and increase storage...">csRefArray</a> (<span class="keywordtype">int</span> ilimit = 0, <span class="keywordtype">int</span> ithreshold = 0)
<a name="l00100"></a>00100     : <a class="code" href="classcsArray.html" title="A templated array class.">csArray</a>&lt;T*, <a class="code" href="classcsRefArrayElementHandler.html">csRefArrayElementHandler</a>&lt;T*&gt;, Allocator&gt; (ilimit, ithreshold)
<a name="l00101"></a>00101   {
<a name="l00102"></a>00102   }
<a name="l00103"></a>00103 
<a name="l00105"></a><a class="code" href="classcsRefArray.html#a7505d6787a5fe3cf4fc01a358b626b7">00105</a>   <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;T&gt;</a> <a class="code" href="classcsRefArray.html#a7505d6787a5fe3cf4fc01a358b626b7" title="Pop an element from tail end of array.">Pop</a> ()
<a name="l00106"></a>00106   {
<a name="l00107"></a>00107     <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a> (this-&gt;GetSize () &gt; 0);
<a name="l00108"></a>00108     <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;T&gt;</a> ret = this-&gt;<a class="code" href="classcsArray.html#b4deb6da0262469c90355af478ed88a1" title="Get an element (non-const).">Get</a> (this-&gt;GetSize () - 1); <span class="comment">// see *1*</span>
<a name="l00109"></a>00109     <a class="code" href="classcsArray.html#3f69105af97a9482396260e379a45f37" title="Set the actual number of items in this array.">SetSize</a> (this-&gt;GetSize () - 1);
<a name="l00110"></a>00110     <span class="keywordflow">return</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;T&gt;</a> (ret);
<a name="l00111"></a>00111   }
<a name="l00112"></a>00112 };
<a name="l00113"></a>00113 
<a name="l00114"></a>00114 <span class="preprocessor">#undef CSREFARR_TRACK_INCREF</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span><span class="preprocessor">#undef CSREFARR_TRACK_DECREF</span>
<a name="l00116"></a>00116 <span class="preprocessor"></span>
<a name="l00117"></a>00117 <span class="preprocessor">#endif // __CS_REFARR_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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional