A class for parsing the program options specified on the command line. More...

#include <ObjFW/OFOptionsParser.h>

Inheritance diagram for OFOptionsParser:

Instance Methods
(instancetype)	- initWithOptions:
	Initializes an already allocated OFOptionsParser so that it accepts the specified options.

(OFUnichar)	- nextOption
	Returns the next option.

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)	+ parserWithOptions:
	Creates a new OFOptionsParser which accepts the specified options.

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
OFUnichar	lastOption
	The last parsed option.

OFString *	lastLongOption
	The long option for the last parsed option, or `nil` if the last parsed option was not passed as a long option by the user.

OFString *	argument
	The argument for the last parsed option, or `nil` if the last parsed option takes no argument.

OFArray *	remainingArguments
	The arguments following the last option.

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 parsing the program options specified on the command line.

Method Documentation

◆ initWithOptions:

- (instancetype) initWithOptions: (const OFOptionsParserOption *) options

Initializes an already allocated OFOptionsParser so that it accepts the specified options.

Parameters

options An array of OFOptionsParserOption specifying all accepted options, terminated with an option whose short option is \0 and long option is nil.

Returns: An initialized OFOptionsParser

◆ nextOption

- (OFUnichar) nextOption

Returns the next option.

If the option is only available as a long option, - is returned. Otherwise, the short option is returned, even if it was specified as a long option.
If an unknown option is specified, ? is returned.
If the argument for the option is missing, : is returned.
If there is an argument for the option even though it takes none, = is returned.
If all options have been parsed, \0 is returned.

Note: You need to call nextOption repeatedly until it returns \0 to make sure all options have been parsed, even if you only rely on the optional pointers specified and don't do any parsing yourself.

Returns: The next option

◆ parserWithOptions:

+ (instancetype) parserWithOptions: (const OFOptionsParserOption *) options

Creates a new OFOptionsParser which accepts the specified options.

Parameters

options An array of OFOptionsParserOption specifying all accepted options, terminated with an option whose short option is \0 and long option is nil.

Returns: A new, autoreleased OFOptionsParser

Property Documentation

◆ lastLongOption

- (OFString*) lastLongOption

readwriteatomic

The long option for the last parsed option, or nil if the last parsed option was not passed as a long option by the user.

In case nextOption returned ?, this contains the unknown long option.
In case it returned :, this contains the long option which is missing an argument.
In case it returned =, this contains the long option for which an argument was specified even though the option takes no argument.

Warning: Unlike lastOption, which returns the short option even if the user specified a long option, this only returns the long option if it was actually specified as a long option by the user.

◆ lastOption

- (OFUnichar) lastOption

readnonatomicassign

The last parsed option.

If nextOption returned ? or :, this returns the option which was unknown or for which the argument was missing.
If this returns -, the last option is only available as a long option (see lastLongOption).

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

src/OFOptionsParser.h
src/OFOptionsParser.m

Instance Methods

Class Methods

Properties