Sophie

Sophie

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

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/databuf.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/databuf.h</h1><a href="databuf_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 Data Buffer class</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2000 by Andrew Zabolotny</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_DATABUF_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_DATABUF_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="allocator_8h.html" title="Basic allocator classes.">csutil/allocator.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="databuff_8h.html" title="Data Buffer interface.">iutil/databuff.h</a>"</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">namespace </span>CS
<a name="l00033"></a>00033 {
<a name="l00040"></a>00040   <span class="keyword">template</span>&lt;<span class="keyword">class</span> Allocator = Memory::AllocatorMalloc&gt;
<a name="l00041"></a><a class="code" href="classCS_1_1DataBuffer.html">00041</a>   <span class="keyword">class </span><a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">DataBuffer</a> : <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;DataBuffer&lt;Allocator&gt;, 
<a name="l00042"></a>00042                                                iDataBuffer&gt;
<a name="l00043"></a>00043   {
<a name="l00045"></a>00045     <a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html" title="Class to store a pointer that is allocated from Allocator, to eliminate overhead...">Memory::AllocatorPointerWrapper&lt;char, Allocator&gt;</a> Data;
<a name="l00047"></a>00047     <span class="keywordtype">size_t</span> Size;
<a name="l00049"></a>00049     <span class="keywordtype">bool</span> do_delete;
<a name="l00050"></a>00050 
<a name="l00051"></a>00051   <span class="keyword">public</span>:
<a name="l00053"></a><a class="code" href="classCS_1_1DataBuffer.html#21ce1462604c23de2364bc6777683133">00053</a>     <a class="code" href="classCS_1_1DataBuffer.html#21ce1462604c23de2364bc6777683133" title="Construct an preallocated data buffer (filled with garbage initially).">DataBuffer</a> (<span class="keywordtype">size_t</span> iSize)
<a name="l00054"></a>00054       : <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;<a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">DataBuffer</a>, <a class="code" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>&gt; (this), Size (iSize), 
<a name="l00055"></a>00055       do_delete (true)
<a name="l00056"></a>00056     {
<a name="l00057"></a>00057       Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a> = (<span class="keywordtype">char</span>*)Data.Alloc (Size);
<a name="l00058"></a>00058     }
<a name="l00060"></a><a class="code" href="classCS_1_1DataBuffer.html#f8432cee1eae8184fe1c59cea025b7bc">00060</a>     <a class="code" href="classCS_1_1DataBuffer.html#21ce1462604c23de2364bc6777683133" title="Construct an preallocated data buffer (filled with garbage initially).">DataBuffer</a> (<span class="keywordtype">size_t</span> iSize, <span class="keyword">const</span> Allocator&amp; alloc)
<a name="l00061"></a>00061       : <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;<a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">DataBuffer</a>, <a class="code" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>&gt; (this), Data (alloc), 
<a name="l00062"></a>00062       Size (iSize), do_delete (true)
<a name="l00063"></a>00063     {
<a name="l00064"></a>00064       Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a> = Data.Alloc (Size);
<a name="l00065"></a>00065     }
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 
<a name="l00072"></a><a class="code" href="classCS_1_1DataBuffer.html#c43f0672779cdb6cfb0141fcdcf603b6">00072</a>     <a class="code" href="classCS_1_1DataBuffer.html#21ce1462604c23de2364bc6777683133" title="Construct an preallocated data buffer (filled with garbage initially).">DataBuffer</a> (<span class="keywordtype">char</span> *iData, <span class="keywordtype">size_t</span> iSize, <span class="keywordtype">bool</span> should_delete = <span class="keyword">true</span>)
<a name="l00073"></a>00073       : <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;<a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">DataBuffer</a>, <a class="code" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>&gt; (this), Size (iSize), 
<a name="l00074"></a>00074       do_delete (should_delete)
<a name="l00075"></a>00075     {
<a name="l00076"></a>00076       Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a> = iData; 
<a name="l00077"></a>00077     }
<a name="l00078"></a>00078 
<a name="l00080"></a><a class="code" href="classCS_1_1DataBuffer.html#91837377d2c4f003b3fb54e558ab5ab8">00080</a>     <a class="code" href="classCS_1_1DataBuffer.html#21ce1462604c23de2364bc6777683133" title="Construct an preallocated data buffer (filled with garbage initially).">DataBuffer</a> (<a class="code" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a> *source)
<a name="l00081"></a>00081       : <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;<a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">DataBuffer</a>, <a class="code" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>&gt; (this), Size (source-&gt;<a class="code" href="classCS_1_1DataBuffer.html#e549e5483eadac80d085dbe4b8a66cd3" title="Query the buffer size.">GetSize</a>()),
<a name="l00082"></a>00082         do_delete (true)
<a name="l00083"></a>00083     {
<a name="l00084"></a>00084       Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a> = (<span class="keywordtype">char</span>*)Data.Alloc (Size+1);
<a name="l00085"></a>00085       memcpy (Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a>, source-&gt;<a class="code" href="structiDataBuffer.html#fa904d74bb662c7384fdfebf585fb4a1" title="Get the buffer as an abstract pointer.">GetData</a>(), Size);
<a name="l00086"></a>00086       Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a>[Size] = 0;
<a name="l00087"></a>00087     }
<a name="l00088"></a>00088 
<a name="l00090"></a><a class="code" href="classCS_1_1DataBuffer.html#5878d572b0ec8e8309c89ec621acdb3d">00090</a>     <span class="keyword">virtual</span> <a class="code" href="classCS_1_1DataBuffer.html#5878d572b0ec8e8309c89ec621acdb3d" title="Destroy (free) the buffer.">~DataBuffer</a> ()
<a name="l00091"></a>00091     {
<a name="l00092"></a>00092       <span class="keywordflow">if</span> (do_delete)
<a name="l00093"></a>00093         Data.Free (Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a>);
<a name="l00094"></a>00094     }
<a name="l00095"></a>00095 
<a name="l00097"></a><a class="code" href="classCS_1_1DataBuffer.html#e549e5483eadac80d085dbe4b8a66cd3">00097</a>     <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classCS_1_1DataBuffer.html#e549e5483eadac80d085dbe4b8a66cd3" title="Query the buffer size.">GetSize</a> ()<span class="keyword"> const</span>
<a name="l00098"></a>00098 <span class="keyword">    </span>{ <span class="keywordflow">return</span> Size; }
<a name="l00099"></a>00099 
<a name="l00101"></a><a class="code" href="classCS_1_1DataBuffer.html#a893a6cb4bd9809bbcbb15e51d9ed29d">00101</a>     <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classCS_1_1DataBuffer.html#a893a6cb4bd9809bbcbb15e51d9ed29d" title="Get the buffer as an abstract pointer.">GetData</a> ()<span class="keyword"> const</span>
<a name="l00102"></a>00102 <span class="keyword">    </span>{ <span class="keywordflow">return</span> Data.<a class="code" href="structCS_1_1Memory_1_1AllocatorPointerWrapper.html#e3861de7c5f1a38d76881b2b47b51fa2" title="The allocated pointer.">p</a>; }
<a name="l00103"></a>00103 
<a name="l00108"></a><a class="code" href="classCS_1_1DataBuffer.html#e5d6fcf7bb137d4cc1be7ecb9ef55707">00108</a>     <span class="keywordtype">bool</span> <a class="code" href="classCS_1_1DataBuffer.html#e5d6fcf7bb137d4cc1be7ecb9ef55707" title="Return true if this databuffer will destroy its memory on destruction.">GetDeleteOnDestruct</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> do_delete; }
<a name="l00109"></a>00109   };
<a name="l00110"></a>00110 } <span class="comment">// namespace CS</span>
<a name="l00111"></a>00111 
<a name="l00115"></a><a class="code" href="databuf_8h.html#ada2e693ab95cc4c7a622eef3f4f8ec6">00115</a> <span class="keyword">typedef</span> <a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">CS::DataBuffer&lt;CS::Memory::AllocatorNewChar&lt;false &gt;</a> &gt; <a class="code" href="classCS_1_1DataBuffer.html" title="This is an implementation of iDataBuffer interface.">csDataBuffer</a>;
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 <span class="preprocessor">#endif // __CS_DATABUF_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