A class for accessing and manipulating ZIP files. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFZIPArchive:

Instance Methods
(instancetype)	- initWithStream:mode:
	Initializes an already allocated OFZIPArchive object with the specified stream.

(instancetype)	- initWithIRI:mode:
	Initializes an already allocated OFZIPArchive object with the specified file.

(OFStream *)	- streamForReadingFile:
	Returns a stream for reading the specified file from the archive.

(OFStream *)	- streamForWritingEntry:
	Returns a stream for writing the specified entry to the archive.

(void)	- close
	Closes the OFZIPArchive.

Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

(bool)	- isProxy
	Returns whether the object is a proxy object.

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(nullable id)	- performSelector:
	Performs the specified selector.

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(bool)	- isEqual:
	Checks two objects for equality.

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

Class Methods
(instancetype)	+ archiveWithStream:mode:
	Creates a new OFZIPArchive object with the specified stream.

(instancetype)	+ archiveWithIRI:mode:
	Creates a new OFZIPArchive object with the specified file.

(OFIRI *)	+ IRIForFilePath:inArchiveWithIRI:
	Creates an IRI for accessing the specified file within the specified ZIP archive.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ unload
	A method which is called when the class is unloaded from the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(nullable Class)	+ superclass
	Returns the superclass of the class.

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

(id)	+ copy
	Returns the class.

Properties
OFObject< OFZIPArchiveDelegate > *	delegate
	The delegate of the ZIP archive.

OFString *	archiveComment
	The archive comment.

OFArray *	entries
	The entries in the central directory of the archive as an array of objects of class OFZIPArchiveEntry.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class for accessing and manipulating ZIP files.

Method Documentation

◆ archiveWithIRI:mode:

+ (instancetype) archiveWithIRI:		(OFIRI *)	IRI
mode:		(OFString *)	mode

Creates a new OFZIPArchive object with the specified file.

Parameters

IRI	The IRI to the ZIP file
mode	The mode for the ZIP file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive.

Returns: A new, autoreleased OFZIPArchive

Exceptions

OFInvalidFormatException The format is not that of a valid ZIP archive

◆ archiveWithStream:mode:

+ (instancetype) archiveWithStream:		(OFStream *)	stream
mode:		(OFString *)	mode

Creates a new OFZIPArchive object with the specified stream.

Parameters

stream	A stream from which the ZIP archive will be read. For read and append mode, this needs to be an OFSeekableStream.
mode	The mode for the ZIP file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive.

Returns: A new, autoreleased OFZIPArchive

Exceptions

OFInvalidFormatException The format is not that of a valid ZIP archive

◆ close

- (void) close

Closes the OFZIPArchive.

Exceptions

OFNotOpenException The archive is not open

◆ initWithIRI:mode:

- (instancetype) initWithIRI:		(OFIRI *)	IRI
mode:		(OFString *)	mode

Initializes an already allocated OFZIPArchive object with the specified file.

Parameters

IRI	The IRI to the ZIP file
mode	The mode for the ZIP file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive.

Returns: An initialized OFZIPArchive

Exceptions

OFInvalidFormatException The format is not that of a valid ZIP archive

◆ initWithStream:mode:

- (instancetype) initWithStream:		(OFStream *)	stream
mode:		(OFString *)	mode

Initializes an already allocated OFZIPArchive object with the specified stream.

Parameters

stream	A stream from which the ZIP archive will be read. For read and append mode, this needs to be an OFSeekableStream.
mode	The mode for the ZIP file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive.

Returns: An initialized OFZIPArchive

Exceptions

OFInvalidFormatException The format is not that of a valid ZIP archive

◆ IRIForFilePath:inArchiveWithIRI:

+ (OFIRI *) IRIForFilePath:		(OFString *)	path
inArchiveWithIRI:		(OFIRI *)	IRI

Creates an IRI for accessing the specified file within the specified ZIP archive.

Parameters

path	The path of the file within the archive
IRI	The IRI of the archive

Returns: An IRI for accessing the specified file within the specified ZIP archive

◆ streamForReadingFile:

- (OFStream *) streamForReadingFile: (OFString *) path

Returns a stream for reading the specified file from the archive.

Note: This method is only available in read mode.; The returned stream conforms to OFReadyForReadingObserving if the underlying stream does so, too.

Warning: Calling streamForReadingFile: will invalidate all streams previously returned by streamForReadingFile: or streamForWritingEntry:! Reading from or writing to an invalidated stream will throw an OFReadFailedException or OFWriteFailedException!

Parameters

path	The path to the file inside the archive

Returns: A stream for reading the specified file form the archive

Exceptions

OFNotOpenException	The archive is not open
OFInvalidArgumentException	The archive is not in read mode
OFOpenItemFailedException	Opening the specified file within the archive failed
OFInvalidFormatException	The local header and the header in the central directory do not match enough
OFUnsupportedVersionException	The file uses a version of the ZIP format that is not supported

◆ streamForWritingEntry:

- (OFStream *) streamForWritingEntry: (OFZIPArchiveEntry *) entry

Returns a stream for writing the specified entry to the archive.

Note: This method is only available in write and append mode.; The returned stream conforms to OFReadyForWritingObserving if the underlying stream does so, too.

Warning: Calling streamForWritingEntry: will invalidate all streams previously returned by streamForReadingFile: or streamForWritingEntry:! Reading from or writing to an invalidated stream will throw an OFReadFailedException or OFWriteFailedException!

Parameters

entry

The entry to write to the archive.
The following parts of the specified entry will be ignored:

The lower 8 bits of the version made by.
The lower 8 bits of the minimum version needed.
The compressed size.
The uncompressed size.
The CRC32.
Bit 3 and 11 of the general purpose bit flag.

Returns: A stream for writing the specified entry to the archive

Exceptions

OFNotOpenException	The archive is not open
OFInvalidArgumentException	The archive is not in write mode
OFOpenItemFailedException	Opening the specified file within the archive failed. If OFOpenItemFailedException::errNo is `EEXIST`, it failed because there is already a file with the same name in the archive.
OFNotImplementedException	The desired compression method is not implemented

Property Documentation

◆ entries

- (OFArray *) entries

readnonatomicassign

The entries in the central directory of the archive as an array of objects of class OFZIPArchiveEntry.

The objects of the array have the same order as the entries in the central directory, which does not need to be the order in which the actual files are stored.

The documentation for this class was generated from the following files:

src/OFZIPArchive.h
src/OFZIPArchive.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ archiveWithIRI:mode:

◆ archiveWithStream:mode:

◆ close

◆ initWithIRI:mode:

◆ initWithStream:mode:

◆ IRIForFilePath:inArchiveWithIRI:

◆ streamForReadingFile:

◆ streamForWritingEntry:

Property Documentation

◆ entries