IReadFile.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_READ_FILE_H_INCLUDED__
#define __I_READ_FILE_H_INCLUDED__

#include "IReferenceCounted.h"
#include "coreutil.h"

namespace irr
{
namespace io
{

    class IReadFile : public virtual IReferenceCounted
    {
    public:

        virtual s32 read(void* buffer, u32 sizeToRead) = 0;


        virtual bool seek(long finalPos, bool relativeMovement = false) = 0;


        virtual long getSize() const = 0;


        virtual long getPos() const = 0;


        virtual const io::path& getFileName() const = 0;
    };

    IReadFile* createReadFile(const io::path& fileName);
    IReadFile* createLimitReadFile(const io::path& fileName, IReadFile* alreadyOpenedFile, long pos, long areaSize);
    IReadFile* createMemoryReadFile(void* memory, long size, const io::path& fileName, bool deleteMemoryWhenDropped);

} // end namespace io
} // end namespace irr

#endif