zipios Namespace Reference

Classes
class  BackBuffer
	A BackBuffer instance is useful for reading the last part of a file in an efficient manner, when it is not known exactly how far back (towards the front!) to go, to find the start of the desired data block. More...
class  BasicEntry
	BasicEntry is a FileEntry that is suitable as a base class for basic entries, that e.g. More...
class  CollectionCollection
struct  DataDescriptor
	A struct containing fields for the entries in a zip file data descriptor, that trails the compressed data in files that were created by streaming, ie where the zip compressor cannot seek back to the local header and store the data. More...
class  DeflateOutputStreambuf
	DeflateOutputStreambuf is an output stream filter, that deflates the data that is written to it before it passes it on to the output stream it is attached to. More...
class  DirectoryCollection
class  EndOfCentralDirectory
	The end of the Central directory structure. More...
class  Exception
	Basic exception. More...
class  FCollException
	An FCollException is used to signal a problem with a FileCollection. More...
class  FileCollection
class  FileEntry
	A FileEntry represents an entry in a FileCollection. More...
class  FilePath
	FilePath represents a path to a file or directory name. More...
class  FilterInputStreambuf
	An input streambuf filter is a streambuf that filters the input it gets from the streambuf it is attached to. More...
class  FilterOutputStreambuf
	A FilterOutputStreambuf is a streambuf that filters the data that is written to it before it passes it on to the output streambuf it is connected to. More...
class  GZIPOutputStream
class  GZIPOutputStreambuf
	GZIPOutputStreambuf is a zip output streambuf filter. More...
class  InflateInputStreambuf
	InflateInputStreambuf is an input stream filter, that inflates the input from the attached input stream. More...
class  InvalidStateException
	An object member function may throw this exception, if the operation it normally performs is inappropriate or impossible to perform because of the current state of the object. More...
class  IOException
	An IOException is used to signal an I/O error. More...
class  OutputStringStream
	OutputStringStream is typedefed to ostringstream if sstream is part of the standard library (unless Zipios++ has been explicitly configured not to use it). More...
class  ReferenceCount
	ReferenceCount is useful to ensure proper handling of the reference count for (objects of) classes handled through a SimpleSmartPointer. More...
class  SimpleSmartPointer
	SimpleSmartPointer is a simple reference counting smart pointer template. More...
class  VirtualSeeker
	VirtualSeeker is a simple class that keeps track of a set of specified 'virtual' file endings that mark a subset of a real file. More...
class  ZipCDirEntry
	Specialization of ZipLocalEntry, that add fields for storing the extra information, that is only present in the entries in the zip central directory and not in the local entry headers. More...
class  ZipFile
class  ZipInputStream
class  ZipInputStreambuf
	ZipInputStreambuf is a zip input streambuf filter. More...
class  ZipLocalEntry
	A concrete implementation of the abstract FileEntry base class for ZipFile entries, specifically for representing the information present in the local headers of file entries in a zip file. More...
class  ZipOutputStream
class  ZipOutputStreambuf
	ZipOutputStreambuf is a zip output streambuf filter. More...

Typedefs
typedef CollectionCollection CColl
	Shortcut name for a CollectionCollection. More...
typedef vector< EntryPointer > ConstEntries
	ConstEntries is a vector of ConstEntryPointer's. More...
typedef SimpleSmartPointer< const FileEntry > ConstEntryPointer
	ConstEntryPointer is a SimpleSmartPointer for const FileEntry's. More...
typedef BasicEntry DirEntry
	DirEntry is a BasicEntry. More...
typedef vector< EntryPointer > Entries
	Entries is a vector of EntryPointer's. More...
typedef SimpleSmartPointer< FileEntry > EntryPointer
typedef uint16_t uint16
typedef uint32_t uint32

Enumerations
enum  StorageMethod {   STORED = 0, SHRUNK, REDUCED1, REDUCED2,   REDUCED3, REDUCED4, IMPLODED, RESERVED,   DEFLATED }
	The types used with FileEntry::setMethod and FileEntry::getMethod. More...

Functions
uint32 htozl (unsigned char *buf)
uint16 htozs (unsigned char *buf)
template<class T >
const T & min (const T &a, const T &b)
bool operator!= (const ZipCDirEntry &ze, const ZipLocalEntry &zlh)
bool operator!= (const ZipLocalEntry &zlh, const ZipCDirEntry &ze)
template<class Type >
void operator+= (vector< Type > &v1, const vector< Type > &v2)
ostream & operator<< (ostream &os, const ConstEntryPointer &entry)
ostream & operator<< (ostream &os, const FileCollection &collection)
ostream & operator<< (ostream &os, const FileEntry &entry)
std::ostream & operator<< (std::ostream &os, const EndOfCentralDirectory &eocd)
std::ostream & operator<< (std::ostream &os, const ZipCDirEntry &zcdh)
std::ostream & operator<< (std::ostream &os, const ZipLocalEntry &zlh)
bool operator== (const ZipCDirEntry &ze, const ZipLocalEntry &zlh)
bool operator== (const ZipLocalEntry &zlh, const ZipCDirEntry &ze)
std::istream & operator>> (std::istream &is, DataDescriptor &)
std::istream & operator>> (std::istream &is, ZipCDirEntry &zcdh)
std::istream & operator>> (std::istream &is, ZipLocalEntry &zlh)
void readByteSeq (istream &is, string &con, int count)
void readByteSeq (istream &is, unsigned char *buf, int count)
void readByteSeq (istream &is, vector< unsigned char > &vec, int count)
uint16 readUint16 (istream &is)
uint32 readUint32 (istream &is)
void writeByteSeq (ostream &os, const string &con)
void writeByteSeq (ostream &os, const unsigned char *buf, int count)
void writeByteSeq (ostream &os, const vector< unsigned char > &vec)
void writeUint16 (uint16 host_val, ostream &os)
void writeUint32 (uint32 host_val, ostream &os)
uint32 ztohl (unsigned char *buf)
uint16 ztohs (unsigned char *buf)

