cat::MMapFile Class Reference

#include <MMapFile.hpp>

List of all members.

Public Member Functions
u32	getOffset ()
bool	good ()
bool	inside ()
char *	look ()
char *	look (s32 offset)
	MMapFile (const char *path)
char *	read (s32 requested)
u32	remaining ()
void	seek (s32 poffset)
u32	size ()
void	skip (s32 requested)
bool	underrun (s32 requested)
	~MMapFile ()
Private Attributes
char *	data
u32	len
s32	offset

---

Detailed Description

Definition at line 41 of file MMapFile.hpp.

---

Constructor & Destructor Documentation

cat::MMapFile::MMapFile

(

const char *

path

)

cat::MMapFile::~MMapFile

(

)

---

Member Function Documentation

u32 cat::MMapFile::getOffset

(

)

[inline]

Definition at line 69 of file MMapFile.hpp.

References offset.

{ return offset; }

bool cat::MMapFile::good

(

)

[inline]

Definition at line 57 of file MMapFile.hpp.

References data.

{ return data != 0; }

bool cat::MMapFile::inside

(

)

[inline]

Definition at line 58 of file MMapFile.hpp.

References len, and offset.

{ return offset >= 0 && offset < (s32)len; }

char* cat::MMapFile::look

(

)

[inline]

Definition at line 64 of file MMapFile.hpp.

References data, and offset.

{ return data + offset; }

char* cat::MMapFile::look

(

s32

offset

)

[inline]

Definition at line 65 of file MMapFile.hpp.

References data, and offset.

{ return data + offset; }

char* cat::MMapFile::read

(

s32

requested

)

[inline]

Definition at line 66 of file MMapFile.hpp.

References data, and offset.

{ offset += requested; return data + (offset - requested); }

u32 cat::MMapFile::remaining

(

)

[inline]

Definition at line 68 of file MMapFile.hpp.

References len, and offset.

{ return len - offset; }

void cat::MMapFile::seek

(

s32

poffset

)

[inline]

Definition at line 62 of file MMapFile.hpp.

References offset.

{ offset = poffset; }

u32 cat::MMapFile::size

(

)

[inline]

Definition at line 60 of file MMapFile.hpp.

References len.

{ return len; }

void cat::MMapFile::skip

(

s32

requested

)

[inline]

Definition at line 67 of file MMapFile.hpp.

References offset.

{ offset += requested; }

bool cat::MMapFile::underrun

(

s32

requested

)

[inline]

Definition at line 63 of file MMapFile.hpp.

References len, and offset.

{ return (u32)(offset + requested) > len; }

---

Member Data Documentation

char* cat::MMapFile::data [private]

Definition at line 43 of file MMapFile.hpp.

Referenced by good(), look(), and read().

u32 cat::MMapFile::len [private]

Definition at line 44 of file MMapFile.hpp.

Referenced by inside(), remaining(), size(), and underrun().

s32 cat::MMapFile::offset [private]

Definition at line 45 of file MMapFile.hpp.

Referenced by getOffset(), inside(), look(), read(), remaining(), seek(), skip(), and underrun().

---

The documentation for this class was generated from the following file:

• MMapFile.hpp