OFZIPArchive.h

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFString.h"
#import "OFZIPArchiveEntry.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFSeekableStream;
@class OFStream;
@class OFZIPArchive;
 
@protocol OFZIPArchiveDelegate <OFObject>
@optional
- (nullable OFSeekableStream *)archive: (OFZIPArchive *)archive
             wantsPartNumbered: (unsigned int)partNumber
            lastPartNumber: (unsigned int)lastPartNumber;
@end
 
OF_SUBCLASSING_RESTRICTED
@interface OFZIPArchive: OFObject
{
#ifdef OF_ZIP_ARCHIVE_M
@public
#endif
    OFObject <OFZIPArchiveDelegate> *_Nullable _delegate;
    OF_KINDOF(OFStream *) _stream;
    int64_t _offset;
    uint_least8_t _mode;
    uint32_t _diskNumber, _lastDiskNumber;
@protected
    uint32_t _centralDirectoryDisk;
    uint64_t _centralDirectoryEntriesInDisk, _centralDirectoryEntries;
    uint64_t _centralDirectorySize;
    int64_t _centralDirectoryOffset;
    OFString *_Nullable _archiveComment;
#ifdef OF_ZIP_ARCHIVE_M
@public
#endif
    OFMutableArray OF_GENERIC(OFZIPArchiveEntry *) *_entries;
    OFMutableDictionary OF_GENERIC(OFString *, OFZIPArchiveEntry *)
        *_pathToEntryMap;
    OFStream *_Nullable _lastReturnedStream;
}
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    OFObject <OFZIPArchiveDelegate> *delegate;
 
@property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *archiveComment;
 
@property (readonly, nonatomic)
    OFArray OF_GENERIC(OFZIPArchiveEntry *) *entries;
 
+ (instancetype)archiveWithStream: (OFStream *)stream mode: (OFString *)mode;
 
+ (instancetype)archiveWithIRI: (OFIRI *)IRI mode: (OFString *)mode;
 
+ (OFIRI *)IRIForFilePath: (OFString *)path inArchiveWithIRI: (OFIRI *)IRI;
 
- (instancetype)init OF_UNAVAILABLE;
 
- (instancetype)initWithStream: (OFStream *)stream
              mode: (OFString *)mode OF_DESIGNATED_INITIALIZER;
 
- (instancetype)initWithIRI: (OFIRI *)IRI mode: (OFString *)mode;
 
- (OFStream *)streamForReadingFile: (OFString *)path;
 
- (OFStream *)streamForWritingEntry: (OFZIPArchiveEntry *)entry;
 
- (void)close;
@end
 
#ifdef __cplusplus
extern "C" {
#endif
extern uint32_t _OFZIPArchiveReadField32(const uint8_t *_Nonnull *_Nonnull,
    uint16_t *_Nonnull) OF_VISIBILITY_HIDDEN;
extern uint64_t _OFZIPArchiveReadField64(const uint8_t *_Nonnull *_Nonnull,
    uint16_t *_Nonnull) OF_VISIBILITY_HIDDEN;
#ifdef __cplusplus
}
#endif
 
OF_ASSUME_NONNULL_END