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

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFZooArchive:

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

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

(nullable OFZooArchiveEntry *)	- nextEntry
	Returns the next entry from the Zoo archive or `nil` if all entries have been read.

(OFStream *)	- streamForReadingCurrentEntry
	Returns a stream for reading the current entry.

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

(void)	- close
	Closes the OFZooArchive.

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 OFZooArchive object with the specified stream.

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

(OFIRI *)	+ IRIForFilePath:inArchiveWithIRI:
	Creates an IRI for accessing the specified file within the specified Zoo 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
OFStringEncoding	encoding
	The encoding to use for the archive. Defaults to UTF-8.

OFString *	archiveComment
	The archive comment.

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 Zoo files.

Method Documentation

◆ archiveWithIRI:mode:

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

Creates a new OFZooArchive object with the specified file.

Parameters

IRI	The IRI to the Zoo file
mode	The mode for the Zoo file. Valid modes are "r" for reading and "w" for creating a new file.

Returns: A new, autoreleased OFZooArchive

◆ archiveWithStream:mode:

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

Creates a new OFZooArchive object with the specified stream.

Parameters

stream	A stream from which the Zoo archive will be read. This needs to be an OFSeekableStream. For writing, the stream needs to support both reading and writing at the same time.
mode	The mode for the Zoo file. Valid modes are "r" for reading and "w" for creating a new file.

Returns: A new, autoreleased OFZooArchive

◆ close

- (void) close

Closes the OFZooArchive.

Exceptions

OFNotOpenException The archive is not open

◆ initWithIRI:mode:

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

Initializes an already allocated OFZooArchive object with the specified file.

Parameters

IRI	The IRI to the Zoo file
mode	The mode for the Zoo file. Valid modes is "r" for reading and "w" for creating a new file.

Returns: An initialized OFZooArchive

◆ initWithStream:mode:

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

Initializes an already allocated OFZooArchive object with the specified stream.

Parameters

stream	A stream from which the Zoo archive will be read. This needs to be an OFSeekableStream. For writing, the stream needs to support both reading and writing at the same time.
mode	The mode for the Zoo file. Valid modes are "r" for reading and "w" for creating a new file.

Returns: An initialized OFZooArchive

◆ IRIForFilePath:inArchiveWithIRI:

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

Creates an IRI for accessing the specified file within the specified Zoo 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 Zoo archive

◆ nextEntry

- (OFZooArchiveEntry *) nextEntry

Returns the next entry from the Zoo archive or nil if all entries have been read.

Note: This is only available in read mode.

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

Returns: The next entry from the Zoo archive or nil if all entries have been read

Exceptions

OFInvalidFormatException	The archive's format is invalid
OFUnsupportedVersionException	The archive's format is of an unsupported version
OFTruncatedDataException	The archive was truncated

◆ streamForReadingCurrentEntry

- (OFStream *) streamForReadingCurrentEntry

Returns a stream for reading the current entry.

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

Returns: A stream for reading the current entry

Exceptions

OFSeekFailedException Seeking to the data in the archive failed

◆ streamForWritingEntry:

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

Returns a stream for writing the specified entry.

Note: This 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 returned by streamForReadingCurrentEntry or streamForWritingEntry:! Reading from or writing to an invalidated stream will throw an OFReadFailedException or OFWriteFailedException!

Parameters

entry

The entry for which a stream for writing should be returned.
The following parts of the specified entry will be ignored:

The header type.
The minimum version needed.
The compressed size.
The uncompressed size.
The CRC16.

Returns: A stream for writing the specified entry

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

src/OFZooArchive.h
src/OFZooArchive.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ archiveWithIRI:mode:

◆ archiveWithStream:mode:

◆ close

◆ initWithIRI:mode:

◆ initWithStream:mode:

◆ IRIForFilePath:inArchiveWithIRI:

◆ nextEntry

◆ streamForReadingCurrentEntry

◆ streamForWritingEntry: