<html>
<head>
<link rel="stylesheet" href="page.css" type="text/css">
<title>fox-toolkit.org - Documentation</title>
</head>
<body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000>
<font face='verdana,sans-serif' size=2 >
<!---- TOPIC TITLE WITH LOGO--->
<table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a>
<br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table>
<p>
<!--- TOPIC TITLE WITH LOGO --->
<!-- Generated by Doxygen 1.3.3 -->
<h1>FXFileStream.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* F i l e S t r e a m C l a s s *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 1997,2004 by Jeroen van der Zijp. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXFileStream.h,v 1.5 2004/02/08 17:17:33 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXFILESTREAM_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXFILESTREAM_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXSTREAM_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXStream.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>FX {
00032
00033 <span class="comment"></span>
00034 <span class="comment">/// File Store Definition</span>
<a name="l00035"></a><a class="code" href="classFX_1_1FXFileStream.html">00035</a> <span class="comment"></span><span class="keyword">class </span>FXAPI FXFileStream : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXStream.html">FXStream</a> {
00036 <span class="keyword">private</span>:
00037 FXint file;
00038 <span class="keyword">protected</span>:
00039 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> writeBuffer(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> count);
00040 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> readBuffer(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> count);
00041 <span class="keyword">public</span>:
00042 <span class="comment"></span>
00043 <span class="comment"> /// Create file store</span>
00044 <span class="comment"></span> FXFileStream(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXObject.html">FXObject</a>* cont=NULL);
00045 <span class="comment"></span>
00046 <span class="comment"> /**</span>
00047 <span class="comment"> * Open binary data file stream; allocate a buffer of the given size</span>
00048 <span class="comment"> * for the file I/O; the buffer must be at least 16 bytes.</span>
00049 <span class="comment"> */</span>
00050 FXbool open(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& filename,<a class="code" href="group__FXStream__0.html#a0">FXStreamDirection</a> save_or_load,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> size=8192);
00051 <span class="comment"></span>
00052 <span class="comment"> /// Close file store</span>
00053 <span class="comment"></span> <span class="keyword">virtual</span> FXbool close();
<a name="l00054"></a><a class="code" href="classFX_1_1FXFileStream.html#a4">00054</a> <span class="comment"></span>
00055 <span class="comment"> /// Move to position</span>
00056 <span class="comment"></span> <span class="keyword">virtual</span> FXbool position(<span class="keywordtype">long</span> offset,FXWhence whence=FXFromStart);
00057 <span class="comment"></span>
00058 <span class="comment"> /// Save single items to stream</span>
00059 <span class="comment"></span> FXFileStream& operator<<(<span class="keyword">const</span> FXuchar& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00060 FXFileStream& operator<<(<span class="keyword">const</span> FXchar& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00061 FXFileStream& operator<<(<span class="keyword">const</span> FXushort& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00062 FXFileStream& operator<<(<span class="keyword">const</span> FXshort& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00063 FXFileStream& operator<<(<span class="keyword">const</span> FXuint& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00064 FXFileStream& operator<<(<span class="keyword">const</span> FXint& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00065 FXFileStream& operator<<(<span class="keyword">const</span> FXfloat& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00066 FXFileStream& operator<<(<span class="keyword">const</span> FXdouble& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00067 <span class="preprocessor">#ifdef FX_LONG</span>
<a name="l00068"></a><a class="code" href="classFX_1_1FXFileStream.html#a12">00068</a> <span class="preprocessor"></span> FXFileStream& operator<<(<span class="keyword">const</span> FXlong& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00069 FXFileStream& operator<<(<span class="keyword">const</span> FXulong& v){ FXStream::operator<<(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00070 <span class="preprocessor">#endif</span>
00071 <span class="preprocessor"></span><span class="comment"></span>
00072 <span class="comment"> /// Save arrays of items to stream</span>
00073 <span class="comment"></span> FXFileStream& save(<span class="keyword">const</span> FXuchar* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00074 FXFileStream& save(<span class="keyword">const</span> FXchar* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00075 FXFileStream& save(<span class="keyword">const</span> FXushort* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00076 FXFileStream& save(<span class="keyword">const</span> FXshort* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00077 FXFileStream& save(<span class="keyword">const</span> FXuint* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00078 FXFileStream& save(<span class="keyword">const</span> FXint* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00079 FXFileStream& save(<span class="keyword">const</span> FXfloat* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00080 FXFileStream& save(<span class="keyword">const</span> FXdouble* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00081 <span class="preprocessor">#ifdef FX_LONG</span>
<a name="l00082"></a><a class="code" href="classFX_1_1FXFileStream.html#a20">00082</a> <span class="preprocessor"></span> FXFileStream& save(<span class="keyword">const</span> FXlong* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00083 FXFileStream& save(<span class="keyword">const</span> FXulong* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::save(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00084 <span class="preprocessor">#endif</span>
00085 <span class="preprocessor"></span><span class="comment"></span>
00086 <span class="comment"> /// Load single items from stream</span>
00087 <span class="comment"></span> FXFileStream& operator>>(FXuchar& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00088 FXFileStream& operator>>(FXchar& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00089 FXFileStream& operator>>(FXushort& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00090 FXFileStream& operator>>(FXshort& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00091 FXFileStream& operator>>(FXuint& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00092 FXFileStream& operator>>(FXint& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00093 FXFileStream& operator>>(FXfloat& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00094 FXFileStream& operator>>(FXdouble& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00095 <span class="preprocessor">#ifdef FX_LONG</span>
<a name="l00096"></a><a class="code" href="classFX_1_1FXFileStream.html#a28">00096</a> <span class="preprocessor"></span> FXFileStream& operator>>(FXlong& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00097 FXFileStream& operator>>(FXulong& v){ FXStream::operator>>(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00098 <span class="preprocessor">#endif</span>
00099 <span class="preprocessor"></span><span class="comment"></span>
00100 <span class="comment"> /// Load arrays of items from stream</span>
00101 <span class="comment"></span> FXFileStream& load(FXuchar* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00102 FXFileStream& load(FXchar* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00103 FXFileStream& load(FXushort* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00104 FXFileStream& load(FXshort* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00105 FXFileStream& load(FXuint* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00106 FXFileStream& load(FXint* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00107 FXFileStream& load(FXfloat* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00108 FXFileStream& load(FXdouble* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00109 <span class="preprocessor">#ifdef FX_LONG</span>
<a name="l00110"></a><a class="code" href="classFX_1_1FXFileStream.html#a36">00110</a> <span class="preprocessor"></span> FXFileStream& load(FXlong* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00111 FXFileStream& load(FXulong* p,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n){ FXStream::load(p,n); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00112 <span class="preprocessor">#endif</span>
<a name="l00113"></a><a class="code" href="classFX_1_1FXFileStream.html#a37">00113</a> <span class="preprocessor"></span><span class="comment"></span>
00114 <span class="comment"> /// Save object</span>
00115 <span class="comment"></span> FXFileStream& saveObject(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXObject.html">FXObject</a>* v){ FXStream::saveObject(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00116 <span class="comment"></span>
00117 <span class="comment"> /// Load object</span>
00118 <span class="comment"></span> FXFileStream& loadObject(FXObject*& v){ FXStream::loadObject(v); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00119 <span class="comment"></span>
00120 <span class="comment"> /// Destructor</span>
00121 <span class="comment"></span> <span class="keyword">virtual</span> ~FXFileStream();
00122 };
00123
00124 }
00125
00126 <span class="preprocessor">#endif</span>
</pre></div></font>
<!--- COPYRIGHT -->
<p>
<table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right>
<img src='../art/line.gif' width=100% height=1><font size=-1>
Copyright © 1997-2004 Jeroen van der Zijp</font>
</td></tr></table>
</p>
<!--- COPYRIGHT -->
</body>
</html>
