<!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/memfile.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 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 Pages</span></a></li>
</ul>
</div>
<h1>csutil/memfile.h</h1><a href="memfile_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) 2000 by Eric Sunshine <sunshine@sunshineco.com></span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_MEMFILE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_MEMFILE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00027"></a>00027 <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="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="vfs_8h.html" title="Virtual File System SCF interface.">iutil/vfs.h</a>"</span>
<a name="l00029"></a>00029
<a name="l00034"></a><a class="code" href="classcsMemFile.html">00034</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsMemFile.html" title="Essentially a raw memory buffer which implements the abstract iFile interface.">csMemFile</a> :
<a name="l00035"></a>00035 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csMemFile, iFile>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00039"></a><a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce50">00039</a> <span class="keyword">enum</span> <a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce50" title="Disposition of memory buffer at destruction time.">Disposition</a>
<a name="l00040"></a>00040 {
<a name="l00042"></a><a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce507b2b64c5023195c3d4e92938a20a68ac">00042</a> DISPOSITION_DELETE,
<a name="l00044"></a><a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce50c7360bd23be48ec6f746c1b4971674f3">00044</a> DISPOSITION_PLATFORM_FREE,
<a name="l00046"></a><a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce5081a32ce4afa53e52025da8f66f3d1dd3">00046</a> DISPOSITION_IGNORE,
<a name="l00048"></a><a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce504017a587daa25821475e97e019682961">00048</a> DISPOSITION_CS_FREE,
<a name="l00049"></a>00049 <span class="preprocessor"> #ifndef CS_NO_MALLOC_OVERRIDE</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span>
<a name="l00054"></a><a class="code" href="classcsMemFile.html#ab9cfa5b94ecee97a760b0c17418ce50d0be9f2517a6e4fae91477b16f1ce695">00054</a> DISPOSITION_FREE = DISPOSITION_CS_FREE
<a name="l00055"></a>00055 <span class="preprocessor"> #else</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span> DISPOSITION_FREE = DISPOSITION_PLATFORM_FREE
<a name="l00057"></a>00057 <span class="preprocessor"> #endif</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span> };
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">public</span>:
<a name="l00062"></a>00062 <a class="code" href="classcsMemFile.html" title="Essentially a raw memory buffer which implements the abstract iFile interface.">csMemFile</a>();
<a name="l00064"></a>00064 <a class="code" href="classcsMemFile.html" title="Essentially a raw memory buffer which implements the abstract iFile interface.">csMemFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">size_t</span>);
<a name="l00070"></a>00070 <a class="code" href="classcsMemFile.html" title="Essentially a raw memory buffer which implements the abstract iFile interface.">csMemFile</a>(<span class="keywordtype">char</span>*, <span class="keywordtype">size_t</span>, Disposition = DISPOSITION_DELETE);
<a name="l00080"></a>00080 <a class="code" href="classcsMemFile.html" title="Essentially a raw memory buffer which implements the abstract iFile interface.">csMemFile</a>(<a class="code" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>* buf, <span class="keywordtype">bool</span> readOnly);
<a name="l00082"></a>00082 <span class="keyword">virtual</span> ~<a class="code" href="classcsMemFile.html" title="Essentially a raw memory buffer which implements the abstract iFile interface.">csMemFile</a>();
<a name="l00083"></a>00083
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetName();
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetSize();
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetStatus();
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Read(<span class="keywordtype">char</span>* Data, <span class="keywordtype">size_t</span> DataSize);
<a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Write(<span class="keyword">const</span> <span class="keywordtype">char</span>* Data, <span class="keywordtype">size_t</span> DataSize);
<a name="l00091"></a>00091 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Flush();
<a name="l00092"></a>00092 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> AtEOF();
<a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetPos();
<a name="l00094"></a>00094 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetPos(<span class="keywordtype">size_t</span> newpos);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iDataBuffer></a> GetAllData (<span class="keywordtype">bool</span> nullterm = <span class="keyword">false</span>);
<a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetData() <span class="keyword">const</span>;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">protected</span>:
<a name="l00104"></a><a class="code" href="classcsMemFile.html#64e0a76f41f3b92c9b0f068b561f97ee">00104</a> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iDataBuffer></a> buffer;
<a name="l00105"></a><a class="code" href="classcsMemFile.html#0c50f4e74ff716dce9131f0d3d09e3c3">00105</a> <span class="keywordtype">size_t</span> size;
<a name="l00106"></a><a class="code" href="classcsMemFile.html#7b27083d2cca70d0311db7ed7acde6bb">00106</a> <span class="keywordtype">size_t</span> cursor;
<a name="l00107"></a><a class="code" href="classcsMemFile.html#521513b3db6cbfa910523d056cdbd932">00107</a> <span class="keywordtype">bool</span> copyOnWrite;
<a name="l00108"></a>00108 };
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor">#endif // __CS_MEMFILE_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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2005
