120ca87015
git-svn-id: https://free-cad.svn.sourceforge.net/svnroot/free-cad/trunk@5000 e8eeb9e2-ec13-0410-a4a9-efa5cf37419d
114 lines
4.6 KiB
Plaintext
114 lines
4.6 KiB
Plaintext
/**
|
|
\defgroup ZIPIOS Zipios++
|
|
\ingroup EMBEDDED
|
|
|
|
\section intro Introduction
|
|
|
|
Zipios++ is a java.util.zip-like C++ library for reading and
|
|
writing Zip files. Access to individual entries is provided through
|
|
standard C++ iostreams. A simple read-only virtual file system that
|
|
mounts regular directories and zip files is also provided.
|
|
|
|
The source code is released under the <A
|
|
HREF="http://www.gnu.org/copyleft/lesser.html">GNU Lesser General Public
|
|
License</A>.
|
|
|
|
\section status Status
|
|
|
|
Spanned archives are not supported, and support is not planned.
|
|
|
|
|
|
The library has been tested and appears to be working with
|
|
<UL>
|
|
<LI><A HREF="http://www.freebsd.org/ports/archivers.html#zipios++-0.1.5">FreeBSD stable and current / gcc 2.95.3</A></LI>
|
|
<LI>Red Hat Linux release 7.0 / gcc 2.96</LI>
|
|
<LI>Red Hat Linux release 6.2 (Zoot) / egcs-2.91.66</LI>
|
|
<LI>Linux Mandrake release 7.0 (Air) / gcc 2.95.2</LI>
|
|
<LI>SGI IRIX64 6.5 / gcc 2.95.2</LI>
|
|
<LI>SGI IRIX64 6.5 / MIPSpro Compilers: Version 7.30</LI>
|
|
</UL>
|
|
|
|
If you are aware of any other platforms that Zipios++ works on,
|
|
please let me know (thomass@deltadata.dk).
|
|
|
|
\subsection zipfiles Zip file access
|
|
The two most important classes are \ref zipfile_anchor "ZipFile" and
|
|
\ref ZipInputStream_anchor "ZipInputStream". ZipInputStream is an istream
|
|
for reading zipfiles. It can be instantiated directly, without the
|
|
use of ZipFile. A new ZipInputStream reads from the first entry, and
|
|
the user can skip to the next entry by calling
|
|
\ref ZipInputStream_getnextentry_anchor "ZipInputStream::getNextEntry()".
|
|
|
|
ZipFile scans the central directory of a zipfile and provides an
|
|
interface to access that directory. The user may search for entries
|
|
with a particular filename using \ref fcoll_getentry_anchor "ZipFile::getEntry()",
|
|
or simply get the complete list of entries
|
|
with \ref fcoll_entries_anchor "ZipFile::entries()". To get an
|
|
istream (ZipInputStream) to a particular entry simply use
|
|
\ref fcoll_getinputstream "ZipFile::getInputStream()".
|
|
|
|
"example_zip.cpp" demonstrates the central elements of Zipios++.
|
|
|
|
A Zip file appended to another file, e.g. a binary program, with the
|
|
program "appendzip", can be read with
|
|
\ref zipfile_openembeddedzipfile "ZipFile::openEmbeddedZipFile()".
|
|
|
|
\subsection filecollections FileCollections
|
|
|
|
A ZipFile is actually just a special kind of
|
|
\ref fcoll_anchor "FileCollection" that
|
|
obtains its entries from a .zip Zip archive. Zipios++ also implements
|
|
a \ref dircol_anchor "DirectoryCollection" that obtains its entries
|
|
from a specified directory, and a \ref collcoll_anchor "CollectionCollection"
|
|
that obtains its entries from
|
|
other collections. Using a single CollectionCollection any number of
|
|
other FileCollections can be placed under its control and accessed
|
|
through the same single interface that is used to access a ZipFile or
|
|
a DirectoryCollection. A singleton (a unique global instance)
|
|
CollectionCollection can be obtained through
|
|
|
|
\ref collcoll_inst_anchor "CollectionCollection::inst()" ;
|
|
|
|
To save typing CollectionCollection has been typedef'ed to CColl. In
|
|
the initialization part of an application FileCollections can be
|
|
created, and placed under CColll::inst()'s control using
|
|
|
|
\ref collcoll_addcoll_anchor "CColl::inst().addCollection()"
|
|
|
|
and later an istream can be obtained using
|
|
|
|
\ref fcoll_getinputstream "CColl::inst().getInputStream()".
|
|
|
|
\section download Download
|
|
Go to Zipios++ project page on SourceForge for tar balls and ChangeLog.
|
|
<A HREF="http://sourceforge.net/project/?group_id=5418" >
|
|
http://sourceforge.net/project/?group_id=5418</A>
|
|
|
|
\section links Links
|
|
<A HREF="ftp://ftp.freesoftware.com/pub/infozip/zlib/zlib.html">zlib</A>.
|
|
The compression library that Zipios++ uses to perform the actual
|
|
decompression.
|
|
|
|
<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/index.html">
|
|
Java 2 Platform, Standard Edition, v 1.3 API Specification
|
|
</A>. Zipios++ is heavily inspired by the java.util.zip package.
|
|
|
|
<A
|
|
HREF="http://www.geocities.com/SiliconValley/Lakes/2160/fformats/files/zip.txt">
|
|
PKWARE zip format
|
|
</A>. A description of the zip file format.
|
|
|
|
\section bugs Bugs
|
|
Submit bug reports and patches to thomass@deltadata.dk
|
|
|
|
|
|
|
|
\htmlonly
|
|
Project hosted by <A HREF="http://sourceforge.net">
|
|
SourceForge
|
|
</A><p>
|
|
\endhtmlonly
|
|
*/
|
|
|
|
|