2013-03-28 10:04:07 -07:00
|
|
|
// Copyright (C) 2002-2012 Nikolaus Gebhardt
|
2007-05-20 11:03:49 -07:00
|
|
|
// This file is part of the "Irrlicht Engine".
|
|
|
|
// For conditions of distribution and use, see copyright notice in irrlicht.h
|
|
|
|
|
2021-08-30 14:06:51 -07:00
|
|
|
#ifndef IRR_I_READ_FILE_H_INCLUDED
|
|
|
|
#define IRR_I_READ_FILE_H_INCLUDED
|
2007-05-20 11:03:49 -07:00
|
|
|
|
2007-09-06 23:11:47 -07:00
|
|
|
#include "IReferenceCounted.h"
|
2009-05-04 17:09:53 -07:00
|
|
|
#include "coreutil.h"
|
2019-04-23 13:17:39 -07:00
|
|
|
#include "EReadFileType.h"
|
2007-05-20 11:03:49 -07:00
|
|
|
|
|
|
|
namespace irr
|
|
|
|
{
|
|
|
|
namespace io
|
|
|
|
{
|
|
|
|
|
2017-03-13 07:54:20 -07:00
|
|
|
//! Interface providing read access to a file.
|
2007-09-06 23:11:47 -07:00
|
|
|
class IReadFile : public virtual IReferenceCounted
|
2007-05-20 11:03:49 -07:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
//! Reads an amount of bytes from the file.
|
2008-07-17 02:01:06 -07:00
|
|
|
/** \param buffer Pointer to buffer where read bytes are written to.
|
2008-05-22 04:51:37 -07:00
|
|
|
\param sizeToRead Amount of bytes to read from the file.
|
2009-09-16 05:48:19 -07:00
|
|
|
\return How many bytes were read. */
|
2017-03-13 07:54:20 -07:00
|
|
|
virtual size_t read(void* buffer, size_t sizeToRead) = 0;
|
2007-05-20 11:03:49 -07:00
|
|
|
|
2008-05-22 04:51:37 -07:00
|
|
|
//! Changes position in file
|
2008-07-17 02:01:06 -07:00
|
|
|
/** \param finalPos Destination position in the file.
|
|
|
|
\param relativeMovement If set to true, the position in the file is
|
2008-05-22 04:51:37 -07:00
|
|
|
changed relative to current position. Otherwise the position is changed
|
|
|
|
from beginning of file.
|
|
|
|
\return True if successful, otherwise false. */
|
2007-09-14 01:29:18 -07:00
|
|
|
virtual bool seek(long finalPos, bool relativeMovement = false) = 0;
|
2007-05-20 11:03:49 -07:00
|
|
|
|
2008-05-22 04:51:37 -07:00
|
|
|
//! Get size of file.
|
|
|
|
/** \return Size of the file in bytes. */
|
2007-09-17 09:09:50 -07:00
|
|
|
virtual long getSize() const = 0;
|
2007-05-20 11:03:49 -07:00
|
|
|
|
2008-05-22 04:51:37 -07:00
|
|
|
//! Get the current position in the file.
|
2017-08-30 06:20:12 -07:00
|
|
|
/** \return Current position in the file in bytes on success or -1L on failure. */
|
2007-09-17 09:09:50 -07:00
|
|
|
virtual long getPos() const = 0;
|
2007-05-20 11:03:49 -07:00
|
|
|
|
2008-05-22 04:51:37 -07:00
|
|
|
//! Get name of file.
|
|
|
|
/** \return File name as zero terminated character string. */
|
2009-09-16 05:48:19 -07:00
|
|
|
virtual const io::path& getFileName() const = 0;
|
2019-04-23 13:17:39 -07:00
|
|
|
|
|
|
|
//! Get the type of the class implementing this interface
|
|
|
|
virtual EREAD_FILE_TYPE getType() const
|
|
|
|
{
|
|
|
|
return EFIT_UNKNOWN;
|
|
|
|
}
|
2007-05-20 11:03:49 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
//! Internal function, please do not use.
|
2009-09-16 05:48:19 -07:00
|
|
|
IReadFile* createLimitReadFile(const io::path& fileName, IReadFile* alreadyOpenedFile, long pos, long areaSize);
|
2007-05-20 11:03:49 -07:00
|
|
|
|
|
|
|
} // end namespace io
|
|
|
|
} // end namespace irr
|
|
|
|
|
|
|
|
#endif
|