OFZooArchive.h

/*
 * Copyright (c) 2008-2026 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 "OFSeekableStream.h"
#import "OFString.h"
#import "OFZooArchiveEntry.h"

OF_ASSUME_NONNULL_BEGIN

@class OFMutableSet OF_GENERIC(ObjectType);
@class OFNumber;

OF_SUBCLASSING_RESTRICTED
@interface OFZooArchive: OFObject
{
    OF_KINDOF(OFStream *) _stream;
    uint_least8_t _mode;
    OFStringEncoding _encoding;
    uint16_t _minVersionNeeded;
    uint8_t _headerType;
    OFString *_Nullable _archiveComment;
    OFZooArchiveEntry *_Nullable _currentEntry;
#ifdef OF_ZOO_ARCHIVE_M
@public
#endif
    OFStream *_Nullable _lastReturnedStream;
@protected
    OFStreamOffset _lastHeaderOffset;
    OFMutableSet OF_GENERIC(OFNumber *) *_seenHeaderOffsets;
    size_t _lastHeaderLength;
}

@property (nonatomic) OFStringEncoding encoding;

@property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *archiveComment;

+ (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;

- (nullable OFZooArchiveEntry *)nextEntry;

- (OFStream *)streamForReadingCurrentEntry;

- (OFStream *)streamForWritingEntry: (OFZooArchiveEntry *)entry;

- (void)close;
@end

OF_ASSUME_NONNULL_END