A class which provides easy to use double-linked lists. More...

#import <ObjFW/OFList.h>

Inheritance diagram for OFList:

Instance Methods
(of_list_object_t *)	- appendObject:
	Appends an object to the list. More...

(of_list_object_t *)	- prependObject:
	Prepends an object to the list. More...

(of_list_object_t *)	- insertObject:beforeListObject:
	Inserts an object before another list object. More...

(of_list_object_t *)	- insertObject:afterListObject:
	Inserts an object after another list object. More...

(void)	- removeListObject:
	Removes the object with the specified list object from the list. More...

(bool)	- containsObject:
	Checks whether the list contains an object equal to the specified object. More...

(bool)	- containsObjectIdenticalTo:
	Checks whether the list contains an object with the specified address. More...

(OFEnumerator *)	- objectEnumerator
	Returns an OFEnumerator to enumerate through all objects of the list. More...

(nullable ObjectType)	- firstObject
	Returns the first object of the list or `nil`. More...

(nullable ObjectType)	- lastObject
	Returns the last object of the list or `nil`. More...

(void)	- removeAllObjects
	Removes all objects from the list.

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...

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object. More...

Instance Methods inherited from <OFSerialization>
(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization. More...

(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element. More...

Class Methods
(instancetype)	+ list
	Creates a new OFList. 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...

Properties
	readonly

Detailed Description

A class which provides easy to use double-linked lists.

Method Documentation

◆ appendObject:()

- (of_list_object_t *) appendObject: (ObjectType) object

Appends an object to the list.

Parameters

object The object to append

Returns: An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.

◆ containsObject:()

- (bool) containsObject: (ObjectType) object

Checks whether the list contains an object equal to the specified object.

Parameters

object The object which is checked for being in the list

Returns: A boolean whether the list contains the specified object

◆ containsObjectIdenticalTo:()

- (bool) containsObjectIdenticalTo: (ObjectType) object

Checks whether the list contains an object with the specified address.

Parameters

object The object which is checked for being in the list

Returns: A boolean whether the list contains an object with the specified address

◆ firstObject()

- (id) firstObject

Returns the first object of the list or nil.

Warning: The returned object is not retained and autoreleased for performance reasons!

Returns: The first object of the list or nil

◆ insertObject:afterListObject:()

- (of_list_object_t *) insertObject:	(ObjectType)	object
afterListObject:	(of_list_object_t *)	listObject

Inserts an object after another list object.

Parameters

object	The object to insert
listObject	The of_list_object_t of the object after which it should be inserted

Returns: An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.

◆ insertObject:beforeListObject:()

- (of_list_object_t *) insertObject:	(ObjectType)	object
beforeListObject:	(of_list_object_t *)	listObject

Inserts an object before another list object.

Parameters

object	The object to insert
listObject	The of_list_object_t of the object before which it should be inserted

Returns: An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.

◆ lastObject()

- (id) lastObject

Returns the last object of the list or nil.

Warning: The returned object is not retained and autoreleased for performance reasons!

Returns: The last object of the list or nil

◆ list()

+ (instancetype) list

Creates a new OFList.

Returns: A new autoreleased OFList

◆ objectEnumerator()

- (OFEnumerator *) objectEnumerator

Returns an OFEnumerator to enumerate through all objects of the list.

Returns: An OFEnumerator to enumerate through all objects of the list

◆ prependObject:()

- (of_list_object_t *) prependObject: (ObjectType) object

Prepends an object to the list.

Parameters

object The object to prepend

Returns: An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.

◆ removeListObject:()

- (void) removeListObject: (of_list_object_t *) listObject

Removes the object with the specified list object from the list.

Parameters

listObject The list object returned by append / prepend

Property Documentation

◆ readonly

- readonly

readwriteatomic

The first list object of the list.

The last list object of the list.

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

src/OFList.h
src/OFList.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ appendObject:()

◆ containsObject:()

◆ containsObjectIdenticalTo:()

◆ firstObject()

◆ insertObject:afterListObject:()

◆ insertObject:beforeListObject:()

◆ lastObject()

◆ list()

◆ objectEnumerator()

◆ prependObject:()

◆ removeListObject:()

Property Documentation

◆ readonly