Sophie

Sophie

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

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/fifo.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/fifo.h</h1><a href="fifo_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) 2005 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">              (C) 2005 by Frank Richter</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_CSUTIL_FIFO_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_FIFO_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00028"></a>00028 
<a name="l00033"></a>00033 <span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ElementHandler = csArrayElementHandler&lt;T&gt;,
<a name="l00034"></a>00034   <span class="keyword">class</span> MemoryAllocator = CS::Memory::AllocatorMalloc&gt;
<a name="l00035"></a><a class="code" href="classcsFIFO.html">00035</a> <span class="keyword">class </span><a class="code" href="classcsFIFO.html" title="A FIFO implemented on top of csArray&amp;lt;&amp;gt;, but faster than using just a single...">csFIFO</a>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00038"></a><a class="code" href="classcsFIFO.html#d7922894f47f011ae3d7f23bc9ac2a5f">00038</a>   <span class="keyword">typedef</span> <a class="code" href="classcsFIFO.html" title="A FIFO implemented on top of csArray&amp;lt;&amp;gt;, but faster than using just a single...">csFIFO&lt;T, ElementHandler, MemoryAllocator&gt;</a> <a class="code" href="classcsFIFO.html" title="A FIFO implemented on top of csArray&amp;lt;&amp;gt;, but faster than using just a single...">ThisType</a>;
<a name="l00039"></a><a class="code" href="classcsFIFO.html#f09c5022ebcd5072dca6e02bf8d123a1">00039</a>   <span class="keyword">typedef</span> T <a class="code" href="classcsFIFO.html#f09c5022ebcd5072dca6e02bf8d123a1">ValueType</a>;
<a name="l00040"></a><a class="code" href="classcsFIFO.html#e8fa6529d4919948e774dc77b21782c4">00040</a>   <span class="keyword">typedef</span> ElementHandler <a class="code" href="classcsFIFO.html#e8fa6529d4919948e774dc77b21782c4">ElementHandlerType</a>;
<a name="l00041"></a><a class="code" href="classcsFIFO.html#f2aa0407262b30fad7b9ec90bbf99aef">00041</a>   <span class="keyword">typedef</span> MemoryAllocator <a class="code" href="classcsFIFO.html#f2aa0407262b30fad7b9ec90bbf99aef">AllocatorType</a>;
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <span class="keyword">private</span>:
<a name="l00044"></a>00044   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;T, ElementHandler, MemoryAllocator&gt;</a> a1, a2;
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00050"></a><a class="code" href="classcsFIFO.html#3609d1fddb635c57e62f5b881e04046d">00050</a>   <a class="code" href="classcsFIFO.html#3609d1fddb635c57e62f5b881e04046d" title="Construct the FIFO.">csFIFO</a> (<span class="keywordtype">size_t</span> icapacity = 0, <span class="keywordtype">size_t</span> ithreshold = 0) 
<a name="l00051"></a>00051     :  a1 (icapacity, ithreshold), a2 (icapacity, ithreshold) { }
<a name="l00052"></a>00052 
<a name="l00056"></a><a class="code" href="classcsFIFO.html#e615e57f0901346ae6968d1b7ee0305e">00056</a>   T <a class="code" href="classcsFIFO.html#e615e57f0901346ae6968d1b7ee0305e" title="Return and remove the first element.">PopTop</a> ()
<a name="l00057"></a>00057   {
<a name="l00058"></a>00058     <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a> ((a1.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> () &gt; 0) || (a2.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> () &gt; 0));
<a name="l00059"></a>00059     <span class="keywordflow">if</span> (a2.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> () == 0)
<a name="l00060"></a>00060     {
<a name="l00061"></a>00061       <span class="keywordtype">size_t</span> n = a1.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> ();
<a name="l00062"></a>00062       <span class="keywordflow">while</span> (n-- &gt; 0)
<a name="l00063"></a>00063       {
<a name="l00064"></a>00064         a2.<a class="code" href="classcsArray.html#6c1acc9a8bdc9d19272f5236089c6b5b" title="Push a copy of an element onto the tail end of the array.">Push</a> (a1[n]);
<a name="l00065"></a>00065       }
<a name="l00066"></a>00066       a1.<a class="code" href="classcsArray.html#e602bfe2feb67cac781c27bf2bef3e91" title="Remove all elements.">Empty</a>();
<a name="l00067"></a>00067     }
<a name="l00068"></a>00068     <span class="keywordflow">return</span> a2.<a class="code" href="classcsArray.html#655e373ba6de12e2fe2ceda2880f1f89" title="Pop an element from tail end of array.">Pop</a>();
<a name="l00069"></a>00069   }
<a name="l00070"></a>00070 
<a name="l00074"></a><a class="code" href="classcsFIFO.html#46ae6f1d195bb152921b9160ce92bd50">00074</a>   <span class="keywordtype">void</span> <a class="code" href="classcsFIFO.html#46ae6f1d195bb152921b9160ce92bd50" title="Push an element onto the FIFO.">Push</a> (T <span class="keyword">const</span>&amp; what)
<a name="l00075"></a>00075   {
<a name="l00076"></a>00076     a1.<a class="code" href="classcsArray.html#6c1acc9a8bdc9d19272f5236089c6b5b" title="Push a copy of an element onto the tail end of the array.">Push</a> (what);
<a name="l00077"></a>00077   }
<a name="l00078"></a>00078 
<a name="l00080"></a><a class="code" href="classcsFIFO.html#696292f39d7059734140e8ddd6531341">00080</a>   <span class="keywordtype">size_t</span> <a class="code" href="classcsFIFO.html#696292f39d7059734140e8ddd6531341" title="Return the number of elements in the FIFO.">GetSize</a>()
<a name="l00081"></a>00081   {
<a name="l00082"></a>00082     <span class="keywordflow">return</span> a1.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>() + a2.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a>();
<a name="l00083"></a>00083   }
<a name="l00084"></a>00084 
<a name="l00089"></a>00089   <a class="code" href="cssysdef_8h.html#69b27a22db26f4a2bb7a26a85d2ab06b" title="A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that...">CS_DEPRECATED_METHOD_MSG</a>(<span class="stringliteral">"Use GetSize() instead."</span>)
<a name="l00090"></a><a class="code" href="classcsFIFO.html#a50ee41231a09cca92dc209cbbf4347d">00090</a>   size_t <a class="code" href="classcsFIFO.html#a50ee41231a09cca92dc209cbbf4347d" title="Return the number of elements in the FIFO.">Length</a>()
<a name="l00091"></a>00091   {
<a name="l00092"></a>00092     <span class="keywordflow">return</span> <a class="code" href="classcsFIFO.html#696292f39d7059734140e8ddd6531341" title="Return the number of elements in the FIFO.">GetSize</a>();
<a name="l00093"></a>00093   }
<a name="l00094"></a>00094 
<a name="l00099"></a><a class="code" href="classcsFIFO.html#dc48c9e57d7a6e8b05bbda65eb0dbc27">00099</a>   <span class="keywordtype">bool</span> <a class="code" href="classcsFIFO.html#dc48c9e57d7a6e8b05bbda65eb0dbc27" title="Linearly search for an item and delete it.">Delete</a> (T <span class="keyword">const</span>&amp; what)
<a name="l00100"></a>00100   {
<a name="l00101"></a>00101     <span class="keywordflow">return</span> (a1.<a class="code" href="classcsArray.html#34ba9b935aad19665f01e61873a25cc2" title="Delete the given element from the array.">Delete</a> (what) || a2.<a class="code" href="classcsArray.html#34ba9b935aad19665f01e61873a25cc2" title="Delete the given element from the array.">Delete</a> (what));
<a name="l00102"></a>00102   }
<a name="l00103"></a>00103 
<a name="l00105"></a><a class="code" href="classcsFIFO.html#96d7fa2a159d26b389c069a728039df5">00105</a>   <span class="keywordtype">void</span> <a class="code" href="classcsFIFO.html#96d7fa2a159d26b389c069a728039df5" title="Delete all items.">DeleteAll</a> ()
<a name="l00106"></a>00106   {
<a name="l00107"></a>00107     a1.<a class="code" href="classcsArray.html#2b5ebb745f73aefdbbe3210853b648bc" title="Clear entire array, releasing all allocated memory.">DeleteAll</a>();
<a name="l00108"></a>00108     a2.<a class="code" href="classcsArray.html#2b5ebb745f73aefdbbe3210853b648bc" title="Clear entire array, releasing all allocated memory.">DeleteAll</a>();
<a name="l00109"></a>00109   }
<a name="l00110"></a>00110 };
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="preprocessor">#endif // __CS_CSUTIL_FIFO_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