Variables
static const char separator = '/'

Typedef Documentation

CColl

typedef CollectionCollection zipios::CColl

Shortcut name for a CollectionCollection.

If the static method inst is used, it is often used a lot, so it's handy with a short name for CollectionCollection

ConstEntries

typedef vector< EntryPointer > zipios::ConstEntries

ConstEntries is a vector of ConstEntryPointer's.

ConstEntryPointer

typedef SimpleSmartPointer< const FileEntry > zipios::ConstEntryPointer

ConstEntryPointer is a SimpleSmartPointer for const FileEntry's.

DirEntry

typedef BasicEntry zipios::DirEntry

DirEntry is a BasicEntry.

Entries

typedef vector< EntryPointer > zipios::Entries

Entries is a vector of EntryPointer's.

EntryPointer

typedef SimpleSmartPointer< FileEntry > zipios::EntryPointer

EntryPointer is a SimpleSmartPointer for FileEntry's.

uint16

typedef uint16_t zipios::uint16

uint32

typedef uint32_t zipios::uint32

Enumeration Type Documentation

StorageMethod

enum zipios::StorageMethod

The types used with FileEntry::setMethod and FileEntry::getMethod.

The current entries are the types supported by the zip format. The numbering also matches the numbering used in the zip file format, ie STORED is indicated by a 0 in the method field in a zip file and so on.

Enumerator
STORED
SHRUNK
REDUCED1
REDUCED2
REDUCED3
REDUCED4
IMPLODED
RESERVED
DEFLATED

Function Documentation

htozl()

uint32 zipios::htozl

(

unsigned char *

buf

)

References ztohl().

Referenced by writeUint32().

htozs()

uint16 zipios::htozs

(

unsigned char *

buf

)

References ztohs().

Referenced by writeUint16().

min()

template<class T >

const T& zipios::min	(	const T &	a,
		const T &	b
	)

Referenced by zipios::ZipInputStreambuf::underflow().

operator!=() [1/2]

bool zipios::operator!=	(	const ZipCDirEntry &	ze,
		const ZipLocalEntry &	zlh
	)

operator!=() [2/2]

bool zipios::operator!=	(	const ZipLocalEntry &	zlh,
		const ZipCDirEntry &	ze
	)

operator+=()

template<class Type >

void zipios::operator+=	(	vector< Type > &	v1,
		const vector< Type > &	v2
	)

operator<<() [1/6]

ostream& zipios::operator<<	(	ostream &	os,
		const ConstEntryPointer &	entry
	)

operator<<() [2/6]

ostream& zipios::operator<<	(	ostream &	os,
		const FileCollection &	collection
	)

References zipios::FileCollection::entries(), and zipios::FileCollection::getName().

operator<<() [3/6]

ostream & zipios::operator<<	(	ostream &	os,
		const FileEntry &	entry
	)

References zipios::FileEntry::toString().

operator<<() [4/6]

ostream & zipios::operator<<	(	std::ostream &	os,
		const EndOfCentralDirectory &	eocd
	)

References writeByteSeq(), writeUint16(), and writeUint32().

operator<<() [5/6]

ostream & zipios::operator<<	(	std::ostream &	os,
		const ZipCDirEntry &	zcdh
	)

References zipios::ZipLocalEntry::compress_method, zipios::ZipLocalEntry::compress_size, zipios::ZipLocalEntry::crc_32, zipios::ZipLocalEntry::extra_field, zipios::ZipLocalEntry::extra_field_len, zipios::ZipLocalEntry::extract_version, zipios::ZipLocalEntry::filename, zipios::ZipLocalEntry::filename_len, zipios::ZipLocalEntry::gp_bitfield, zipios::ZipLocalEntry::last_mod_fdate, zipios::ZipLocalEntry::last_mod_ftime, zipios::ZipLocalEntry::uncompress_size, writeByteSeq(), writeUint16(), and writeUint32().

operator<<() [6/6]

ostream & zipios::operator<<	(	std::ostream &	os,
		const ZipLocalEntry &	zlh
	)

