fox-toolkit.org - Documentation

00001 /********************************************************************************
00002 *                                                                               *
00003 *                       F i l e   S t r e a m   C l a s s                       *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 1997,2006 by Jeroen van der Zijp.   All Rights Reserved.        *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 *********************************************************************************
00022 * $Id: FXFileStream.h,v 1.15 2006/01/22 17:58:01 fox Exp $                      *
00023 ********************************************************************************/
00024 #ifndef FXFILESTREAM_H
00025 #define FXFILESTREAM_H
00026 
00027 #ifndef FXSTREAM_H
00028 #include "FXStream.h"
00029 #endif
00030 
00031 namespace FX {
00032 
00033 
00034 /// File Store Definition
00035 class FXAPI FXFileStream : public FXStream {
00036 protected:
00037   FXFile file;
00038 protected:
00039   virtual FXuval writeBuffer(FXuval count);
00040   virtual FXuval readBuffer(FXuval count);
00041 public:
00042 
00043   /// Create file store
00044   FXFileStream(const FXObject* cont=NULL);
00045 
00046   /**
00047   * Open binary data file stream; allocate a buffer of the given size
00048   * for the file I/O; the buffer must be at least 16 bytes.
00049   */
00050   bool open(const FXString& filename,FXStreamDirection save_or_load,FXuval size=8192);
00051 
00052   /// Close file store
00053   virtual bool close();
00054 
00055   /// Get position
00056   FXlong position() const { return FXStream::position(); }
00057 
00058   /// Move to position
00059   virtual bool position(FXlong offset,FXWhence whence=FXFromStart);
00060 
00061   /// Save single items to stream
00062   FXFileStream& operator<<(const FXuchar& v){ FXStream::operator<<(v); return *this; }
00063   FXFileStream& operator<<(const FXchar& v){ FXStream::operator<<(v); return *this; }
00064   FXFileStream& operator<<(const FXushort& v){ FXStream::operator<<(v); return *this; }
00065   FXFileStream& operator<<(const FXshort& v){ FXStream::operator<<(v); return *this; }
00066   FXFileStream& operator<<(const FXuint& v){ FXStream::operator<<(v); return *this; }
00067   FXFileStream& operator<<(const FXint& v){ FXStream::operator<<(v); return *this; }
00068   FXFileStream& operator<<(const FXfloat& v){ FXStream::operator<<(v); return *this; }
00069   FXFileStream& operator<<(const FXdouble& v){ FXStream::operator<<(v); return *this; }
00070   FXFileStream& operator<<(const FXlong& v){ FXStream::operator<<(v); return *this; }
00071   FXFileStream& operator<<(const FXulong& v){ FXStream::operator<<(v); return *this; }
00072 
00073   /// Save arrays of items to stream
00074   FXFileStream& save(const FXuchar* p,FXuval n){ FXStream::save(p,n); return *this; }
00075   FXFileStream& save(const FXchar* p,FXuval n){ FXStream::save(p,n); return *this; }
00076   FXFileStream& save(const FXushort* p,FXuval n){ FXStream::save(p,n); return *this; }
00077   FXFileStream& save(const FXshort* p,FXuval n){ FXStream::save(p,n); return *this; }
00078   FXFileStream& save(const FXuint* p,FXuval n){ FXStream::save(p,n); return *this; }
00079   FXFileStream& save(const FXint* p,FXuval n){ FXStream::save(p,n); return *this; }
00080   FXFileStream& save(const FXfloat* p,FXuval n){ FXStream::save(p,n); return *this; }
00081   FXFileStream& save(const FXdouble* p,FXuval n){ FXStream::save(p,n); return *this; }
00082   FXFileStream& save(const FXlong* p,FXuval n){ FXStream::save(p,n); return *this; }
00083   FXFileStream& save(const FXulong* p,FXuval n){ FXStream::save(p,n); return *this; }
00084 
00085   /// Load single items from stream
00086   FXFileStream& operator>>(FXuchar& v){ FXStream::operator>>(v); return *this; }
00087   FXFileStream& operator>>(FXchar& v){ FXStream::operator>>(v); return *this; }
00088   FXFileStream& operator>>(FXushort& v){ FXStream::operator>>(v); return *this; }
00089   FXFileStream& operator>>(FXshort& v){ FXStream::operator>>(v); return *this; }
00090   FXFileStream& operator>>(FXuint& v){ FXStream::operator>>(v); return *this; }
00091   FXFileStream& operator>>(FXint& v){ FXStream::operator>>(v); return *this; }
00092   FXFileStream& operator>>(FXfloat& v){ FXStream::operator>>(v); return *this; }
00093   FXFileStream& operator>>(FXdouble& v){ FXStream::operator>>(v); return *this; }
00094   FXFileStream& operator>>(FXlong& v){ FXStream::operator>>(v); return *this; }
00095   FXFileStream& operator>>(FXulong& v){ FXStream::operator>>(v); return *this; }
00096 
00097   /// Load arrays of items from stream
00098   FXFileStream& load(FXuchar* p,FXuval n){ FXStream::load(p,n); return *this; }
00099   FXFileStream& load(FXchar* p,FXuval n){ FXStream::load(p,n); return *this; }
00100   FXFileStream& load(FXushort* p,FXuval n){ FXStream::load(p,n); return *this; }
00101   FXFileStream& load(FXshort* p,FXuval n){ FXStream::load(p,n); return *this; }
00102   FXFileStream& load(FXuint* p,FXuval n){ FXStream::load(p,n); return *this; }
00103   FXFileStream& load(FXint* p,FXuval n){ FXStream::load(p,n); return *this; }
00104   FXFileStream& load(FXfloat* p,FXuval n){ FXStream::load(p,n); return *this; }
00105   FXFileStream& load(FXdouble* p,FXuval n){ FXStream::load(p,n); return *this; }
00106   FXFileStream& load(FXlong* p,FXuval n){ FXStream::load(p,n); return *this; }
00107   FXFileStream& load(FXulong* p,FXuval n){ FXStream::load(p,n); return *this; }
00108 
00109   /// Save object
00110   FXFileStream& saveObject(const FXObject* v){ FXStream::saveObject(v); return *this; }
00111 
00112   /// Load object
00113   FXFileStream& loadObject(FXObject*& v){ FXStream::loadObject(v); return *this; }
00114 
00115   /// Destructor
00116   virtual ~FXFileStream();
00117   };
00118 
00119 }
00120 
00121 #endif