/********************************************************************************
* *
* F i l e S t r e a m C l a s s *
* *
*********************************************************************************
* Copyright (C) 1997,2024 by Jeroen van der Zijp. All Rights Reserved. *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as published by *
* the Free Software Foundation; either version 3 of the License, or *
* (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public License *
* along with this program. If not, see *
********************************************************************************/
#ifndef FXFILESTREAM_H
#define FXFILESTREAM_H
#ifndef FXSTREAM_H
#include "FXStream.h"
#endif
namespace FX {
/// File Store Definition
class FXAPI FXFileStream : public FXStream {
protected:
FXFile file;
protected:
virtual FXuval writeBuffer(FXuval count);
virtual FXuval readBuffer(FXuval count);
private:
FXFileStream(const FXFileStream&);
FXFileStream& operator=(const FXFileStream&);
public:
/// Create file stream
FXFileStream(const FXObject* cont=nullptr);
/// Create and open file stream
FXFileStream(const FXString& filename,FXStreamDirection save_or_load=FXStreamLoad,FXuval size=8192UL);
/**
* Open binary data file stream; allocate a buffer of the given size
* for the file I/O; the buffer must be at least 16 bytes.
*/
FXbool open(const FXString& filename,FXStreamDirection save_or_load=FXStreamLoad,FXuval size=8192UL);
/// Close file stream
virtual FXbool close();
/// Get position
FXlong position() const { return FXStream::position(); }
/// Move to position
virtual FXbool position(FXlong offset,FXWhence whence=FXFromStart);
/// Save single items to stream
FXFileStream& operator<<(const FXuchar& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXchar& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXbool& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXushort& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXshort& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXuint& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXint& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXfloat& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXdouble& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXlong& v){ FXStream::operator<<(v); return *this; }
FXFileStream& operator<<(const FXulong& v){ FXStream::operator<<(v); return *this; }
/// Save arrays of items to stream
FXFileStream& save(const FXuchar* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXchar* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXbool* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXushort* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXshort* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXuint* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXint* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXfloat* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXdouble* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXlong* p,FXuval n){ FXStream::save(p,n); return *this; }
FXFileStream& save(const FXulong* p,FXuval n){ FXStream::save(p,n); return *this; }
/// Load single items from stream
FXFileStream& operator>>(FXuchar& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXchar& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXbool& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXushort& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXshort& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXuint& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXint& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXfloat& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXdouble& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXlong& v){ FXStream::operator>>(v); return *this; }
FXFileStream& operator>>(FXulong& v){ FXStream::operator>>(v); return *this; }
/// Load arrays of items from stream
FXFileStream& load(FXuchar* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXchar* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXbool* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXushort* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXshort* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXuint* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXint* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXfloat* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXdouble* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXlong* p,FXuval n){ FXStream::load(p,n); return *this; }
FXFileStream& load(FXulong* p,FXuval n){ FXStream::load(p,n); return *this; }
/// Save object
FXFileStream& saveObject(const FXObject* v){ FXStream::saveObject(v); return *this; }
/// Load object
FXFileStream& loadObject(FXObject*& v){ FXStream::loadObject(v); return *this; }
/// Load object
template
FXFileStream& operator>>(TYPE*& obj){ return loadObject(reinterpret_cast(obj)); }
/// Save object
template
FXFileStream& operator<<(const TYPE* obj){ return saveObject(static_cast(obj)); }
/// Destructor
virtual ~FXFileStream();
};
}
#endif