zip_archive.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 */
29
30
31 #pragma once
32
33 #include <memory>
34 #include "zip_file_entry.h"
35 #include <vector>
36
37 namespace clan
38 {
41
42 class IODevice;
43 class ZipArchive_Impl;
44
46 class ZipArchive
47 {
50
51 public:
55 ZipArchive();
56
60 ZipArchive(IODevice &input);
61
65 ZipArchive(const std::string &filename);
66
70 ZipArchive(const ZipArchive &copy);
71
72 ~ZipArchive();
73
77
78 public:
80 std::vector<ZipFileEntry> get_file_list();
81
82 std::vector<ZipFileEntry> get_file_list(const std::string &path);
83
87
88 public:
90 IODevice open_file(const std::string &filename);
91
93 std::string get_pathname(const std::string &filename);
94
96 IODevice create_file(const std::string &filename, bool compress = true);
97
99
101 void add_file(const std::string &input_filename, const std::string &filename_in_archive);
102
115 void save();
116
120 void save(const std::string &filename);
121
125 void save(IODevice iodev);
126
128 void load(IODevice &input);
129
133
134 private:
135 std::shared_ptr<ZipArchive_Impl> impl;
137 };
138
139 }
140
clan
Definition: clanapp.h:35
clan::IODevice
I/O Device interface.
Definition: iodevice.h:50
clan::ZipArchive::get_file_list
std::vector< ZipFileEntry > get_file_list()
List of file entries in archive.
clan::StyleTokenType::string
@ keyword
clan::ZipArchive::load
void load(IODevice &input)
Loads the zip archive from a input device (done automatically at construction).
clan::ZipArchive::save
void save()
Saves zip archive.
clan::ZipArchive::open_file
IODevice open_file(const std::string &filename)
Opens a file in the archive.
clan::ZipArchive::create_file
IODevice create_file(const std::string &filename, bool compress=true)
Creates a new file entry.
clan::ZipArchive
Zip archive.
Definition: zip_archive.h:46
clan::ZipArchive::get_pathname
std::string get_pathname(const std::string &filename)
Get full path to source:
clan::ZipArchive::~ZipArchive
~ZipArchive()
clan::ZipArchive::ZipArchive
ZipArchive()
Constructs or loads a ZIP archive.
clan::ZipArchive::add_file
void add_file(const std::string &input_filename, const std::string &filename_in_archive)
Adds a file to zip archive.