30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
* @class OFZIPArchive OFZIPArchive.h ObjFW/OFZIPArchive.h
*
* @brief A class for accessing and manipulating ZIP files.
*/
@interface OFZIPArchive: OFObject
{
OFSeekableStream *_stream;
uint32_t _diskNumber, _centralDirectoryDisk;
uint64_t _centralDirectoryEntriesInDisk, _centralDirectoryEntries;
uint64_t _centralDirectorySize;
int64_t _centralDirectoryOffset;
OFString *_archiveComment;
OFMutableArray OF_GENERIC(OFZIPArchiveEntry *) *_entries;
OFMutableDictionary OF_GENERIC(OFString *, OFZIPArchiveEntry *)
*_pathToEntryMap;
OFStream *_lastReturnedStream;
}
/*!
* The archive comment.
*/
@property (readonly, nonatomic) OFString *archiveComment;
/*!
* @brief Creates a new OFZIPArchive object with the specified seekable stream.
*
* @param stream A seekable stream from which the ZIP archive will be read
* @return A new, autoreleased OFZIPArchive
*/
+ (instancetype)archiveWithSeekableStream: (OFSeekableStream *)stream;
#ifdef OF_HAVE_FILES
/*!
* @brief Creates a new OFZIPArchive object with the specified file.
*
* @param path The path to the ZIP file
* @return A new, autoreleased OFZIPArchive
*/
+ (instancetype)archiveWithPath: (OFString *)path;
#endif
- init OF_UNAVAILABLE;
/*!
* @brief Initializes an already allocated OFZIPArchive object with the
* specified seekable stream.
*
* @param stream A seekable stream from which the ZIP archive will be read
* @return An initialized OFZIPArchive
*/
- initWithSeekableStream: (OFSeekableStream *)stream OF_DESIGNATED_INITIALIZER;
#ifdef OF_HAVE_FILES
/*!
* @brief Initializes an already allocated OFZIPArchive object with the
* specified file.
*
* @param path The path to the ZIP file
* @return An initialized OFZIPArchive
*/
- initWithPath: (OFString *)path;
#endif
/*!
* @brief Returns the entries of the central directory of the archive as an
* array of objects of class @ref OFZIPArchiveEntry.
*
* The objects of the array have the same order as the entries in the central
* directory, which does not need to be the order in which the actual files are
* stored.
*
* @return The entries of the central directory of the archive as an array
*/
- (OFArray OF_GENERIC(OFZIPArchiveEntry *) *)entries;
/*!
* @brief Returns a stream for reading the specified file from the archive.
*
* @warning Calling @ref streamForReadingFile: will invalidate all streams
* previously returned by @ref streamForReadingFile:! Reading from an
* invalidated stream will throw an @ref OFReadFailedException!
*
* @param path The path to the file inside the archive
* @return A stream for reading the specified file form the archive
*/
- (OFStream *)streamForReadingFile: (OFString *)path;
@end
OF_ASSUME_NONNULL_END
|
>
>
>
>
>
>
>
>
|
>
>
>
>
|
>
>
>
>
|
>
>
>
>
|
>
>
>
|
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
* @class OFZIPArchive OFZIPArchive.h ObjFW/OFZIPArchive.h
*
* @brief A class for accessing and manipulating ZIP files.
*/
@interface OFZIPArchive: OFObject
{
OFSeekableStream *_stream;
enum {
OF_ZIP_ARCHIVE_MODE_READ,
OF_ZIP_ARCHIVE_MODE_WRITE,
OF_ZIP_ARCHIVE_MODE_APPEND
} _mode;
uint32_t _diskNumber, _centralDirectoryDisk;
uint64_t _centralDirectoryEntriesInDisk, _centralDirectoryEntries;
uint64_t _centralDirectorySize;
int64_t _centralDirectoryOffset;
OFString *_archiveComment;
OFMutableArray OF_GENERIC(OFZIPArchiveEntry *) *_entries;
OFMutableDictionary OF_GENERIC(OFString *, OFZIPArchiveEntry *)
*_pathToEntryMap;
OFStream *_lastReturnedStream;
}
/*!
* The archive comment.
*/
@property (readonly, nonatomic) OFString *archiveComment;
/*!
* @brief Creates a new OFZIPArchive object with the specified seekable stream.
*
* @param stream A seekable stream from which the ZIP archive will be read
* @param mode The mode for the ZIP file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* file.
* @return A new, autoreleased OFZIPArchive
*/
+ (instancetype)archiveWithSeekableStream: (OFSeekableStream *)stream
mode: (OFString *)mode;
#ifdef OF_HAVE_FILES
/*!
* @brief Creates a new OFZIPArchive object with the specified file.
*
* @param path The path to the ZIP file
* @param mode The mode for the ZIP file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* file.
* @return A new, autoreleased OFZIPArchive
*/
+ (instancetype)archiveWithPath: (OFString *)path
mode: (OFString *)mode;
#endif
- init OF_UNAVAILABLE;
/*!
* @brief Initializes an already allocated OFZIPArchive object with the
* specified seekable stream.
*
* @param stream A seekable stream from which the ZIP archive will be read
* @param mode The mode for the ZIP file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* file.
* @return An initialized OFZIPArchive
*/
- initWithSeekableStream: (OFSeekableStream *)stream
mode: (OFString *)mode OF_DESIGNATED_INITIALIZER;
#ifdef OF_HAVE_FILES
/*!
* @brief Initializes an already allocated OFZIPArchive object with the
* specified file.
*
* @param path The path to the ZIP file
* @param mode The mode for the ZIP file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* file.
* @return An initialized OFZIPArchive
*/
- initWithPath: (OFString *)path
mode: (OFString *)mode;
#endif
/*!
* @brief Returns the entries of the central directory of the archive as an
* array of objects of class @ref OFZIPArchiveEntry.
*
* The objects of the array have the same order as the entries in the central
* directory, which does not need to be the order in which the actual files are
* stored.
*
* @return The entries of the central directory of the archive as an array
*/
- (OFArray OF_GENERIC(OFZIPArchiveEntry *) *)entries;
/*!
* @brief Returns a stream for reading the specified file from the archive.
*
* This method is only available in read and append mode.
*
* @warning Calling @ref streamForReadingFile: will invalidate all streams
* previously returned by @ref streamForReadingFile:! Reading from an
* invalidated stream will throw an @ref OFReadFailedException!
*
* @param path The path to the file inside the archive
* @return A stream for reading the specified file form the archive
*/
- (OFStream *)streamForReadingFile: (OFString *)path;
@end
OF_ASSUME_NONNULL_END
|