|
527
|
1 /** |
|
|
2 * \mainpage |
|
|
3 * |
|
|
4 * Welcome to the zip library. |
|
|
5 * |
|
|
6 * ## Introduction |
|
|
7 * |
|
|
8 * The libzip library is a good C library for opening and creating zip archives, this wrapper provides safe C++ classes |
|
|
9 * around this great library. |
|
|
10 * |
|
|
11 * The benefits: |
|
|
12 * |
|
|
13 * - Automatic allocations and destructions (RAII), |
|
|
14 * - Easy way to add files, |
|
|
15 * - Easy API, |
|
|
16 * - Easy file reading in archive, |
|
|
17 * - Convenience, thanks to C++ function overloads. |
|
|
18 * |
|
|
19 * |
|
|
20 * ## Requirements |
|
|
21 * |
|
|
22 * - [libzip](http://www.nih.at/libzip), |
|
|
23 * - C++11. |
|
|
24 * |
|
|
25 * ## Installation |
|
|
26 * |
|
|
27 * Just copy the file zippy.hpp and add it to your project. |
|
|
28 * |
|
|
29 * ## Overview |
|
|
30 * |
|
|
31 * Very simple extraction of a file. |
|
|
32 * |
|
|
33 * ````cpp |
|
|
34 * #include <iostream> |
|
|
35 * |
|
|
36 * #include "zippy.hpp" |
|
|
37 * |
|
|
38 * try { |
|
|
39 * zippy::Archive archive("mydata.zip"); |
|
|
40 * zippy::Stat stat = archive.stat("README"); |
|
|
41 * zippy::File file = archive.open("README"); |
|
|
42 * |
|
|
43 * std::cout << "content of README:" << std::endl; |
|
|
44 * std::cout << file.read(stat.size); |
|
|
45 * } catch (const std::exception &ex) { |
|
|
46 * std::cerr << ex.what() << std::endl; |
|
|
47 * } |
|
|
48 * ```` |
|
|
49 */ |
