OFGZIPStream.h

/*
 * Copyright (c) 2008-2024 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 "OFStream.h"
#import "OFDate.h"
 
@class OFInflateStream;
 
OF_ASSUME_NONNULL_BEGIN
 
typedef enum {
    OFGZIPStreamOperatingSystemFAT         =   0,
    OFGZIPStreamOperatingSystemAmiga       =   1,
    OFGZIPStreamOperatingSystemVMS         =   2,
    OFGZIPStreamOperatingSystemUNIX        =   3,
    OFGZIPStreamOperatingSystemVM_CMS      =   4,
    OFGZIPStreamOperatingSystemAtariTOS    =   5,
    OFGZIPStreamOperatingSystemHPFS        =   6,
    OFGZIPStreamOperatingSystemMacintosh   =   7,
    OFGZIPStreamOperatingSystemZSystem     =   8,
    OFGZIPStreamOperatingSystemCPM         =   9,
    OFGZIPStreamOperatingSystemTOPS20      =  10,
    OFGZIPStreamOperatingSystemNTFS        =  11,
    OFGZIPStreamOperatingSystemQDO         =  12,
    OFGZIPStreamOperatingSystemAcornRISCOS =  13,
    OFGZIPStreamOperatingSystemUnknown     = 255
} OFGZIPStreamOperatingSystem;
 
OF_SUBCLASSING_RESTRICTED
@interface OFGZIPStream: OFStream
{
    OFStream *_stream;
    OFInflateStream *_Nullable _inflateStream;
    enum {
        OFGZIPStreamStateID1,
        OFGZIPStreamStateID2,
        OFGZIPStreamStateCompressionMethod,
        OFGZIPStreamStateFlags,
        OFGZIPStreamStateModificationDate,
        OFGZIPStreamStateExtraFlags,
        OFGZIPStreamStateOperatingSystem,
        OFGZIPStreamStateExtraLength,
        OFGZIPStreamStateExtra,
        OFGZIPStreamStateName,
        OFGZIPStreamStateComment,
        OFGZIPStreamStateHeaderCRC16,
        OFGZIPStreamStateData,
        OFGZIPStreamStateCRC32,
        OFGZIPStreamStateUncompressedSize
    } _state;
    enum {
        OFGZIPStreamFlagText        = 0x01,
        OFGZIPStreamFlagHeaderCRC16 = 0x02,
        OFGZIPStreamFlagExtra       = 0x04,
        OFGZIPStreamFlagName        = 0x08,
        OFGZIPStreamFlagComment     = 0x10
    } _flags;
    uint8_t _extraFlags;
    OFGZIPStreamOperatingSystem _operatingSystemMadeOn;
    size_t _bytesRead;
    uint8_t _buffer[4];
    OFDate *_Nullable _modificationDate;
    uint16_t _extraLength;
    uint32_t _CRC32, _uncompressedSize;
}
 
@property (readonly, nonatomic)
    OFGZIPStreamOperatingSystem operatingSystemMadeOn;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFDate *modificationDate;
 
+ (instancetype)streamWithStream: (OFStream *)stream mode: (OFString *)mode;
 
- (instancetype)init OF_UNAVAILABLE;
 
- (instancetype)initWithStream: (OFStream *)stream
              mode: (OFString *)mode OF_DESIGNATED_INITIALIZER;
@end
 
OF_ASSUME_NONNULL_END