OFZIPArchiveEntry.h

Go to the documentation of this file.

/*
 * 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 "OFArchiveEntry.h"

OF_ASSUME_NONNULL_BEGIN

typedef enum {
    OFZIPArchiveEntryCompressionMethodNone      =  0,
    OFZIPArchiveEntryCompressionMethodShrink    =  1,
    OFZIPArchiveEntryCompressionMethodReduceFactor1 =  2,
    OFZIPArchiveEntryCompressionMethodReduceFactor2 =  3,
    OFZIPArchiveEntryCompressionMethodReduceFactor3 =  4,
    OFZIPArchiveEntryCompressionMethodReduceFactor4 =  5,
    OFZIPArchiveEntryCompressionMethodImplode   =  6,
    OFZIPArchiveEntryCompressionMethodDeflate   =  8,
    OFZIPArchiveEntryCompressionMethodDeflate64 =  9,
    OFZIPArchiveEntryCompressionMethodBZIP2     = 12,
    OFZIPArchiveEntryCompressionMethodLZMA      = 14,
    OFZIPArchiveEntryCompressionMethodWavPack   = 97,
    OFZIPArchiveEntryCompressionMethodPPMd      = 98
} OFZIPArchiveEntryCompressionMethod;

typedef enum {
    OFZIPArchiveEntryAttributeCompatibilityMSDOS        =  0,
    OFZIPArchiveEntryAttributeCompatibilityAmiga        =  1,
    OFZIPArchiveEntryAttributeCompatibilityOpenVMS      =  2,
    OFZIPArchiveEntryAttributeCompatibilityUNIX     =  3,
    OFZIPArchiveEntryAttributeCompatibilityVM_CMS       =  4,
    OFZIPArchiveEntryAttributeCompatibilityAtariST      =  5,
    OFZIPArchiveEntryAttributeCompatibilityOS2HPFS      =  6,
    OFZIPArchiveEntryAttributeCompatibilityMacintosh    =  7,
    OFZIPArchiveEntryAttributeCompatibilityZSystem      =  8,
    OFZIPArchiveEntryAttributeCompatibilityCPM      =  9,
    OFZIPArchiveEntryAttributeCompatibilityWindowsNTFS  = 10,
    OFZIPArchiveEntryAttributeCompatibilityMVS      = 11,
    OFZIPArchiveEntryAttributeCompatibilityVSE      = 12,
    OFZIPArchiveEntryAttributeCompatibilityAcornRISCOS  = 13,
    OFZIPArchiveEntryAttributeCompatibilityVFAT     = 14,
    OFZIPArchiveEntryAttributeCompatibilityAlternateMVS = 15,
    OFZIPArchiveEntryAttributeCompatibilityBeOS     = 16,
    OFZIPArchiveEntryAttributeCompatibilityTandem       = 17,
    OFZIPArchiveEntryAttributeCompatibilityOS400        = 18,
    OFZIPArchiveEntryAttributeCompatibilityOSX      = 19
} OFZIPArchiveEntryAttributeCompatibility;

typedef enum {
    OFZIPArchiveEntryExtraFieldTagZIP64 = 0x0001
} OFZIPArchiveEntryExtraFieldTag;

@class OFString;
@class OFData;
@class OFFile;
@class OFDate;

@interface OFZIPArchiveEntry: OFObject <OFArchiveEntry, OFCopying,
    OFMutableCopying>
{
    OFZIPArchiveEntryAttributeCompatibility _versionMadeBy;
    OFZIPArchiveEntryAttributeCompatibility _minVersionNeeded;
    uint16_t _generalPurposeBitFlag;
    OFZIPArchiveEntryCompressionMethod _compressionMethod;
    uint16_t _lastModifiedFileTime, _lastModifiedFileDate;
    uint32_t _CRC32;
    unsigned long long _compressedSize, _uncompressedSize;
    OFString *_fileName;
    OFData *_Nullable _extraField;
    OFString *_Nullable _fileComment;
    uint32_t _startDiskNumber;
    uint16_t _internalAttributes;
    uint32_t _versionSpecificAttributes;
    int64_t _localFileHeaderOffset;
    OF_RESERVE_IVARS(OFZIPArchiveEntry, 4)
}

@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFData *extraField;

@property (readonly, nonatomic)
    OFZIPArchiveEntryAttributeCompatibility versionMadeBy;

@property (readonly, nonatomic)
    OFZIPArchiveEntryAttributeCompatibility minVersionNeeded;

@property (readonly, nonatomic)
    OFZIPArchiveEntryCompressionMethod compressionMethod;

@property (readonly, nonatomic) uint32_t CRC32;

@property (readonly, nonatomic) uint32_t versionSpecificAttributes;

@property (readonly, nonatomic) uint16_t generalPurposeBitFlag;

- (instancetype)init OF_UNAVAILABLE;
@end

#ifdef __cplusplus
extern "C" {
#endif

extern OFString *OFZIPArchiveEntryVersionToString(uint16_t version);

extern OFString *OFZIPArchiveEntryCompressionMethodName(
    OFZIPArchiveEntryCompressionMethod compressionMethod);

extern size_t OFZIPArchiveEntryExtraFieldFind(OFData *extraField,
    OFZIPArchiveEntryExtraFieldTag tag, uint16_t *size);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END

#import "OFMutableZIPArchiveEntry.h"