OFTarArchiveEntry.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

 
@class OFDate;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFNumber;

typedef OFArchiveEntryFileType OFTarArchiveEntryType
#if defined(__clang__) || OF_GCC_VERSION >= 405
    OF_DEPRECATED(ObjFW, 1, 5, "Use OFArchiveEntryFileType instead")
#endif
;
 
#if OF_GCC_VERSION >= 405
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
static const OFTarArchiveEntryType OFTarArchiveEntryTypeFile
    OF_DEPRECATED(ObjFW, 1, 5, "Use OFArchiveFileEntryTypeRegular instead") =
    (OFTarArchiveEntryType)'0';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeLink
    OF_DEPRECATED(ObjFW, 1, 5, "Use OFArchiveEntryFileTypeLink instead") =
    (OFTarArchiveEntryType)'1';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeSymlink
    OF_DEPRECATED(ObjFW, 1, 5,
    "Use OFArchiveEntryFileTypeSymbolicLink instead") =
    (OFTarArchiveEntryType)'2';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeCharacterDevice
    OF_DEPRECATED(ObjFW, 1, 5,
    "Use OFArchiveEntryFileTypeCharacterDevice instead") =
    (OFTarArchiveEntryType)'3';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeBlockDevice
    OF_DEPRECATED(ObjFW, 1, 5,
    "Use OFArchiveEntryFileTypeBlockDevice instead") =
    (OFTarArchiveEntryType)'4';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeDirectory
    OF_DEPRECATED(ObjFW, 1, 5, "Use OFArchiveEntryFileTypeDirectory instead") =
    (OFTarArchiveEntryType)'5';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeFIFO
    OF_DEPRECATED(ObjFW, 1, 5, "Use OFArchiveEntryFileTypeFIFO instead") =
    (OFTarArchiveEntryType)'6';

static const OFTarArchiveEntryType OFTarArchiveEntryTypeContiguousFile
    OF_DEPRECATED(ObjFW, 1, 5,
    "Use OFArchiveEntryFileTypeContiguousFile instead") =
    (OFTarArchiveEntryType)'7';
#if OF_GCC_VERSION >= 405
# pragma GCC diagnostic pop
#endif

@interface OFTarArchiveEntry: OFObject <OFArchiveEntry, OFCopying,
    OFMutableCopying>
{
    OFString *_fileName;
    OFNumber *_POSIXPermissions, *_ownerAccountID, *_groupOwnerAccountID;
    unsigned long long _compressedSize, _uncompressedSize;
    OFDate *_modificationDate;
    OFArchiveEntryFileType _fileType;
    OFString *_Nullable _targetFileName;
    OFString *_Nullable _ownerAccountName;
    OFString *_Nullable _groupOwnerAccountName;
    unsigned long _deviceMajor, _deviceMinor;
    OFMutableDictionary OF_GENERIC(OFString *, OFData *) *_extendedHeader;
    OF_RESERVE_IVARS(OFTarArchiveEntry, 3)
}

#if OF_GCC_VERSION >= 405
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
@property (readonly, nonatomic) OFTarArchiveEntryType type
    OF_DEPRECATED(ObjFW, 1, 5, "Use -[OFArchiveEntry fileType] instead");
#if OF_GCC_VERSION >= 405
# pragma GCC diagnostic pop
#endif

@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFDictionary OF_GENERIC(OFString *, OFData *) *extendedHeader;

@property OF_NULLABLE_PROPERTY (readonly, retain, nonatomic)
    OFNumber *amigaProtection;

@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *amigaComment;
 
- (instancetype)init OF_UNAVAILABLE;
@end
 
OF_ASSUME_NONNULL_END
 
#import "OFMutableTarArchiveEntry.h"