summaryrefslogtreecommitdiff
path: root/rbutil/rbutilqt/zip/README
diff options
context:
space:
mode:
Diffstat (limited to 'rbutil/rbutilqt/zip/README')
-rw-r--r--rbutil/rbutilqt/zip/README68
1 files changed, 68 insertions, 0 deletions
diff --git a/rbutil/rbutilqt/zip/README b/rbutil/rbutilqt/zip/README
new file mode 100644
index 0000000000..81891e8516
--- /dev/null
+++ b/rbutil/rbutilqt/zip/README
@@ -0,0 +1,68 @@
1The *.cpp and *.h files in this archive are
2Copyright (C) 2007 Angius Fabrizio (blue_death@users.sourceforge.net)
3
4You may use, distribute and copy the files under the terms of
5GNU General Public License version 2 (see the file LICENSE.GPL for details)
6
7-------------------------------------------------------------------------
8
9Website: http://osdab.sourceforge.net/
10SourceForge.net project page: https://sourceforge.net/projects/osdab/
11
12**************** ******* ******************************************************
13
14detailed description
15--------------------
16Meet a couple of pure-Qt/C++ classes capable of handling PKZIP 2.0 compatible zip archives.
17
18This is not a "port" of some other existing implementation, everything has been written from scratch (althought some code was actually inspired by existing public domain projects) and it's all pure C++/Qt. Please note that this is not a complete stand-alone library, it's just a bunch of classes. You will have to add them to your project and modify them to best fit your needs.
19
20It supports basic features like file extraction and compression (with optional password encryption) and archive comments. There are methods to extract single files or the whole archive and methods to compress the contents of a whole directory. Nevertheless, it should be quite trivial to add other features. The public API only has a few methods because this is what I was looking for. This does not mean you can't write a few more lines of code (it really shouldn't take more than a few lines!) to add more features.
21
22The classes are great if you only need to use the PKZIP format for loading/saving your application's data. Just remember that you will need to customize a few parts of the code, i.e. to add your own password retrieval method.
23
24zlib is used for actual compression and decompression.
25
26Please refer to the example application's main.cpp file or to the class comments in the source files for details and more usage examples.
27
28history
29-------
302007-02-01 - New IgnorePaths compression option and two more "addDirectoryContents()" convenience methods to use this option.
312007-01-28 - Major changes:
32 - Bug fix: there was a big problem with directory names.
33 - API changes: the Zip::addDirectory() method is now easier to use.
34 The password can now be set using a setPassword() method and a new flag allows to preserve absolute paths.
35 - Added an "encrypted" flag to the Unzip::ZipEntry struct.
36 - Removed QObject inheritance. Internationalization is now achieved through QCoreApplication::translate().
372006-11-30 - A good part of the UnZip class has been rewritten. Zip entries with a Data Descriptor (like OpenOffice files) are now correctly parsed; some minor API changes and bug fixes; new features: comments, zip entry list, skip paths unzip option
382006-11-24 - Bug fix. An additional directory was being created for some files in the root directory
392006-10-23 - Minor API changes; QIODevice support added; better binary compatibility; "long long" issue with older compilers solved
402006-06-09 - Minor API changes
412005-10-03 - First public release
42
43features
44--------
45Pure C++/Qt based, clean & oo implementation.
46Retrieve archive contents information before extracting any file.
47Fast (but less robust with corrupt archives) parsing of the ZIP file format.
48Traditional PKWARE password encryption (strong encryption as introduced by PKZip versions 5.0 and later is NOT available).
49Support for archive comments.
50
51missing features and restrictions
52---------------------------------
53Needs to be modified to fit into an existing project (i.e.: you might need to add your own password handling routine).
54Weak support of corrupted archives (althought some files could be extracted even if the archive is corrupted).
55No support for filesystem specific features like unix symbolic links.
56No support for spanned archives.
57No support for strong encryption or features introduced after PKZIP version 2.0 (see the PKWARE specs for details).
58
59requirements
60------------
61Qt version 4.0.x or later
62zlib library
63
64
65**************** ******* ******************************************************
66BEFORE SENDING ANY EMAIL, CHECK OUT THE OSDAB WEBSITE HOSTED AT SOURCEFORGE.NET
67**************** ******* ******************************************************
68