OFCharacterSet Class Reference

A class cluster representing a character set. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFCharacterSet:

Instance Methods
(instancetype)	- initWithCharactersInString:
	Initializes an already allocated character set with the characters of the specified string.
(instancetype)	- initWithRange:
	Initializes an already allocated character set with the characters in the specified range.
(bool)	- characterIsMember:
	Returns whether the specified character is a member of the character set.
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)	+ characterSetWithCharactersInString:
	Creates a new character set containing the characters of the specified string.
(instancetype)	+ characterSetWithRange:
	Creates a new character set containing the characters in the specified range.
(OFCharacterSet *)	+ whitespaceCharacterSet
	A character set containing all Unicode characters in the category Zs plus CHARACTER TABULATION (U+0009).
(OFCharacterSet *)	+ IRISchemeAllowedCharacterSet
	Returns the characters allowed in the scheme part of an IRI.
(OFCharacterSet *)	+ IRIHostAllowedCharacterSet
	Returns the characters allowed in the host part of an IRI.
(OFCharacterSet *)	+ IRIUserAllowedCharacterSet
	Returns the characters allowed in the user part of an IRI.
(OFCharacterSet *)	+ IRIPasswordAllowedCharacterSet
	Returns the characters allowed in the password part of an IRI.
(OFCharacterSet *)	+ IRIPathAllowedCharacterSet
	Returns the characters allowed in the path part of an IRI.
(OFCharacterSet *)	+ IRIQueryAllowedCharacterSet
	Returns the characters allowed in the query part of an IRI.
(OFCharacterSet *)	+ IRIQueryKeyValueAllowedCharacterSet
	Returns the characters allowed in a key/value in the query part of a IRI.
(OFCharacterSet *)	+ IRIFragmentAllowedCharacterSet
	Returns the characters allowed in the fragment part of an IRI.
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
OFCharacterSet *	invertedSet
	The inverted set, containing only the characters that do not exist in the receiver.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.

Detailed Description

A class cluster representing a character set.

Note

Subclasses must implement characterIsMember: (OFCharacterSet).

Method Documentation

characterIsMember:

- (bool) characterIsMember:

(OFUnichar)

character

Returns whether the specified character is a member of the character set.

Parameters

character

The character that is checked for being a member of the character set

Returns

Whether the specified character is a member of the character set.

characterSetWithCharactersInString:

+ (instancetype) characterSetWithCharactersInString:

(OFString *)

characters

Creates a new character set containing the characters of the specified string.

Parameters

characters

The characters for the character set

Returns

A new OFCharacterSet

characterSetWithRange:

+ (instancetype) characterSetWithRange:

(OFRange)

range

Creates a new character set containing the characters in the specified range.

Parameters

range

The range of characters for the character set

Returns

A new OFCharacterSet

initWithCharactersInString:

- (instancetype) initWithCharactersInString:

(OFString *)

characters

Initializes an already allocated character set with the characters of the specified string.

Parameters

characters

The characters for the character set

Returns

An initialized OFCharacterSet

initWithRange:

- (instancetype) initWithRange:

(OFRange)

range

Initializes an already allocated character set with the characters in the specified range.

Parameters

range

The range of characters for the character set

Returns

An initialized OFCharacterSet

IRIFragmentAllowedCharacterSet

+ (OFCharacterSet *) IRIFragmentAllowedCharacterSet

Returns the characters allowed in the fragment part of an IRI.

Returns

The characters allowed in the fragment part of an IRI.

IRIHostAllowedCharacterSet

+ (OFCharacterSet *) IRIHostAllowedCharacterSet

Returns the characters allowed in the host part of an IRI.

Returns

The characters allowed in the host part of an IRI.

IRIPasswordAllowedCharacterSet

+ (OFCharacterSet *) IRIPasswordAllowedCharacterSet

Returns the characters allowed in the password part of an IRI.

Returns

The characters allowed in the password part of an IRI.

IRIPathAllowedCharacterSet

+ (OFCharacterSet *) IRIPathAllowedCharacterSet

Returns the characters allowed in the path part of an IRI.

Returns

The characters allowed in the path part of an IRI.

IRIQueryAllowedCharacterSet

+ (OFCharacterSet *) IRIQueryAllowedCharacterSet

Returns the characters allowed in the query part of an IRI.

Returns

The characters allowed in the query part of an IRI.

IRIQueryKeyValueAllowedCharacterSet

+ (OFCharacterSet *) IRIQueryKeyValueAllowedCharacterSet

Returns the characters allowed in a key/value in the query part of a IRI.

Returns

The characters allowed in a key/value in the query part of an IRI.

IRISchemeAllowedCharacterSet

+ (OFCharacterSet *) IRISchemeAllowedCharacterSet

Returns the characters allowed in the scheme part of an IRI.

Returns

The characters allowed in the scheme part of an IRI.

IRIUserAllowedCharacterSet

+ (OFCharacterSet *) IRIUserAllowedCharacterSet

Returns the characters allowed in the user part of an IRI.

Returns

The characters allowed in the user part of an IRI.

---

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

• src/OFCharacterSet.h
• src/OFCharacterSet.m