Line data Source code
1 : #pragma once
2 : #ifndef ZIPIOS_FILEENTRY_HPP
3 : #define ZIPIOS_FILEENTRY_HPP
4 :
5 : /*
6 : Zipios++ - a small C++ library that provides easy access to .zip files.
7 :
8 : Copyright (C) 2000-2007 Thomas Sondergaard
9 : Copyright (C) 2015 Made to Order Software Corporation
10 :
11 : This library is free software; you can redistribute it and/or
12 : modify it under the terms of the GNU Lesser General Public
13 : License as published by the Free Software Foundation; either
14 : version 2 of the License, or (at your option) any later version.
15 :
16 : This library is distributed in the hope that it will be useful,
17 : but WITHOUT ANY WARRANTY; without even the implied warranty of
18 : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 : Lesser General Public License for more details.
20 :
21 : You should have received a copy of the GNU Lesser General Public
22 : License along with this library; if not, write to the Free Software
23 : Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 : */
25 :
26 : /** \file
27 : * \brief Define the zipios::FileEntry class.
28 : *
29 : * The zipios::FileEntry class is an interface defining a virtual
30 : * representation to a file in a Zip archive or on disk.
31 : *
32 : * File entries are found in various file collections.
33 : *
34 : * \sa zipios::FileCollection
35 : */
36 :
37 : #include "zipios++/filepath.hpp"
38 :
39 : #include <memory>
40 : #include <vector>
41 :
42 :
43 : namespace zipios
44 : {
45 :
46 :
47 : enum class StorageMethod : uint8_t
48 : {
49 : STORED = 0,
50 : SHRUNK = 1,
51 : REDUCED1 = 2,
52 : REDUCED2 = 3,
53 : REDUCED3 = 4,
54 : REDUCED4 = 5,
55 : IMPLODED = 6,
56 : TOKENIZED = 7,
57 : DEFLATED = 8,
58 : DEFLATED64 = 9,
59 : OLD_TERSE = 10,
60 : RESERVED11 = 11,
61 : BZIP2 = 12,
62 : REVERVED13 = 13,
63 : LZMA = 14,
64 : RESERVED15 = 15,
65 : RESERVED16 = 16,
66 : RESERVED17 = 17,
67 : NEW_TERSE = 18,
68 : LZ77 = 19,
69 : WAVPACK = 97,
70 : PPMD_I_1 = 98
71 : };
72 :
73 :
74 284797 : class FileEntry
75 : {
76 : public:
77 : typedef std::shared_ptr<FileEntry> pointer_t;
78 : typedef std::vector<pointer_t> vector_t;
79 : typedef std::vector<unsigned char> buffer_t;
80 : typedef uint32_t crc32_t;
81 : typedef uint32_t dostime_t;
82 :
83 : // we use our own compression level type, it gets converted as
84 : // required when the level is to be used by a compression scheme
85 : typedef int CompressionLevel;
86 :
87 : static CompressionLevel const COMPRESSION_LEVEL_DEFAULT = -3;
88 : static CompressionLevel const COMPRESSION_LEVEL_SMALLEST = -2;
89 : static CompressionLevel const COMPRESSION_LEVEL_FASTEST = -1;
90 : static CompressionLevel const COMPRESSION_LEVEL_NONE = 0;
91 : static CompressionLevel const COMPRESSION_LEVEL_MINIMUM = 1;
92 : static CompressionLevel const COMPRESSION_LEVEL_MAXIMUM = 100;
93 :
94 : FileEntry(FilePath const & filename, std::string const & comment = std::string());
95 : virtual pointer_t clone() const = 0;
96 : virtual ~FileEntry();
97 :
98 : virtual std::string getComment() const;
99 : virtual size_t getCompressedSize() const;
100 : virtual crc32_t getCrc() const;
101 : std::streampos getEntryOffset() const;
102 : virtual buffer_t getExtra() const;
103 : virtual size_t getHeaderSize() const;
104 : virtual CompressionLevel getLevel() const;
105 : virtual StorageMethod getMethod() const;
106 : virtual std::string getName() const;
107 : virtual std::string getFileName() const;
108 : virtual size_t getSize() const;
109 : virtual dostime_t getTime() const;
110 : virtual std::time_t getUnixTime() const;
111 : bool hasCrc() const;
112 : virtual bool isDirectory() const;
113 : virtual bool isEqual(FileEntry const& file_entry) const;
114 : virtual bool isValid() const;
115 : virtual void setComment(std::string const& comment);
116 : virtual void setCompressedSize(size_t size);
117 : virtual void setCrc(crc32_t crc);
118 : void setEntryOffset(std::streampos offset);
119 : virtual void setExtra(buffer_t const& extra);
120 : virtual void setLevel(CompressionLevel level);
121 : virtual void setMethod(StorageMethod method);
122 : virtual void setSize(size_t size);
123 : virtual void setTime(dostime_t time);
124 : virtual void setUnixTime(std::time_t time);
125 : virtual std::string toString() const;
126 :
127 : virtual void read(std::istream& is);
128 : virtual void write(std::ostream& os);
129 :
130 : protected:
131 : FilePath m_filename;
132 : std::string m_comment;
133 : size_t m_uncompressed_size = 0;
134 : time_t m_unix_time = 0;
135 : std::streampos m_entry_offset = 0;
136 : StorageMethod m_compress_method = StorageMethod::STORED;
137 : CompressionLevel m_compression_level = COMPRESSION_LEVEL_DEFAULT;
138 : uint32_t m_crc_32 = 0;
139 : buffer_t m_extra_field;
140 : bool m_has_crc_32 = false;
141 : bool m_valid = false;
142 : };
143 :
144 :
145 : std::ostream& operator << (std::ostream& os, FileEntry const& entry);
146 :
147 :
148 : } // zipios namespace
149 :
150 : // Local Variables:
151 : // mode: cpp
152 : // indent-tabs-mode: nil
153 : // c-basic-offset: 4
154 : // tab-width: 4
155 : // End:
156 :
157 : // vim: ts=4 sw=4 et
158 : #endif
|
