A class for reading, creating and modifying INI files. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFINIFile:

Instance Methods
(instancetype)	- initWithIRI:
	Initializes an already allocated OFINIFile with the contents of the specified file.

(instancetype)	- initWithIRI:encoding:
	Initializes an already allocated OFINIFile with the contents of the specified file in the specified encoding.

(OFINISection *)	- sectionForName:
	Returns an OFINISection for the section with the specified name.

(OFINISection *)	- categoryForName:
	Returns an OFINISection for the section with the specified name.

(void)	- writeToIRI:
	Writes the contents of the OFINIFile to a file.

(void)	- writeToIRI:encoding:
	Writes the contents of the OFINIFile to a file in the specified encoding.

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)	+ fileWithIRI:
	Creates a new OFINIFile with the contents of the specified file.

(instancetype)	+ fileWithIRI:encoding:
	Creates a new OFINIFile with the contents of the specified file in the specified encoding.

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
OFArray *	sections
	All sections in the INI file.

OFArray *	categories
	All sections in the INI file.

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 reading, creating and modifying INI files.

Method Documentation

◆ categoryForName:

- (OFINISection *) categoryForName: (OFString *) name

Returns an OFINISection for the section with the specified name.

Deprecated: Use sectionForName: instead.

Parameters

name	The name of the section for which an OFINISection should be returned

Returns: An OFINISection for the section with the specified name

◆ fileWithIRI:

+ (instancetype) fileWithIRI: (OFIRI *) IRI

Creates a new OFINIFile with the contents of the specified file.

Parameters

IRI	The IRI to the file whose contents the OFINIFile should contain

Returns: A new, autoreleased OFINIFile with the contents of the specified file

Exceptions

OFInvalidFormatException	The format of the specified INI file is invalid
OFInvalidEncodingException	The INI file is not in the specified encoding

◆ fileWithIRI:encoding:

+ (instancetype) fileWithIRI:		(OFIRI *)	IRI
encoding:		(OFStringEncoding)	encoding

Creates a new OFINIFile with the contents of the specified file in the specified encoding.

Parameters

IRI	The IRI to the file whose contents the OFINIFile should contain
encoding	The encoding of the specified file

Returns: A new, autoreleased OFINIFile with the contents of the specified file

Exceptions

OFInvalidFormatException	The format of the specified INI file is invalid
OFInvalidEncodingException	The INI file is not in the specified encoding

◆ initWithIRI:

- (instancetype) initWithIRI: (OFIRI *) IRI

Initializes an already allocated OFINIFile with the contents of the specified file.

Parameters

IRI	The IRI to the file whose contents the OFINIFile should contain

Returns: An initialized OFINIFile with the contents of the specified file

Exceptions

OFInvalidFormatException	The format of the specified INI file is invalid
OFInvalidEncodingException	The INI file is not in the specified encoding

◆ initWithIRI:encoding:

- (instancetype) initWithIRI:		(OFIRI *)	IRI
encoding:		(OFStringEncoding)	encoding

Initializes an already allocated OFINIFile with the contents of the specified file in the specified encoding.

Parameters

IRI	The IRI to the file whose contents the OFINIFile should contain
encoding	The encoding of the specified file

Returns: An initialized OFINIFile with the contents of the specified file

Exceptions

OFInvalidFormatException	The format of the specified INI file is invalid
OFInvalidEncodingException	The INI file is not in the specified encoding

◆ sectionForName:

- (OFINISection *) sectionForName: (OFString *) name

Returns an OFINISection for the section with the specified name.

Parameters

name	The name of the section for which an OFINISection should be returned

Returns: An OFINISection for the section with the specified name

◆ writeToIRI:

- (void) writeToIRI: (OFIRI *) IRI

Writes the contents of the OFINIFile to a file.

Parameters

IRI	The IRI of the file to write to

◆ writeToIRI:encoding:

- (void) writeToIRI:		(OFIRI *)	IRI
encoding:		(OFStringEncoding)	encoding

Writes the contents of the OFINIFile to a file in the specified encoding.

Parameters

IRI	The IRI of the file to write to
encoding	The encoding to use

Property Documentation

◆ categories

- (OFArray *) categories

readnonatomicassign

All sections in the INI file.

Deprecated: Use sections instead.

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

src/OFINIFile.h
src/OFINIFile.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ categoryForName:

◆ fileWithIRI:

◆ fileWithIRI:encoding:

◆ initWithIRI:

◆ initWithIRI:encoding:

◆ sectionForName:

◆ writeToIRI:

◆ writeToIRI:encoding:

Property Documentation

◆ categories