17
18
19
20
21
22
23
24
25
26
27
28
29
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
|
#import "OFKernelEventObserver.h"
#import "OFLHAArchiveEntry.h"
#import "OFString.h"
OF_ASSUME_NONNULL_BEGIN
@class OFStream;
/**
* @class OFLHAArchive OFLHAArchive.h ObjFW/OFLHAArchive.h
*
* @brief A class for accessing and manipulating LHA files.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFLHAArchive: OFObject
{
OFStream *_stream;
uint_least8_t _mode;
OFStringEncoding _encoding;
OFStream *_Nullable _lastReturnedStream;
}
/**
* @brief The encoding to use for the archive. Defaults to ISO 8859-1.
*/
@property (nonatomic) OFStringEncoding encoding;
/**
* @brief A stream for reading the current entry.
*
* @note This is only available in read mode.
*
* @note The returned stream conforms to @ref OFReadyForReadingObserving if the
* underlying stream does so, too.
*/
@property (readonly, nonatomic) OFStream *streamForReadingCurrentEntry;
#ifdef OF_HAVE_FILES
* @param path The path to the LHA file
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return A new, autoreleased OFLHAArchive
*/
+ (instancetype)archiveWithPath: (OFString *)path mode: (OFString *)mode;
#endif
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Initializes an already allocated OFLHAArchive object with the
* specified stream.
*
* @param stream A stream from which the LHA archive will be read.
* For read and append mode, this needs to be an OFSeekableStream.
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return An initialized OFLHAArchive
*/
- (instancetype)initWithStream: (OFStream *)stream
mode: (OFString *)mode OF_DESIGNATED_INITIALIZER;
#ifdef OF_HAVE_FILES
* @param path The path to the LHA file
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return An initialized OFLHAArchive
*/
- (instancetype)initWithPath: (OFString *)path mode: (OFString *)mode;
#endif
/**
* @brief Returns the next entry from the LHA archive or `nil` if all entries
* have been read.
*
* @note This is only available in read mode.
*
* @warning Calling @ref nextEntry will invalidate all streams returned by
* @ref streamForReadingCurrentEntry or
* @ref streamForWritingEntry:! Reading from or writing to an
* invalidated stream will throw an @ref OFReadFailedException or
* @ref OFWriteFailedException!
*
* @return The next entry from the LHA archive or `nil` if all entries have
* been read
*/
- (nullable OFLHAArchiveEntry *)nextEntry;
/**
* @brief Returns a stream for writing the specified entry.
*
* @note This is only available in write and append mode.
*
* @note The uncompressed size, compressed size and CRC16 of the specified
* entry are ignored.
|
>
>
>
>
>
<
<
<
<
<
<
<
<
<
<
<
|
|
|
>
>
>
>
>
>
>
>
>
>
<
|
|
<
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|
17
18
19
20
21
22
23
24
25
26
27
28
29
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
142
143
144
145
146
147
148
149
150
|
#import "OFKernelEventObserver.h"
#import "OFLHAArchiveEntry.h"
#import "OFString.h"
OF_ASSUME_NONNULL_BEGIN
@class OFStream;
@class OFURI;
/**
* @class OFLHAArchive OFLHAArchive.h ObjFW/OFLHAArchive.h
*
* @brief A class for accessing and manipulating LHA files.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFLHAArchive: OFObject
{
OFStream *_stream;
uint_least8_t _mode;
OFStringEncoding _encoding;
OFLHAArchiveEntry *_Nullable _currentEntry;
#ifdef OF_LHA_ARCHIVE_M
@public
#endif
OFStream *_Nullable _lastReturnedStream;
}
/**
* @brief The encoding to use for the archive. Defaults to ISO 8859-1.
*/
@property (nonatomic) OFStringEncoding encoding;
/**
* @brief Creates a new OFLHAArchive object with the specified stream.
*
* @param stream A stream from which the LHA archive will be read.
* For read and append mode, this needs to be an OFSeekableStream.
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return A new, autoreleased OFLHAArchive
*/
+ (instancetype)archiveWithStream: (OFStream *)stream mode: (OFString *)mode;
/**
* @brief Creates a new OFLHAArchive object with the specified file.
*
* @param URI The URI to the LHA file
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return A new, autoreleased OFLHAArchive
*/
+ (instancetype)archiveWithURI: (OFURI *)URI mode: (OFString *)mode;
/**
* @brief Creates a URI for accessing a the specified file within the specified
* LHA archive.
*
* @param path The path of the file within the archive
* @param URI The URI of the archive
* @return A URI for accessing the specified file within the specified LHA
* archive
*/
+ (OFURI *)URIForFilePath: (OFString *)path inArchiveWithURI: (OFURI *)URI;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Initializes an already allocated OFLHAArchive object with the
* specified stream.
*
* @param stream A stream from which the LHA archive will be read.
* For read and append mode, this needs to be an OFSeekableStream.
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return An initialized OFLHAArchive
*/
- (instancetype)initWithStream: (OFStream *)stream
mode: (OFString *)mode OF_DESIGNATED_INITIALIZER;
/**
* @brief Initializes an already allocated OFLHAArchive object with the
* specified file.
*
* @param URI The URI to the LHA file
* @param mode The mode for the LHA file. Valid modes are "r" for reading,
* "w" for creating a new file and "a" for appending to an existing
* archive.
* @return An initialized OFLHAArchive
*/
- (instancetype)initWithURI: (OFURI *)URI mode: (OFString *)mode;
/**
* @brief Returns the next entry from the LHA archive or `nil` if all entries
* have been read.
*
* @note This is only available in read mode.
*
* @warning Calling @ref nextEntry will invalidate all streams returned by
* @ref streamForReadingCurrentEntry or
* @ref streamForWritingEntry:! Reading from or writing to an
* invalidated stream will throw an @ref OFReadFailedException or
* @ref OFWriteFailedException!
*
* @return The next entry from the LHA archive or `nil` if all entries have
* been read
* @throw OFInvalidFormatException The archive's format is invalid
* @throw OFUnsupportedVersionException The archive's format is of an
* unsupported version
* @throw OFTruncatedDataException The archive was truncated
*/
- (nullable OFLHAArchiveEntry *)nextEntry;
/**
* @brief Returns a stream for reading the current entry.
*
* @note This is only available in read mode.
*
* @note The returned stream conforms to @ref OFReadyForReadingObserving if the
* underlying stream does so, too.
*
* @return A stream for reading the current entry
*/
- (OFStream *)streamForReadingCurrentEntry;
/**
* @brief Returns a stream for writing the specified entry.
*
* @note This is only available in write and append mode.
*
* @note The uncompressed size, compressed size and CRC16 of the specified
* entry are ignored.
|
143
144
145
146
147
148
149
150
151
152
153
154
|
* @param entry The entry for which a stream for writing should be returned
* @return A stream for writing the specified entry
*/
- (OFStream *)streamForWritingEntry: (OFLHAArchiveEntry *)entry;
/**
* @brief Closes the OFLHAArchive.
*/
- (void)close;
@end
OF_ASSUME_NONNULL_END
|
>
>
|
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
* @param entry The entry for which a stream for writing should be returned
* @return A stream for writing the specified entry
*/
- (OFStream *)streamForWritingEntry: (OFLHAArchiveEntry *)entry;
/**
* @brief Closes the OFLHAArchive.
*
* @throw OFNotOpenException The archive is not open
*/
- (void)close;
@end
OF_ASSUME_NONNULL_END
|