OFZIPArchive.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#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;

@interface OFZIPArchive: OFObject
{
    OFSeekableStream *_stream;
    uint32_t _diskNumber, _centralDirectoryDisk;
    uint64_t _centralDirectoryEntriesInDisk, _centralDirectoryEntries;
    uint64_t _centralDirectorySize;
    int64_t _centralDirectoryOffset;
    OFString *_Nullable _archiveComment;
    OFMutableArray OF_GENERIC(OFZIPArchiveEntry *) *_entries;
    OFMutableDictionary OF_GENERIC(OFString *, OFZIPArchiveEntry *)
        *_pathToEntryMap;
    OFStream *_Nullable _lastReturnedStream;
}

@property (readonly, nonatomic) OFString *archiveComment;

+ (instancetype)archiveWithSeekableStream: (OFSeekableStream *)stream;

#ifdef OF_HAVE_FILES

+ (instancetype)archiveWithPath: (OFString *)path;
#endif

- init OF_UNAVAILABLE;

- initWithSeekableStream: (OFSeekableStream *)stream OF_DESIGNATED_INITIALIZER;

#ifdef OF_HAVE_FILES

- initWithPath: (OFString *)path;
#endif

- (OFArray OF_GENERIC(OFZIPArchiveEntry *) *)entries;

- (OFStream *)streamForReadingFile: (OFString *)path;
@end

OF_ASSUME_NONNULL_END