vbufferedfilestream.h

Go to the documentation of this file.

/*
Copyright c1997-2014 Trygve Isaacson. All rights reserved.
This file is part of the Code Vault version 4.1
http://www.bombaydigital.com/
License: MIT. See LICENSE.md in the Vault top level directory.
*/

#ifndef vbufferedfilestream_h
#define vbufferedfilestream_h

#include "vabstractfilestream.h"

class VFSNode;

class VBufferedFileStream : public VAbstractFileStream {
    public:

        VBufferedFileStream();
        VBufferedFileStream(const VFSNode& node);
        VBufferedFileStream(FILE* f, bool closeOnDestruct);
        virtual ~VBufferedFileStream();

        void setFile(FILE* f, bool closeOnDestruct);

        // Implementation of VAbstractFileStream -----------------------------

        virtual void openReadOnly();
        virtual void openReadWrite();
        virtual void openWrite();
        virtual bool isOpen() const;
        virtual void close();

        // Implementation of VStream -----------------------------------------

        virtual Vs64 read(Vu8* targetBuffer, Vs64 numBytesToRead);
        virtual Vs64 write(const Vu8* buffer, Vs64 numBytesToWrite);
        virtual void flush();
        virtual bool skip(Vs64 numBytesToSkip);
        virtual bool seek(Vs64 offset, int whence);
        virtual Vs64 getIOOffset() const;
        virtual Vs64 available() const;

    private:

        // Prevent copy construction and assignment, since there is no provision for sharing the mFile pointer.
        VBufferedFileStream(const VBufferedFileStream& other);
        VBufferedFileStream& operator=(const VBufferedFileStream& other);

        FILE*   mFile;              
        bool    mCloseOnDestruct;   

};

#endif /* vbufferedfilestream_h */