generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2024-12-13 10:32:57 +01:00
Code Issues Projects Releases Wiki Activity

fixed doc (#2477)

Browse Source
This commit is contained in:
Günter Obiltschnig 2018-09-25 09:15:34 +02:00
parent 35cf889acd
commit bd0b767502
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Zip/doc/ZipUserGuide.page
View File

@ -11,7 +11,7 @@ POCO Zip adds support for parsing and creating Zip files. It offers the followin
!!Restrictions !!Restrictions
* POCO Zip does not support the DEFLATE64 algorithm. * POCO Zip does not support the DEFLATE64 algorithm.
* encrypted files are not supported * encrypted files are not supported
!!!Main Classes !!!Main Classes
Most users will work with two common classes: <*Compress*> and <*Decompress*> Most users will work with two common classes: <*Compress*> and <*Decompress*>
@ -23,31 +23,31 @@ Creating a Zip file is a basically a three-step process:
Compress(std::ostream& out, bool seekableOut); Compress(std::ostream& out, bool seekableOut);
---- ----
* Add entries: either add single files or directory entries * Add entries: either add single files or directory entries
void addFile(std::istream& input, void addFile(std::istream& input,
const Poco::DateTime& lastModifiedAt, const Poco::DateTime& lastModifiedAt,
const Poco::Path& fileName, const Poco::Path& fileName,
ZipCommon::CompressionMethod cm = ZipCommon::CM_DEFLATE, ZipCommon::CompressionMethod cm = ZipCommon::CM_DEFLATE,
ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM); ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM);
/// Adds a single file to the Zip File. fileName must not be a directory name. /// Adds a single file to the Zip File. fileName must not be a directory name.
void addFile(const Poco::Path& file, void addFile(const Poco::Path& file,
const Poco::Path& fileName, const Poco::Path& fileName,
ZipCommon::CompressionMethod cm = ZipCommon::CM_DEFLATE, ZipCommon::CompressionMethod cm = ZipCommon::CM_DEFLATE,
ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM); ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM);
/// Adds a single file to the Zip File. fileName must not be a directory name. The file must exist physically! /// Adds a single file to the Zip File. fileName must not be a directory name. The file must exist physically!
void addDirectory(const Poco::Path& entryName, const Poco::DateTime& lastModifiedAt); void addDirectory(const Poco::Path& entryName, const Poco::DateTime& lastModifiedAt);
/// Adds a directory entry excluding all children to the Zip file, entryName must not be empty. /// Adds a directory entry excluding all children to the Zip file, entryName must not be empty.
void addRecursive(const Poco::Path& entry, void addRecursive(const Poco::Path& entry,
ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM, ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM,
bool excludeRoot = true, bool excludeRoot = true,
const Poco::Path& name = Poco::Path()); const Poco::Path& name = Poco::Path());
/// Adds a directory entry recursively to the zip file, set excludeRoot to false to exclude the parent directory. /// Adds a directory entry recursively to the zip file, set excludeRoot to false to exclude the parent directory.
/// The name specifies under which path the entries are added in the Zip file. /// The name specifies under which path the entries are added in the Zip file.
---- ----
Note that one must always define a name when adding a file entry, otherwise the compresser can not decide if the file should be added with an absolute or a relative path. Note that one must always define a name when adding a file entry, otherwise the compresser can not decide if the file should be added with an absolute or a relative path.
Assume you are adding the file <*c:\\data\\hello.txt*> twice to a Zip: Assume you are adding the file <*c:\\data\\hello.txt*> twice to a Zip:
// MUST use binary! // MUST use binary!
@ -96,7 +96,7 @@ To get notified about the entries that are added during <*addRecursive*> registe
Poco::FIFOEvent<const ZipLocalFileHeader> EDone; Poco::FIFOEvent<const ZipLocalFileHeader> EDone;
---- ----
* Closing the Zip file: It is mandatory to manually close Compress objects. This guarantees that the Zip directory is written, thus creating a valid Zip file. It is safe to call <*close*> multiple times, only the first call takes effect. * Closing the Zip file: It is mandatory to manually close Compress objects. This guarantees that the Zip directory is written, thus creating a valid Zip file. It is safe to call <*close*> multiple times, only the first call takes effect.
ZipArchive close(); ZipArchive close();
---- ----
<*close*> returns a ZipArchive which describes all entries inside a Zip file. <*close*> returns a ZipArchive which describes all entries inside a Zip file.
@ -110,7 +110,7 @@ The following sample code shows how all entries can be extracted from a Zip file
std::ifstream inp("test.zip", std::ios::binary); std::ifstream inp("test.zip", std::ios::binary);
poco_assert (inp); poco_assert (inp);
// decompress to current working dir // decompress to current working dir
Decompress dec(inp, Poco::Path()); Decompress dec(inp, Poco::Path());
// if an error happens invoke the ZipTest::onDecompressError method // if an error happens invoke the ZipTest::onDecompressError method
dec.EError += Poco::Delegate<ZipTest, std::pair<const Poco::Zip::ZipLocalFileHeader, const std::string> >(this, &ZipTest::onDecompressError); dec.EError += Poco::Delegate<ZipTest, std::pair<const Poco::Zip::ZipLocalFileHeader, const std::string> >(this, &ZipTest::onDecompressError);
dec.decompressAllFiles(); dec.decompressAllFiles();
@ -152,7 +152,8 @@ To decompress single files you must first parse a Zip file, and then decompress
ZipArchive arch(inp); ZipArchive arch(inp);
ZipArchive::FileHeaders::const_iterator it = arch.findHeader("data/hello.txt"); ZipArchive::FileHeaders::const_iterator it = arch.findHeader("data/hello.txt");
poco_assert (it != arch.headerEnd()); poco_assert (it != arch.headerEnd());
ZipInputStream zipin (inp, it->second); inp.clear();
ZipInputStream zipin(inp, it->second);
std::ostringstream out(std::ios::binary); std::ostringstream out(std::ios::binary);
Poco::StreamCopier::copyStream(zipin, out); Poco::StreamCopier::copyStream(zipin, out);
---- ----