ObjFW
Instance Methods | Class Methods | Properties | List of all members
OFLHAArchive Class Reference

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

#import <ObjFW/OFLHAArchive.h>

Inheritance diagram for OFLHAArchive:
Inheritance graph
[legend]
Collaboration diagram for OFLHAArchive:
Collaboration graph
[legend]

Instance Methods

(instancetype) - initWithStream:mode:
 Initializes an already allocated OFLHAArchive object with the specified stream. More...
 
(instancetype) - initWithPath:mode:
 Initializes an already allocated OFLHAArchive object with the specified file. More...
 
(nullable OFLHAArchiveEntry *) - nextEntry
 Returns the next entry from the LHA archive or nil if all entries have been read. More...
 
(OFStream *) - streamForWritingEntry:
 Returns a stream for writing the specified entry. More...
 
(void) - close
 Closes the OFLHAArchive.
 
- Instance Methods inherited from OFObject
(instancetype) - init
 Initializes an already allocated object. More...
 
(nullable OFMethodSignature *) - methodSignatureForSelector:
 Returns the method signature for the specified selector. More...
 
(void) - dealloc
 Deallocates the object. More...
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay. More...
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay. More...
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:withObject:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread. More...
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object. More...
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread. More...
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay. More...
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(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. More...
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver. More...
 
- Instance Methods inherited from <OFObject>
(unsigned long) - hash
 Returns a 32 bit hash for the object. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - allowsWeakReference
 Returns whether the object allows weak references. More...
 
(bool) - isKindOfClass:
 Returns a boolean whether the object of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(nullable IMP- methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable id- performSelector:
 Performs the specified selector. More...
 
(nullable id- performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id- performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id- performSelector:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id- performSelector:withObject:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(instancetype) - retain
 Increases the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(instancetype) - autorelease
 Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More...
 
(instancetype) - self
 Returns the receiver. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 

Class Methods

(instancetype) + archiveWithStream:mode:
 Creates a new OFLHAArchive object with the specified stream. More...
 
(instancetype) + archiveWithPath:mode:
 Creates a new OFLHAArchive object with the specified file. More...
 
- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime. More...
 
(void) + unload
 A method which is called when the class is unloaded from the runtime. More...
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made. More...
 
(instancetype) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(instancetype) + new
 Calls alloc on self and then init on the returned object. More...
 
(Class+ class
 Returns the class. More...
 
(OFString *) + className
 Returns the name of the class as a string. More...
 
(bool) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class. More...
 
(nullable Class+ superclass
 Returns the superclass of the class. More...
 
(bool) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector. More...
 
(bool) + conformsToProtocol:
 Checks whether the class conforms to a given protocol. More...
 
(nullable IMP+ instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector. More...
 
(nullable OFMethodSignature *) + instanceMethodSignatureForSelector:
 Returns the method signature of the instance method for the specified selector. More...
 
(OFString *) + description
 Returns a description for the class, which is usually the class name. More...
 
(nullable IMP+ replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class. More...
 
(nullable IMP+ replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class. More...
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver. More...
 
(bool) + resolveClassMethod:
 Try to resolve the specified class method. More...
 
(bool) + resolveInstanceMethod:
 Try to resolve the specified instance method. More...
 
(id+ copy
 Returns the class. More...
 

Properties

of_string_encoding_t encoding
 The encoding to use for the archive. Defaults to ISO 8859-1.
 
OFStreamstreamForReadingCurrentEntry
 A stream for reading the current entry. More...
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object. More...
 
OFStringstringBySerializing
 The object serialized as a string.
 

Detailed Description

A class for accessing and manipulating LHA files.

Method Documentation

◆ archiveWithPath:mode:

+ (instancetype) archiveWithPath: (OFString *)  path
mode: (OFString *)  mode 

Creates a new OFLHAArchive object with the specified file.

Parameters
pathThe path to the LHA file
modeThe mode for the LHA 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 OFLHAArchive

◆ archiveWithStream:mode:

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

Creates a new OFLHAArchive object with the specified stream.

Parameters
streamA stream from which the LHA archive will be read. For read and append mode, this needs to be an OFSeekableStream.
modeThe mode for the LHA 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 OFLHAArchive

◆ initWithPath:mode:

- (instancetype) initWithPath: (OFString *)  path
mode: (OFString *)  mode 

Initializes an already allocated OFLHAArchive object with the specified file.

Parameters
pathThe path to the LHA file
modeThe mode for the LHA file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive.
Returns
An initialized OFLHAArchive

◆ initWithStream:mode:

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

Initializes an already allocated OFLHAArchive object with the specified stream.

Parameters
streamA stream from which the LHA archive will be read. For read and append mode, this needs to be an OFSeekableStream.
modeThe mode for the LHA file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive.
Returns
An initialized OFLHAArchive

◆ nextEntry

- (OFLHAArchiveEntry *) nextEntry

Returns the next entry from the LHA 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 LHA archive or nil if all entries have been read

◆ streamForWritingEntry:

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

Returns a stream for writing the specified entry.

Note
This is only available in write and append mode.
The uncompressed size, compressed size and CRC16 of the specified entry are ignored.
The returned stream conforms to OFReadyForWritingObserving if the underlying stream does so, too.
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!
Parameters
entryThe entry for which a stream for writing should be returned
Returns
A stream for writing the specified entry

Property Documentation

◆ streamForReadingCurrentEntry

- (OFStream *) streamForReadingCurrentEntry
readnonatomicassign

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.

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