OFZIPArchiveEntry.h

Go to the documentation of this file.

/*
 * 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"

OF_ASSUME_NONNULL_BEGIN

enum {
    OF_ZIP_ARCHIVE_ENTRY_COMPRESSION_METHOD_NONE      = 0,
    OF_ZIP_ARCHIVE_ENTRY_COMPRESSION_METHOD_DEFLATE   = 8,
    OF_ZIP_ARCHIVE_ENTRY_COMPRESSION_METHOD_DEFLATE64 = 9
};

enum of_zip_archive_entry_attribute_compatibility {
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_MSDOS         =  0,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_AMIGA         =  1,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_OPENVMS       =  2,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_UNIX          =  3,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_VM_CMS        =  4,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_ATARI_ST      =  5,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_OS2_HPFS      =  6,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_MACINTOSH     =  7,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_Z_SYSTEM      =  8,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_CP_M          =  9,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_WINDOWS_NTFS  = 10,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_MVS           = 11,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_VSE           = 12,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_ACORN_RISC    = 13,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_VFAT          = 14,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_ALTERNATE_MVS = 15,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_BEOS          = 16,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_TANDEM        = 17,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_OS_400        = 18,
    OF_ZIP_ARCHIVE_ENTRY_ATTR_COMPAT_OS_X          = 19
};

enum {
    OF_ZIP_ARCHIVE_ENTRY_EXTRA_FIELD_ZIP64 = 0x0001
};

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

@interface OFZIPArchiveEntry: OFObject
{
    uint16_t _versionMadeBy, _minVersionNeeded, _generalPurposeBitFlag;
    uint16_t _compressionMethod;
    uint16_t _lastModifiedFileTime, _lastModifiedFileDate;
    uint32_t _CRC32;
    uint64_t _compressedSize, _uncompressedSize;
    OFString *_fileName;
    OFData *_Nullable _extraField;
    OFString *_Nullable _fileComment;
    uint32_t _startDiskNumber;
    uint16_t _internalAttributes;
    uint32_t _versionSpecificAttributes;
    int64_t _localFileHeaderOffset;
}

@property (readonly, nonatomic) OFString *fileName;

@property (readonly, nonatomic) OFString *fileComment;

@property (readonly, nonatomic) uint16_t versionMadeBy;

@property (readonly, nonatomic) uint16_t minVersionNeeded;

@property (readonly, nonatomic) uint16_t compressionMethod;

@property (readonly, nonatomic) uint64_t compressedSize;

@property (readonly, nonatomic) uint64_t uncompressedSize;

@property (readonly, nonatomic) uint32_t CRC32;

@property (readonly, nonatomic) uint32_t versionSpecificAttributes;

@property (readonly, nonatomic) uint16_t generalPurposeBitFlag;

- init OF_UNAVAILABLE;

- (OFDate *)modificationDate;

- (OFData *)extraField;
@end

#ifdef __cplusplus
extern "C" {
#endif

extern OFString *of_zip_archive_entry_version_to_string(uint16_t version);

extern void of_zip_archive_entry_extra_field_find(OFData *extraField,
    uint16_t tag, const uint8_t *_Nonnull *_Nonnull data, uint16_t *size);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END