Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vl::ZippedFile Class Reference

A VirtualFile used to read a file contained in a .zip archive. More...

#include <ZippedFile.hpp>

+ Inheritance diagram for vl::ZippedFile:

Public Member Functions

 ZippedFile ()
 
 ~ZippedFile ()
 
const ZippedFileInfozippedFileInfo () const
 
ZippedFileInfozippedFileInfo ()
 
void setZippedFileInfo (ZippedFileInfo *info)
 
virtual bool exists () const
 This returns true if zippedFileInfo() has been properly set up but does not check the existence of this file in the source zip file. More...
 
virtual bool open (EOpenMode mode)
 Opens the file in the specified mode. More...
 
virtual bool isOpen () const
 Returns true if the file has been opened. More...
 
virtual void close ()
 Closes the file. More...
 
virtual long long size () const
 Returns the size of the file in bytes. More...
 
bool extract (char *destination, bool check_sum=true)
 
ZippedFileoperator= (const ZippedFile &other)
 
virtual ref< VirtualFileclone () const
 Creates a clone of this class instance. More...
 
void resetStream ()
 
- Public Member Functions inherited from vl::VirtualFile
 VirtualFile ()
 Constructor. More...
 
unsigned int crc32 ()
 Computes the crc32 of the entire file. More...
 
MD5CheckSum md5 ()
 Computes the md5 of the entire file. More...
 
VirtualFileoperator= (const VirtualFile &other)
 
const Stringpath () const
 Returns the path of the file. More...
 
void setPath (const String &name)
 Changes the path bound to a VirtualFile. Use carefully this function, you shouldn't rename a VirtualFile managed by a VirtualDirectory. More...
 
long long peek (void *buffer, long long byte_count)
 Reads byte_count bytes and returns to the original position. More...
 
long long read (void *buffer, long long byte_count)
 Reads byte_count bytes from a file. Returns the number of bytes actually read. More...
 
long long write (const void *buffer, long long byte_count)
 Writes byte_count bytes to a file. Returns the number of bytes actually written. More...
 
long long position () const
 Returns the current position in the file. More...
 
bool seekSet (long long offset)
 Changes the current read/write position of a file. More...
 
bool seekCur (long long offset)
 Changes the current read/write position of a file. More...
 
bool seekEnd (long long offset)
 Changes the current read/write position of a file. More...
 
bool endOfFile () const
 Returns true if position() >= size() More...
 
long long load (std::vector< char > &data)
 Loads the entire file in the specified vector. More...
 
long long load (void *buffer, long long max=-1)
 Loads the entire file in the specified buffer. More...
 
double readDouble (bool little_endian_data=true)
 Reads single entry. More...
 
float readFloat (bool little_endian_data=true)
 Reads single entry. More...
 
unsigned long long readUInt64 (bool little_endian_data=true)
 Reads single entry. More...
 
long long readSInt64 (bool little_endian_data=true)
 Reads single entry. More...
 
unsigned int readUInt32 (bool little_endian_data=true)
 Reads single entry. More...
 
int readSInt32 (bool little_endian_data=true)
 Reads single entry. More...
 
unsigned short readUInt16 (bool little_endian_data=true)
 Reads single entry. More...
 
short readSInt16 (bool little_endian_data=true)
 Reads single entry. More...
 
unsigned char readUInt8 ()
 Reads single entry. More...
 
char readSInt8 ()
 Reads single entry. More...
 