References zipios::ZipLocalEntry::compress_method, zipios::ZipLocalEntry::compress_size, zipios::ZipLocalEntry::crc_32, zipios::ZipLocalEntry::extra_field, zipios::ZipLocalEntry::extra_field_len, zipios::ZipLocalEntry::extract_version, zipios::ZipLocalEntry::filename, zipios::ZipLocalEntry::filename_len, zipios::ZipLocalEntry::gp_bitfield, zipios::ZipLocalEntry::last_mod_fdate, zipios::ZipLocalEntry::last_mod_ftime, zipios::ZipLocalEntry::signature, zipios::ZipLocalEntry::uncompress_size, writeByteSeq(), writeUint16(), and writeUint32().

operator==() [1/2]

bool zipios::operator==	(	const ZipCDirEntry &	ze,
		const ZipLocalEntry &	zlh
	)

operator==() [2/2]

bool zipios::operator==	(	const ZipLocalEntry &	zlh,
		const ZipCDirEntry &	ze
	)

References zipios::ZipLocalEntry::compress_method, zipios::ZipLocalEntry::extract_version, zipios::ZipLocalEntry::filename, zipios::ZipLocalEntry::filename_len, zipios::ZipLocalEntry::gp_bitfield, zipios::ZipLocalEntry::last_mod_fdate, and zipios::ZipLocalEntry::last_mod_ftime.

operator>>() [1/3]

istream & zipios::operator>>	(	std::istream &	is,
		DataDescriptor &
	)

operator>>() [2/3]

istream & zipios::operator>>	(	std::istream &	is,
		ZipCDirEntry &	zcdh
	)

References zipios::ZipLocalEntry::compress_method, zipios::ZipLocalEntry::compress_size, zipios::ZipLocalEntry::crc_32, zipios::ZipLocalEntry::extra_field, zipios::ZipLocalEntry::extra_field_len, zipios::ZipLocalEntry::extract_version, zipios::ZipLocalEntry::filename, zipios::ZipLocalEntry::filename_len, zipios::ZipLocalEntry::gp_bitfield, zipios::ZipLocalEntry::last_mod_fdate, zipios::ZipLocalEntry::last_mod_ftime, readByteSeq(), readUint16(), readUint32(), and zipios::ZipLocalEntry::uncompress_size.

operator>>() [3/3]

istream & zipios::operator>>	(	std::istream &	is,
		ZipLocalEntry &	zlh
	)

References zipios::ZipLocalEntry::compress_method, zipios::ZipLocalEntry::compress_size, zipios::ZipLocalEntry::crc_32, zipios::ZipLocalEntry::extra_field, zipios::ZipLocalEntry::extra_field_len, zipios::ZipLocalEntry::extract_version, zipios::ZipLocalEntry::filename, zipios::ZipLocalEntry::filename_len, zipios::ZipLocalEntry::gp_bitfield, zipios::ZipLocalEntry::last_mod_fdate, zipios::ZipLocalEntry::last_mod_ftime, readByteSeq(), readUint16(), readUint32(), zipios::ZipLocalEntry::signature, and zipios::ZipLocalEntry::uncompress_size.

readByteSeq() [1/3]

void zipios::readByteSeq	(	istream &	is,
		string &	con,
		int	count
	)

Referenced by operator>>(), and zipios::BackBuffer::readChunk().

readByteSeq() [2/3]

void zipios::readByteSeq	(	istream &	is,
		unsigned char *	buf,
		int	count
	)

readByteSeq() [3/3]

void zipios::readByteSeq	(	istream &	is,
		vector< unsigned char > &	vec,
		int	count
	)

readUint16()

uint16 zipios::readUint16

(

istream &

is

)

References ztohs().

Referenced by operator>>().

readUint32()

uint32 zipios::readUint32

(

istream &

is

)

References ztohl().

Referenced by zipios::ZipFile::openEmbeddedZipFile(), and operator>>().

writeByteSeq() [1/3]

void zipios::writeByteSeq	(	ostream &	os,
		const string &	con
	)

Referenced by operator<<().

writeByteSeq() [2/3]

void zipios::writeByteSeq	(	ostream &	os,
		const unsigned char *	buf,
		int	count
	)

writeByteSeq() [3/3]

void zipios::writeByteSeq	(	ostream &	os,
		const vector< unsigned char > &	vec
	)

writeUint16()

void zipios::writeUint16	(	uint16	host_val,
		ostream &	os
	)

References htozs().

Referenced by operator<<().

writeUint32()

void zipios::writeUint32	(	uint32	host_val,
		ostream &	os
	)

References htozl().

Referenced by operator<<().

ztohl()

uint32 zipios::ztohl

(

unsigned char *

buf

)

Referenced by htozl(), zipios::EndOfCentralDirectory::read(), and readUint32().

ztohs()

uint16 zipios::ztohs

(

unsigned char *

buf

)

Referenced by htozs(), zipios::EndOfCentralDirectory::read(), and readUint16().

Variable Documentation

separator

const char zipios::separator = '/'

static

Referenced by zipios::BasicEntry::getFileName(), zipios::ZipLocalEntry::getFileName(), zipios::BasicEntry::isDirectory(), and zipios::ZipLocalEntry::isDirectory().