Drag[en]gine Game Engine
1.21
|
Weak file reader. More...
#include <decWeakFileReader.h>
Public Types | |
typedef deTObjectReference< decWeakFileReader > | Ref |
Type holding strong reference. More... | |
Public Types inherited from decBaseFileReader | |
typedef deTObjectReference< decBaseFileReader > | Ref |
Type holding strong reference. More... | |
Public Types inherited from deObject | |
typedef deTObjectReference< deObject > | Ref |
Type holding strong reference. More... | |
Public Member Functions | |
Management | |
bool | IsValid () const |
Wrapped reader is valid. More... | |
void | DropReader () |
Drop wrapped reader if not dropped already. More... | |
virtual const char * | GetFilename () |
Name of the file. More... | |
virtual int | GetLength () |
Length of the file. More... | |
virtual TIME_SYSTEM | GetModificationTime () |
Modification time. More... | |
virtual int | GetPosition () |
Current reading position in the file. More... | |
virtual void | SetPosition (int position) |
Set file position for the next read action. More... | |
virtual void | MovePosition (int offset) |
Move file position by the given offset. More... | |
virtual void | SetPositionEnd (int position) |
Set file position to the given position measured from the end of the file. More... | |
virtual void | Read (void *buffer, int size) |
Read size bytes into buffer and advances the file pointer. More... | |
virtual decBaseFileReader::Ref | Duplicate () |
Duplicate file reader. More... | |
Public Member Functions inherited from decBaseFileReader | |
bool | IsEOF () |
File pointer is at the end of the file. More... | |
int8_t | ReadChar () |
Read one byte and advances the file pointer. More... | |
uint8_t | ReadByte () |
Read one unsigned byte and advances the file pointer. More... | |
int16_t | ReadShort () |
Read one short integer (2 bytes) and advances the file pointer. More... | |
uint16_t | ReadUShort () |
Read one unsigned short integer (2 bytes) and advances the file pointer. More... | |
int32_t | ReadInt () |
Read one integer (4 bytes) and advances the file pointer. More... | |
uint32_t | ReadUInt () |
Read one unsigned integer (4 bytes) and advances the file pointer. More... | |
int64_t | ReadLong () |
Read one integer (8 bytes) and advances the file pointer. More... | |
uint64_t | ReadULong () |
Read one unsigned integer (8 bytes) and advances the file pointer. More... | |
float | ReadFloat () |
Read one float (4 bytes) and advances the file pointer. More... | |
double | ReadDouble () |
Read one double (8 bytes) and advances the file pointer. More... | |
decString | ReadString8 () |
Read a string prefixed by a 1-byte length field and advances the file pointer. More... | |
void | ReadString8Into (decString &string) |
Read string prefixed by a 1-byte length field and advances the file pointer. More... | |
decString | ReadString16 () |
Read a string prefixed by a 2-byte2 length field and advances the file pointer. More... | |
void | ReadString16Into (decString &string) |
Read string prefixed by a 2-byte2 length field and advances the file pointer. More... | |
decVector | ReadVector () |
Read a 3-float vector and advances the file pointer. More... | |
void | ReadVectorInto (decVector &vector) |
Read a 3-float vector and advances the file pointer. More... | |
decVector2 | ReadVector2 () |
Read a 2-float vector and advances the file pointer. More... | |
void | ReadVector2Into (decVector2 &vector) |
Read a 2-float vector and advances the file pointer. More... | |
decQuaternion | ReadQuaternion () |
Read a 4-float quaternion and advances the file pointer. More... | |
void | ReadQuaternionInto (decQuaternion &quaternion) |
Read a 4-float quaternion and advances the file pointer. More... | |
decPoint | ReadPoint () |
Read a 2-int point and advances the file pointer. More... | |
void | ReadPointInto (decPoint &point) |
Read a 2-int point and advances the file pointer. More... | |
decPoint3 | ReadPoint3 () |
Read a 3-int point and advances the file pointer. More... | |
void | ReadPoint3Into (decPoint3 &point) |
Read a 3-int point and advances the file pointer. More... | |
decDVector | ReadDVector () |
Read a 3-double vector and advances the file pointer. More... | |
void | ReadDVectorInto (decDVector &vector) |
Read a 3-double vector and advances the file pointer. More... | |
decColor | ReadColor () |
Read a 4-component color and advances the file pointer. More... | |
void | ReadColorInto (decColor &color) |
Read a 4-component color and advances the file pointer. More... | |
decColor | ReadColor3 () |
Read a 3-component color and advances the file pointer. More... | |
void | ReadColor3Into (decColor &color) |
Read a 3-component color and advances the file pointer. More... | |
void | SkipChar () |
Skip one byte and advances the file pointer. More... | |
void | SkipByte () |
Skip one unsigned byte and advances the file pointer. More... | |
void | SkipShort () |
Skip one short integer (2 bytes) and advances the file pointer. More... | |
void | SkipUShort () |
Skip one unsigned short integer (2 bytes) and advances the file pointer. More... | |
void | SkipInt () |
Skip one integer (4 bytes) and advances the file pointer. More... | |
void | SkipUInt () |
Skip one unsigned integer (4 bytes) and advances the file pointer. More... | |
void | SkipLong () |
Skip one integer (8 bytes) and advances the file pointer. More... | |
void | SkipULong () |
Skip one unsigned integer (8 bytes) and advances the file pointer. More... | |
void | SkipFloat () |
Skip one float (4 bytes) and advances the file pointer. More... | |
void | SkipDouble () |
Skip one double (8 bytes) and advances the file pointer. More... | |
void | SkipString8 () |
Skip a string prefixed by a 1-byte length field and advances the file pointer. More... | |
void | SkipString16 () |
Skip a string prefixed by a 2-byte2 length field and advances the file pointer. More... | |
void | SkipVector () |
Skip a 3-float vector and advances the file pointer. More... | |
void | SkipVector2 () |
Skip a 2-float vector and advances the file pointer. More... | |
void | SkipQuaternion () |
Skip a 4-float quaternion and advances the file pointer. More... | |
void | SkipPoint () |
Skip a 2-int point and advances the file pointer. More... | |
void | SkipPoint3 () |
Skip a 3-int point and advances the file pointer. More... | |
void | SkipDVector () |
Skip a 3-double vector and advances the file pointer. More... | |
void | SkipColor () |
Skip a 4-component color and advances the file pointer. More... | |
void | SkipColor3 () |
Skip a 3-component color and advances the file pointer. More... | |
decBaseFileReader () | |
Create file reader. More... | |
Public Member Functions inherited from deObject | |
int | GetRefCount () const |
Reference count. More... | |
void | AddReference () |
Add reference increasing reference count by 1. More... | |
void | FreeReference () |
Decrease reference count by one and delete object if count reaches 0. More... | |
deObject () | |
Create object with reference count of 1. More... | |
Constructors and Destructors | |
decWeakFileReader (decBaseFileReader *reader) | |
Create weak file reader. More... | |
virtual | ~decWeakFileReader () |
Close file and cleans up. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from decBaseFileReader | |
virtual | ~decBaseFileReader () |
Clean up file reader. More... | |
Protected Member Functions inherited from deObject | |
virtual | ~deObject () |
Clean up object. More... | |
Weak file reader.
Weak wraps a file reader. The wrapped file reader can be dropped any time causing all future operations to fail. This is used for readers created by engine modules to avoid problems if the engine module is unloaded while the reader is still held.
Type holding strong reference.
decWeakFileReader::decWeakFileReader | ( | decBaseFileReader * | reader | ) |
Create weak file reader.
[in] | reader | Reader to wrap. |
deeInvalidParam | reader is NULL. |
|
protectedvirtual |
Close file and cleans up.
void decWeakFileReader::DropReader | ( | ) |
Drop wrapped reader if not dropped already.
|
virtual |
Duplicate file reader.
Implements decBaseFileReader.
|
virtual |
Name of the file.
Implements decBaseFileReader.
|
virtual |
Length of the file.
Implements decBaseFileReader.
|
virtual |
Modification time.
Implements decBaseFileReader.
|
virtual |
Current reading position in the file.
Implements decBaseFileReader.
bool decWeakFileReader::IsValid | ( | ) | const |
Wrapped reader is valid.
If false is returned any future operations will fail.
|
virtual |
Move file position by the given offset.
Implements decBaseFileReader.
|
virtual |
Read size bytes into buffer and advances the file pointer.
deeInvalidParam | buffer is NULL. |
deeInvalidParam | size is less than 1. |
deeInvalidParam | Error decompressing content. |
Implements decBaseFileReader.
|
virtual |
Set file position for the next read action.
Implements decBaseFileReader.
|
virtual |
Set file position to the given position measured from the end of the file.
Implements decBaseFileReader.