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.
typedef vector< EntryPointerConstEntries
 ConstEntries is a vector of ConstEntryPointer's.
typedef SimpleSmartPointer
< const FileEntry
ConstEntryPointer
 ConstEntryPointer is a SimpleSmartPointer for const FileEntry's.
typedef BasicEntry DirEntry
 DirEntry is a BasicEntry.
typedef vector< EntryPointerEntries
 Entries is a vector of EntryPointer's.
typedef SimpleSmartPointer
< FileEntry
EntryPointer
 EntryPointer is a SimpleSmartPointer for FileEntry's.
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)
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)
ostream & operator<< (ostream &os, const ConstEntryPointer &entry)
ostream & operator<< (ostream &os, const FileEntry &entry)
ostream & operator<< (ostream &os, const FileCollection &collection)
bool operator== (const ZipCDirEntry &ze, const ZipLocalEntry &zlh)
bool operator== (const ZipLocalEntry &zlh, const ZipCDirEntry &ze)
std::istream & operator>> (std::istream &is, ZipCDirEntry &zcdh)
std::istream & operator>> (std::istream &is, DataDescriptor &)
std::istream & operator>> (std::istream &is, ZipLocalEntry &zlh)
void readByteSeq (istream &is, vector< unsigned char > &vec, int count)
void readByteSeq (istream &is, unsigned char *buf, int count)
void readByteSeq (istream &is, string &con, int count)
uint16 readUint16 (istream &is)
uint32 readUint32 (istream &is)
void writeByteSeq (ostream &os, const vector< unsigned char > &vec)
void writeByteSeq (ostream &os, const unsigned char *buf, int count)
void writeByteSeq (ostream &os, const string &con)
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

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

Definition at line 105 of file collcoll.h.

ConstEntries is a vector of ConstEntryPointer's.

Definition at line 43 of file fileentry.h.

ConstEntryPointer is a SimpleSmartPointer for const FileEntry's.

Definition at line 37 of file fileentry.h.

DirEntry is a BasicEntry.

Definition at line 14 of file dircoll.h.

typedef vector< EntryPointer > zipios::Entries

Entries is a vector of EntryPointer's.

Definition at line 40 of file fileentry.h.

EntryPointer is a SimpleSmartPointer for FileEntry's.

Definition at line 33 of file fileentry.h.

typedef uint16_t zipios::uint16

Definition at line 8 of file zipios_defs.h.

typedef uint32_t zipios::uint32

Definition at line 9 of file zipios_defs.h.


Enumeration Type Documentation

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 

Definition at line 25 of file fileentry.h.


Function Documentation

uint32 zipios::htozl ( unsigned char *  buf  )  [inline]

Definition at line 68 of file zipheadio.h.

References ztohl().

Referenced by writeUint16(), and writeUint32().

uint16 zipios::htozs ( unsigned char *  buf  )  [inline]

Definition at line 73 of file zipheadio.h.

References ztohs().

template<class T >
const T& zipios::min ( const T &  a,
const T &  b 
) [inline]
bool zipios::operator!= ( const ZipCDirEntry &  ze,
const ZipLocalEntry &  zlh 
) [inline]

Definition at line 208 of file ziphead.h.

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

Definition at line 205 of file ziphead.h.

template<class Type >
void zipios::operator+= ( vector< Type > &  v1,
const vector< Type > &  v2 
) [inline]

Definition at line 15 of file zipios_common.h.

ostream & zipios::operator<< ( std::ostream &  os,
const EndOfCentralDirectory &  eocd 
)
ostream & zipios::operator<< ( std::ostream &  os,
const ZipCDirEntry &  zcdh 
)
ostream & zipios::operator<< ( std::ostream &  os,
const ZipLocalEntry &  zlh 
)
ostream& zipios::operator<< ( ostream &  os,
const ConstEntryPointer &  entry 
) [inline]

Definition at line 207 of file fileentry.h.

ostream & zipios::operator<< ( ostream &  os,
const FileEntry &  entry 
)
ostream& zipios::operator<< ( ostream &  os,
const FileCollection &  collection 
) [inline]
bool zipios::operator== ( const ZipCDirEntry &  ze,
const ZipLocalEntry &  zlh 
) [inline]

Definition at line 202 of file ziphead.h.

bool zipios::operator== ( const ZipLocalEntry &  zlh,
const ZipCDirEntry &  ze 
)
istream & zipios::operator>> ( std::istream &  is,
ZipCDirEntry &  zcdh 
)
istream & zipios::operator>> ( std::istream &  is,
DataDescriptor &   
)
istream & zipios::operator>> ( std::istream &  is,
ZipLocalEntry &  zlh 
)
void zipios::readByteSeq ( istream &  is,
vector< unsigned char > &  vec,
int  count 
) [inline]

Definition at line 142 of file zipheadio.h.

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

Definition at line 129 of file zipheadio.h.

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

Definition at line 112 of file zipheadio.h.

Referenced by zipios::BackBuffer::readChunk().

uint16 zipios::readUint16 ( istream &  is  )  [inline]

Definition at line 96 of file zipheadio.h.

References ztohs().

uint32 zipios::readUint32 ( istream &  is  )  [inline]

Definition at line 78 of file zipheadio.h.

References ztohl().

Referenced by zipios::ZipFile::openEmbeddedZipFile().

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

Definition at line 154 of file zipheadio.h.

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

Definition at line 138 of file zipheadio.h.

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

Definition at line 125 of file zipheadio.h.

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

Definition at line 107 of file zipheadio.h.

References htozl().

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

Definition at line 91 of file zipheadio.h.

References htozl().

uint32 zipios::ztohl ( unsigned char *  buf  )  [inline]

Definition at line 50 of file zipheadio.h.

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

uint16 zipios::ztohs ( unsigned char *  buf  )  [inline]

Definition at line 42 of file zipheadio.h.

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


Variable Documentation

const char zipios::separator = '/' [static]

Generated on Wed Nov 23 19:02:51 2011 for FreeCAD by  doxygen 1.6.1