long long readDouble (double *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readFloat (float *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readUInt64 (unsigned long long *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readSInt64 (long long *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readUInt32 (unsigned int *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readSInt32 (int *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readUInt16 (unsigned short *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readSInt16 (short *buffer, long long count, bool little_endian_data=true)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readUInt8 (unsigned char *buffer, long long count)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long readSInt8 (char *buffer, long long count)
 Reads multiple entries. Returns the number of bytes read. More...
 
long long writeDouble (double data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeFloat (float data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeUInt64 (unsigned long long data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeSInt64 (long long data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeUInt32 (unsigned int data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeSInt32 (int data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeUInt16 (unsigned short data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeSInt16 (short data, bool little_endian_data=true)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeUInt8 (unsigned char data)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeSInt8 (char data)
 Writes a single entry. Returns the number of bytes written. More...
 
long long writeDouble (const double *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeFloat (const float *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeUInt64 (const unsigned long long *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeSInt64 (const long long *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeUInt32 (const unsigned int *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeSInt32 (const int *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeUInt16 (const unsigned short *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeSInt16 (const short *buffer, long long count, bool little_endian_data=true)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeUInt8 (const unsigned char *buffer, long long count)
 Writes multiple entries. Returns the number of bytes written. More...
 
long long writeSInt8 (const char *buffer, long long count)
 Writes multiple entries. Returns the number of bytes written. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Member Functions

virtual long long read_Implementation (void *buffer, long long bytes_to_read)
 
virtual long long write_Implementation (const void *, long long)
 
virtual bool fillUncompressedBuffer ()
 
virtual long long position_Implementation () const
 
virtual bool seekSet_Implementation (long long)
 
- Protected Member Functions inherited from vl::VirtualFile
 VirtualFile (const VirtualFile &other)
 
long long write64 (const void *buffer, long long count, bool little_endian_data=true)
 
long long write32 (const void *buffer, long long count, bool little_endian_data=true)
 
long long write16 (const void *buffer, long long count, bool little_endian_data=true)
 
long long read64 (void *buffer, long long count, bool little_endian_data=true)
 
long long read32 (void *buffer, long long count, bool little_endian_data=true)
 
long long read16 (void *buffer, long long count, bool little_endian_data=true)
 
long long write64 (const void *buffer, bool little_endian_data=true)
 
long long write32 (const void *buffer, bool little_endian_data=true)
 
long long write16 (const void *buffer, bool little_endian_data=true)
 
long long read64 (void *buffer, bool little_endian_data=true)
 
long long read32 (void *buffer, bool little_endian_data=true)
 
long long read16 (void *buffer, bool little_endian_data=true)
 
- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Protected Attributes

ref< ZippedFileInfomZippedFileInfo
 
long long mReadBytes
 
z_stream_s * mZStream
 
unsigned char mZipBufferIn [CHUNK_SIZE]
 
unsigned char mZipBufferOut [CHUNK_SIZE]
 
std::vector< char > mUncompressedBuffer
 
int mUncompressedBufferPtr
 
- Protected Attributes inherited from vl::VirtualFile
String mPath
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Detailed Description

A VirtualFile used to read a file contained in a .zip archive.

See also

Definition at line 133 of file ZippedFile.hpp.

Constructor & Destructor Documentation

◆ ZippedFile()

ZippedFile::ZippedFile ( )

Definition at line 341 of file ZippedFile.cpp.

References mReadBytes, and mZStream.

Referenced by clone().

◆ ~ZippedFile()

ZippedFile::~ZippedFile ( )

Definition at line 348 of file ZippedFile.cpp.

References close(), mReadBytes, mZStream, and NULL.

Member Function Documentation

◆ clone()

ref< VirtualFile > ZippedFile::clone ( ) const
virtual

Creates a clone of this class instance.

Implements vl::VirtualFile.

Definition at line 682 of file ZippedFile.cpp.

References ZippedFile().

◆ close()

void ZippedFile::close ( )
virtual

◆ exists()

bool ZippedFile::exists ( ) const
virtual

This returns true if zippedFileInfo() has been properly set up but does not check the existence of this file in the source zip file.

To do so call ZippedDirectory::exists().

Implements vl::VirtualFile.

Definition at line 361 of file ZippedFile.cpp.

References vl::ZippedFileInfo::sourceZipFile(), zippedFileInfo(), and vl::ZippedFileInfo::zippedFileOffset().

◆ extract()

bool ZippedFile::extract ( char *  destination,
bool  check_sum = true 
)

◆ fillUncompressedBuffer()

bool ZippedFile::fillUncompressedBuffer ( )
protectedvirtual

◆ isOpen()

bool ZippedFile::isOpen ( ) const
virtual

Returns true if the file has been opened.

Implements vl::VirtualFile.

Definition at line 442 of file ZippedFile.cpp.

References mReadBytes.

Referenced by extract(), fillUncompressedBuffer(), open(), and read_Implementation().

◆ open()

bool ZippedFile::open ( EOpenMode  mode)
virtual

◆ operator=()

ZippedFile& vl::ZippedFile::operator= ( const ZippedFile other)
inline

◆ position_Implementation()

virtual long long vl::ZippedFile::position_Implementation ( ) const
inlineprotectedvirtual

Implements vl::VirtualFile.

Definition at line 189 of file ZippedFile.hpp.

◆ read_Implementation()

long long ZippedFile::read_Implementation ( void *  buffer,
long long  bytes_to_read 
)
protectedvirtual

◆ resetStream()

void ZippedFile::resetStream ( )

Definition at line 464 of file ZippedFile.cpp.

References close(), vl::OM_ReadOnly, and open().

Referenced by seekSet_Implementation().

◆ seekSet_Implementation()

bool ZippedFile::seekSet_Implementation ( long long  pos)
protectedvirtual

Implements vl::VirtualFile.

Definition at line 470 of file ZippedFile.cpp.

References vl::VirtualFile::position(), vl::VirtualFile::read(), and resetStream().

◆ setZippedFileInfo()

void ZippedFile::setZippedFileInfo ( ZippedFileInfo info)

Definition at line 359 of file ZippedFile.cpp.

References mZippedFileInfo.

Referenced by vl::ZippedDirectory::init().

◆ size()

long long ZippedFile::size ( ) const
virtual

Returns the size of the file in bytes.

Implements vl::VirtualFile.

Definition at line 456 of file ZippedFile.cpp.

References mZippedFileInfo.

◆ write_Implementation()

virtual long long vl::ZippedFile::write_Implementation ( const void *  ,
long long   
)
inlineprotectedvirtual

Implements vl::VirtualFile.

Definition at line 185 of file ZippedFile.hpp.

◆ zippedFileInfo() [1/2]

const ZippedFileInfo * ZippedFile::zippedFileInfo ( ) const

Definition at line 355 of file ZippedFile.cpp.

References mZippedFileInfo.

Referenced by close(), exists(), extract(), fillUncompressedBuffer(), open(), and read_Implementation().

◆ zippedFileInfo() [2/2]

ZippedFileInfo * ZippedFile::zippedFileInfo ( )

Definition at line 357 of file ZippedFile.cpp.

References mZippedFileInfo.

Member Data Documentation

◆ mReadBytes

long long vl::ZippedFile::mReadBytes
protected

◆ mUncompressedBuffer

std::vector<char> vl::ZippedFile::mUncompressedBuffer
protected

Definition at line 200 of file ZippedFile.hpp.

Referenced by close(), fillUncompressedBuffer(), open(), and read_Implementation().

◆ mUncompressedBufferPtr

int vl::ZippedFile::mUncompressedBufferPtr
protected

Definition at line 201 of file ZippedFile.hpp.

Referenced by close(), fillUncompressedBuffer(), open(), and read_Implementation().

◆ mZipBufferIn

unsigned char vl::ZippedFile::mZipBufferIn[CHUNK_SIZE]
protected

Definition at line 198 of file ZippedFile.hpp.

Referenced by fillUncompressedBuffer().

◆ mZipBufferOut

unsigned char vl::ZippedFile::mZipBufferOut[CHUNK_SIZE]
protected

Definition at line 199 of file ZippedFile.hpp.

Referenced by fillUncompressedBuffer().

◆ mZippedFileInfo

ref<ZippedFileInfo> vl::ZippedFile::mZippedFileInfo
protected

Definition at line 194 of file ZippedFile.hpp.

Referenced by operator=(), setZippedFileInfo(), size(), and zippedFileInfo().

◆ mZStream

z_stream_s* vl::ZippedFile::mZStream
protected

Definition at line 197 of file ZippedFile.hpp.

Referenced by close(), fillUncompressedBuffer(), open(), ZippedFile(), and ~ZippedFile().


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