# GSLinkedList documentation

rfm@gnu.org
2010 Free Software Foundation, Inc.
Software documentation for the GSLinkedList class
GSLinkedList.h
GSLinkedList manages a list of GSListLink objects.
Description forthcoming.
Description forthcoming.
Description forthcoming.
append:
link
Appends link at the end of the linked list managed by the receiver.
Retains the link.
count
Returns the number of links in the list.
empty
Remove all links from the list and release them all.
findEqual:
object
from:
start
back:
aFlag
Searches the linked list returning the link containing object or `nil` if it is not found.
The comparison is performed using the [NSObject -isEqual:] method of object.
If start is `nil` then the whole list is searched.
This method will not find links containing `nil` items.
findIdentical:
object
from:
start
back:
aFlag
Searches the linked list returning the link containing object or `nil` if it is not found.
If start is `nil` then the whole list is searched.
A direct pointer comparison is used to determine equality.
head
Returns the first link in the list.
insert:
link
after:
at
Inserts other immediately after the receiver.
Retains the link.
insert:
link
before:
at
Inserts other immediately before the receiver.
Retains the link.
removeLink:
link
Removes the link from the receiver.
releases the link.
tail
Returns the last link in the list.
Software documentation for the GSListLink class
GSLinkedList.h
GSListLink provides simple doubly linked list functionality to avoid the need to constantly re-invent it (as the OpenStep/Cocoa APIs do not provide this). The emphasis is on speed of operation so instance variables are directly accessible and inline functions are provided to manipulate them (without error cehcking), but you can/should avoid these direct access features unless speed is really critical.
A list may either be 'normal'... (where the head/tail ends of the list have a `nil` pointer to the previous/next link) or 'circular' in which case the list is not terminated.
The GSListLink item carries a minimal payload of a single item which is retained by the link.
The GSListLink owner is an optional pointer to an object which 'owns' the link... a GSLinkedList instance may use this to check link ownership when manipulating links.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
initCircular
Initialise the receiver as a link for a circular linked list.
item
Return the item in the link.
next
Return the next item in the list containing the receiver, or `nil` if there are no more items.
owner
Return the list which owns the receiver or `nil` if the receiver is not in a list.
previous
Return the previous item in the list containing the receiver, or `nil` if there are no more items.
setItem:
anItem
Set an item value by retaining it and releasing any previous value.
GSLinkedList types

Description forthcoming.
GSLinkedList functions

link
at
Inserts link after at in a circular list.
Arguments must not be `nil` and link must not be in a list (ie its next and previous pointers must point to itsself).
link
at
Inserts link before at in a circular list.
Arguments must not be `nil` and link must not be in a list (ie its next and previous pointers must point to itsself).
link
Removes link from any list it is in.
The link argument must not be `nil`.
link
at
Inserts link after at in a normal list.
Arguments must not be `nil` and link must not be in a list (ie its next and previous pointers must both be `nil`).
link
at
Inserts link before at in a normal list.
Arguments must not be `nil` and link must not be in a list (ie its next and previous pointers must both be `nil`).
link
Removes link from the list it is in.
The link argument must not be `nil`.
object
list
from
back
Searches from list to the end looking for the first link containing object (as determined by using object's [NSObject -isEqual:] method).
If from is `nil` the list is search from head or tail as appropriate to the direction in which it is searched.
object
list
from
back
Searches from list to the end looking for the first link containing object (as determined by direct pointer comparison).
If from is `nil` the list is search from head or tail as appropriate to the direction in which it is searched.
link
list
at
Inserts link immediately after at.
Updates the head, tail and count variables of list.
Does not retain link.
link
list
at
Inserts link immediately before at.
Updates the head, tail and count variables of list.
Does not retain link.
link
list
Moves the link to the head of the list if it is not already there.
link
list
Moves the link to the tail of the list if it is not already there.
link
list
Removes link from the list.
Updates the head, tail and count variables of list.
Does not release link.