ObjFW
Instance Methods | Class Methods | List of all members
OFINIFile Class Reference

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

#import <ObjFW/OFINIFile.h>

Inheritance diagram for OFINIFile:
OFObject <OFObject>

Instance Methods

(id) - initWithPath:
 Initializes an already allocated OFINIFile with the contents of the specified file. More...
 
(id) - initWithPath:encoding:
 Initializes an already allocated OFINIFile with the contents of the specified file in the specified encoding. More...
 
(OFINICategory *) - categoryForName:
 Returns an OFINICategory for the category with the specified name. More...
 
(void) - writeToFile:
 Writes the contents of the OFINIFile to a file. More...
 
(void) - writeToFile:encoding:
 Writes the contents of the OFINIFile to a file in the specified encoding. More...
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object. More...
 
(OFString *) - className
 Returns the name of the object's class. More...
 
(OFString *) - description
 Returns a description for the object. More...
 
(nullable void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(nullable void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool. More...
 
(nullable void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size. More...
 
(nullable void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool. 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: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) - 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) - 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...
 
(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...
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver. More...
 
- Instance Methods inherited from <OFObject>
(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 const char *) - typeEncodingForSelector:
 Returns the type encoding 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...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - allowsWeakReference
 Returns whether the class allows weak references. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 

Class Methods

(instancetype) + fileWithPath:
 Creates a new OFINIFile with the contents of the specified file. More...
 
(instancetype) + fileWithPath:encoding:
 Creates a new OFINIFile with the contents of the specified file in the specified encoding. 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...
 
(id) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(id) + new
 Allocates memory for a new instance and calls init on it. 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 const char *) + typeEncodingForInstanceSelector:
 Returns the type encoding 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...
 
(nullable IMP) + replaceClassMethod:withImplementation:typeEncoding:
 Replaces or adds a class method. More...
 
(nullable IMP) + replaceInstanceMethod:withImplementation:typeEncoding:
 Replaces or adds an instance method. 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...
 

Detailed Description

A class for reading, creating and modifying INI files.

Method Documentation

◆ categoryForName:()

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

Returns an OFINICategory for the category with the specified name.

Parameters
nameThe name of the category for which an OFINICategory should be returned
Returns
An OFINICategory for the category with the specified name

◆ fileWithPath:()

+ (instancetype) fileWithPath: (OFString *)  path

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

Parameters
pathThe path to the file whose contents the OFINIFile should contain
Returns
A new, autoreleased OFINIFile with the contents of the specified file

◆ fileWithPath:encoding:()

+ (instancetype) fileWithPath: (OFString *)  path
encoding: (of_string_encoding_t encoding 

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

Parameters
pathThe path to the file whose contents the OFINIFile should contain
encodingThe encoding of the specified file
Returns
A new, autoreleased OFINIFile with the contents of the specified file

◆ initWithPath:()

- (id) initWithPath: (OFString *)  path

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

Parameters
pathThe path to the file whose contents the OFINIFile should contain
Returns
An initialized OFINIFile with the contents of the specified file

◆ initWithPath:encoding:()

- (id) initWithPath: (OFString *)  path
encoding: (of_string_encoding_t encoding 

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

Parameters
pathThe path to the file whose contents the OFINIFile should contain
encodingThe encoding of the specified file
Returns
An initialized OFINIFile with the contents of the specified file

◆ writeToFile:()

- (void) writeToFile: (OFString *)  path

Writes the contents of the OFINIFile to a file.

Parameters
pathThe path of the file to write to

◆ writeToFile:encoding:()

- (void) writeToFile: (OFString *)  path
encoding: (of_string_encoding_t encoding 

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

Parameters
pathThe path of the file to write to
encodingThe encoding to use

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