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

OF_ASSUME_NONNULL_BEGIN

@class OFDate;
@class OFNumber;

typedef enum {
    OFArchiveEntryFileTypeRegular                 = '0',
    OFArchiveEntryFileTypeLink                    = '1',
    OFArchiveEntryFileTypeSymbolicLink            = '2',
    OFArchiveEntryFileTypeCharacterDevice         = '3',
    OFArchiveEntryFileTypeBlockDevice             = '4',
    OFArchiveEntryFileTypeDirectory               = '5',
    OFArchiveEntryFileTypeFIFO                    = '6',
    OFArchiveEntryFileTypeContiguousFile          = '7',
    OFArchiveEntryFileTypePAXGlobalExtendedHeader = 'g',
    OFArchiveEntryFileTypePAXExtendedHeader       = 'x',
    OFArchiveEntryFileTypeUnknown                 = 0x100,
} OFArchiveEntryFileType;

@protocol OFArchiveEntry <OFObject>

@property (readonly, copy, nonatomic) OFString *fileName;

@property (readonly, nonatomic) OFArchiveEntryFileType fileType;

@property (readonly, nonatomic) unsigned long long compressedSize;

@property (readonly, nonatomic) unsigned long long uncompressedSize;

@optional
@property (readonly, retain, nonatomic) OFDate *modificationDate;

@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *fileComment;

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

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

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

@property OF_NULLABLE_PROPERTY (readonly, retain, nonatomic)
    OFString *ownerAccountName;

@property OF_NULLABLE_PROPERTY (readonly, retain, nonatomic)
    OFString *groupOwnerAccountName;

@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *targetFileName;

@property (readonly, nonatomic) unsigned long deviceMajor;

@property (readonly, nonatomic) unsigned long deviceMinor;
@end

OF_ASSUME_NONNULL_END

#import "OFMutableArchiveEntry.h"