E:/Programming/MyProject/K_Game_hg/GameEngine/include/resource/DataStream.h

Go to the documentation of this file.

// Copyright 2006-2011 by Kat'Oun

#ifndef _DATA_STREAM_H_
#define _DATA_STREAM_H_

#include <EngineConfig.h>
#include <core/Types.h>

#include <string>

namespace platform
{
class File;
}

namespace resource
{

#define GAME_STREAM_TEMP_SIZE 128

class ENGINE_PUBLIC_EXPORT DataStream
{
public:

        DataStream();
        virtual ~DataStream();

        virtual u32 read(void* buffer, u32 size) = 0;
        virtual u32 read(void* buffer, u32 size, u32 count) = 0;

        virtual u32 readLine(char* buffer, u32 size, const std::string& delim = "\n");

        virtual std::string getLine(bool trimAfter = true);

        virtual u32 skipLine(const std::string& delim = "\n");

        virtual void seek(u32 pos) = 0;

        virtual void skip(s32 offset) = 0;

        virtual u32 tell() const = 0;

        virtual bool eof() = 0;

        u32 size() const;

protected:
        
        u32 mSize;
};

class ENGINE_PUBLIC_EXPORT MemoryDataStream: public DataStream
{
public:

        MemoryDataStream(void* mem, u32 size, bool freeOnClose = false);
        MemoryDataStream(DataStream& sourceStream, bool freeOnClose = true);
        MemoryDataStream(u32 size, bool freeOnClose = true);
        ~MemoryDataStream();

        u8* getPtr();

        u8* getCurrentPtr();

        u32 read(void* buffer, u32 size);
        u32 read(void* buffer, u32 size, u32 count);

        u32 readLine(c8* buffer, u32 size, const std::string& delim = "\n");

        u32 skipLine(const std::string& delim = "\n");

        void seek(u32 pos);

        void skip(s32 offset);

        u32 tell() const;

        bool eof();

        void close();

protected:

        u8* mData;                      // Pointer to the start of the data area
        u8* mPos;                       // Pointer to the current position in the memory
        u8* mEnd;                       // Pointer to the end of the memory
        bool mFreeOnClose;      // Do we delete the memory on close
};

class ENGINE_PUBLIC_EXPORT FileDataStream: public DataStream
{
public:

        FileDataStream(const std::string& fileName);
        ~FileDataStream();

        u32 read(void* buffer, u32 size);
        u32 read(void* buffer, u32 size, u32 count);

        void seek(u32 pos);

        void skip(s32 offset);

        u32 tell() const;

        bool eof();

protected:

        platform::File* mFile;  // Pointer to the file
};

}// end namespace resource

#endif