water::LinkedListPointer< ObjectType > Class Template Reference

#include <LinkedListPointer.h>

Classes
class	Appender

Public Member Functions
	LinkedListPointer () noexcept
	LinkedListPointer (ObjectType *const headItem) noexcept
LinkedListPointer &	operator= (ObjectType *const newItem) noexcept
	operator ObjectType * () const noexcept
ObjectType *	get () const noexcept
LinkedListPointer &	getLast () noexcept
int	size () const noexcept
LinkedListPointer &	operator[] (int index) noexcept
const LinkedListPointer &	operator[] (int index) const noexcept
bool	contains (const ObjectType *const itemToLookFor) const noexcept
void	insertNext (ObjectType *const newItem)
void	insertAtIndex (int index, ObjectType *newItem)
ObjectType *	replaceNext (ObjectType *const newItem) noexcept
void	append (ObjectType *const newItem)
void	addCopyOfList (const LinkedListPointer &other)
ObjectType *	removeNext () noexcept
void	remove (ObjectType *const itemToRemove)
void	deleteAll ()
LinkedListPointer *	findPointerTo (ObjectType *const itemToLookFor) noexcept
void	copyToArray (ObjectType **destArray) const noexcept
void	swapWith (LinkedListPointer &other) noexcept

Private Attributes
ObjectType *	item

Detailed Description

template<class ObjectType>
class water::LinkedListPointer< ObjectType >

Helps to manipulate singly-linked lists of objects.

For objects that are designed to contain a pointer to the subsequent item in the list, this class contains methods to deal with the list. To use it, the ObjectType class that it points to must contain a LinkedListPointer called nextListItem, e.g.

struct MyObject
{
    int x, y, z;
 
    // A linkable object must contain a member with this name and type, which must be
    // accessible by the LinkedListPointer class. (This doesn't mean it has to be public -
    // you could make your class a friend of a LinkedListPointer<MyObject> instead).
    LinkedListPointer<MyObject> nextListItem;
};
 
LinkedListPointer<MyObject> myList;
myList.append (new MyObject());
myList.append (new MyObject());
 
int numItems = myList.size(); // returns 2
MyObject* lastInList = myList.getLast();

Constructor & Destructor Documentation

LinkedListPointer() [1/2]

template<class ObjectType>

water::LinkedListPointer< ObjectType >::LinkedListPointer ( )

inlinenoexcept

Creates a null pointer to an empty list.

LinkedListPointer() [2/2]

template<class ObjectType>

water::LinkedListPointer< ObjectType >::LinkedListPointer ( ObjectType *const headItem )

inlineexplicitnoexcept

Creates a pointer to a list whose head is the item provided.

Member Function Documentation

addCopyOfList()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::addCopyOfList ( const LinkedListPointer< ObjectType > & other )

inline

Creates copies of all the items in another list and adds them to this one. This will use the ObjectType's copy constructor to try to create copies of each item in the other list, and appends them to this list.

append()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::append ( ObjectType *const newItem )

inline

Adds an item to the end of the list.

This operation involves iterating the whole list, so can be slow - if you need to append a number of items to your list, it's much more efficient to use the Appender class than to repeatedly call append().

contains()

template<class ObjectType>

bool water::LinkedListPointer< ObjectType >::contains ( const ObjectType *const itemToLookFor ) const

inlinenoexcept

Returns true if the list contains the given item.

copyToArray()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::copyToArray ( ObjectType ** destArray ) const

inlinenoexcept

Copies the items in the list to an array. The destArray must contain enough elements to hold the entire list - no checks are made for this!

deleteAll()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::deleteAll ( )

inline

Iterates the list, calling the delete operator on all of its elements and leaving this pointer empty.

findPointerTo()

template<class ObjectType>

LinkedListPointer * water::LinkedListPointer< ObjectType >::findPointerTo ( ObjectType *const itemToLookFor )

inlinenoexcept

Finds a pointer to a given item. If the item is found in the list, this returns the pointer that points to it. If the item isn't found, this returns null.

get()

template<class ObjectType>

ObjectType * water::LinkedListPointer< ObjectType >::get ( ) const

inlinenoexcept

Returns the item which this pointer points to.

getLast()

template<class ObjectType>

LinkedListPointer & water::LinkedListPointer< ObjectType >::getLast ( )

inlinenoexcept

Returns the last item in the list which this pointer points to. This will iterate the list and return the last item found. Obviously the speed of this operation will be proportional to the size of the list. If the list is empty the return value will be this object. If you're planning on appending a number of items to your list, it's much more efficient to use the Appender class than to repeatedly call getLast() to find the end.

insertAtIndex()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::insertAtIndex ( int index, ObjectType * newItem )

inline

Inserts an item at a numeric index in the list. Obviously this will involve iterating the list to find the item at the given index, so be careful about the impact this may have on execution time.

insertNext()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::insertNext ( ObjectType *const newItem )

inline

Inserts an item into the list, placing it before the item that this pointer currently points to.

operator ObjectType *()

template<class ObjectType>

water::LinkedListPointer< ObjectType >::operator ObjectType * ( ) const

inlinenoexcept

Returns the item which this pointer points to.

operator=()

template<class ObjectType>

LinkedListPointer & water::LinkedListPointer< ObjectType >::operator= ( ObjectType *const newItem )

inlinenoexcept

Sets this pointer to point to a new list.

operator[]() [1/2]

template<class ObjectType>

const LinkedListPointer & water::LinkedListPointer< ObjectType >::operator[] ( int index ) const

inlinenoexcept

Returns the item at a given index in the list. Since the only way to find an item is to iterate the list, this operation can obviously be slow, depending on its size, so you should be careful when using this in algorithms.

operator[]() [2/2]

template<class ObjectType>

LinkedListPointer & water::LinkedListPointer< ObjectType >::operator[] ( int index )

inlinenoexcept

Returns the item at a given index in the list. Since the only way to find an item is to iterate the list, this operation can obviously be slow, depending on its size, so you should be careful when using this in algorithms.

remove()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::remove ( ObjectType *const itemToRemove )

inline

Removes a specific item from the list. Note that this will not delete the item, it simply unlinks it from the list.

removeNext()

template<class ObjectType>

ObjectType * water::LinkedListPointer< ObjectType >::removeNext ( )

inlinenoexcept

Removes the head item from the list. This won't delete the object that is removed, but returns it, so the caller can delete it if necessary.

replaceNext()

template<class ObjectType>

ObjectType * water::LinkedListPointer< ObjectType >::replaceNext ( ObjectType *const newItem )

inlinenoexcept

Replaces the object that this pointer points to, appending the rest of the list to the new object, and returning the old one.

size()

template<class ObjectType>

int water::LinkedListPointer< ObjectType >::size ( ) const

inlinenoexcept

Returns the number of items in the list. Obviously with a simple linked list, getting the size involves iterating the list, so this can be a lengthy operation - be careful when using this method in your code.

swapWith()

template<class ObjectType>

void water::LinkedListPointer< ObjectType >::swapWith ( LinkedListPointer< ObjectType > & other )

inlinenoexcept

Swaps this pointer with another one

Member Data Documentation

item

template<class ObjectType>

ObjectType* water::LinkedListPointer< ObjectType >::item

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/containers/LinkedListPointer.h