Torque2D Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Attributes | List of all members
ZipTempStream Class Reference
Zip Code » Zip Code Internals

`#include <zipTempStream.h>`

Inheritance diagram for ZipTempStream:

## Public Member Functions
| ZipTempStream ()
| ZipTempStream (CentralDir *cd)
void | setCentralDir (CentralDir *cd)
CentralDir * | getCentralDir ()
void | setDeleteOnClose (bool del)
virtual bool | open (const char *filename, AccessMode mode)
virtual bool | open ()
| Open a temporary file in ReadWrite mode. The file will be deleted when the stream is closed. More...
virtual void | close ()
virtual bool | setPosition (const U32 i_newPosition)
| Disallow setPosition() More...
bool | rewind ()
Public Member Functions inherited from FileStream
| FileStream ()
virtual | ~FileStream ()
virtual bool | hasCapability (const Capability i_cap) const
| Checks to see if this stream has the capability of a given function. More...
virtual U32 | getPosition () const
| Gets the position in the stream. More...
virtual U32 | getStreamSize ()
| Gets the size of the stream. More...
bool | Flush ()
Public Member Functions inherited from Stream
| Stream ()
virtual | ~Stream ()
Stream::Status | getStatus () const
| Gets the status of the stream. More...
void | readLine (U8 *buffer, U32 bufferSize)
void | writeLine (U8 *buffer)
| writes a line to the stream More...
const char * | readSTString (bool casesens=false)
virtual void | readString (char stringBuf[256])
| Reads a string of maximum 255 characters long. More...
void | readLongString (U32 maxStringLen, char *stringBuf)
void | writeLongString (U32 maxStringLen, const char *string)
bool | Put (char character)
virtual void | writeString (const char *stringBuf, S32 maxLen=255)
| Writes a string to the stream. More...
bool | writeFormattedBuffer (const char *format,...)
bool | writeStringBuffer (const char *buffer)
| Writes a NULL terminated string buffer. More...
bool | write (const ColorI &)
| Write an integral color to the stream. More...
bool | write (const ColorF &)
| Write a floating point color to the stream. More...
bool | read (ColorI *)
| Read an integral color from the stream. More...
bool | read (ColorF *)
| Read a floating point color from the stream. More...
bool | read (const U32 in_numBytes, void *out_pBuffer)
bool | write (const U32 in_numBytes, const void *in_pBuffer)
bool | read (bool *out_pRead)
bool | write (const bool &in_rWrite)
bool | copyFrom (Stream *other)
| Copy the contents of another stream into this one. More...
void | writeTabs (U32 count)
| Write a number of tabs to this stream. More...

## Protected Attributes
CentralDir * | mCD
bool | mDeleteOnClose
StringTableEntry | mFilename
Protected Attributes inherited from FileStream
File | mFile
U32 | mStreamCaps
U8 | mBuffer [BUFFER_SIZE]
U32 | mBuffHead
U32 | mBuffPos
U32 | mBuffTail
bool | mDirty
bool | mEOF

## Additional Inherited Members
Public Types inherited from FileStream
enum | AccessMode { Read = File::Read, Write = File::Write, ReadWrite = File::ReadWrite, WriteAppend = File::WriteAppend }
enum | { BUFFER_SIZE = 8 * 1024, BUFFER_INVALID = 0xffffffff }
Public Types inherited from Stream
enum | Status { Ok = 0, IOError, EOS, IllegalCall, Closed, UnknownError }
| Status constantants for the stream. More...
enum | Capability { StreamWrite = BIT(0), StreamRead = BIT(1), StreamPosition = BIT(2) }
Static Public Member Functions inherited from Stream
static const char * | getStatusString (const Status in_status)
| Gets a printable string form of the status. More...
Protected Member Functions inherited from FileStream
| FileStream (const FileStream &i_fileStrm)
FileStream & | operator= (const FileStream &i_fileStrm)
virtual bool | _read (const U32 i_numBytes, void *o_pBuffer)
virtual bool | _write (const U32 i_numBytes, const void *i_pBuffer)
void | init ()
bool | fillBuffer (const U32 i_startPosition)
void | clearBuffer ()
void | setStatus ()
Protected Member Functions inherited from Stream
void | setStatus (const Status in_newStatus)
Static Protected Member Functions inherited from FileStream
static void | calcBlockHead (const U32 i_position, U32 *o_blockHead)
static void | calcBlockBounds (const U32 i_position, U32 *o_blockHead, U32 *o_blockTail)

## Constructor & Destructor Documentation

ZipTempStream | ( |  | ) |
| inline

ZipTempStream | ( | CentralDir * | cd | ) |
| inline

## Member Function Documentation

virtual void close | ( | void |  | ) |
| inline virtual

Reimplemented from FileStream.

CentralDir* getCentralDir | ( |  | ) |
| inline

bool open | ( | const char * | filename,
|  | AccessMode | mode
| ) |  |
| virtual

Reimplemented from FileStream.

virtual bool open | ( |  | ) |
| inline virtual

Open a temporary file in ReadWrite mode. The file will be deleted when the stream is closed.

bool rewind | ( |  | ) |
| inline

Seek back to the start of the file. This is used internally by the zip code and should never be called whilst filters are attached (e.g. when reading or writing in a zip file)

void setCentralDir | ( | CentralDir * | cd | ) |
| inline

void setDeleteOnClose | ( | bool | del | ) |
| inline

virtual bool setPosition | ( | const U32 | i_newPosition | ) |
| inline virtual

Disallow setPosition()

Reimplemented from FileStream.

## Member Data Documentation

CentralDir* mCD
| protected

bool mDeleteOnClose
| protected

StringTableEntry mFilename
| protected

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

- io/zip/zipTempStream.h
- io/zip/zipTempStream.cc