List object

/*
**	(c) COPYRIGHT MIT 1995.
**	Please first read the full copyright statement in the file COPYRIGH.
*/
The list object is a generic container for storing collections of things in order. In principle it could be implemented in many ways, but in practice knowing that it is a linked list is important for speed.

This module is implemented by HTList.c, and it is a part of the W3C Reference Library.

#ifndef HTLIST_H
#define HTLIST_H

typedef struct _HTList HTList;

struct _HTList {
  void * object;
  HTList * next;
};

Creation and Deletion Methods

These two functions create and deletes a list
extern HTList *	HTList_new	(void);
extern BOOL	HTList_delete	(HTList *me);

Add an Element to List

A new list element is added to the beginning of the list so that it is first element just after the head element.
extern BOOL	HTList_addObject (HTList *me, void *newObject);
You can also append an element to the end of the list (the end is the first entered object) by using the following function:
extern BOOL HTList_appendObject (HTList * me, void * newObject);

Remove List Elements

extern BOOL	HTList_removeObject		(HTList *me, void *oldObject);
extern void *	HTList_removeLastObject		(HTList *me);
extern void *	HTList_removeFirstObject	(HTList *me);

Size of a List

Two small function to ask for the size
#define 	HTList_isEmpty(me)		(me ? me->next == NULL : YES)
extern int	HTList_count			(HTList *me);

Reference List Elements By Index

In some situations is is required to use an index in order to refer to a list element. This is for example the case if an element can be registered multiple times.
extern int	HTList_indexOf	(HTList *me, void *object);
extern void *	HTList_objectAt	(HTList *me, int position);

Find Last Element Added

#define		HTList_lastObject(me) \
		((me) && (me)->next ? (me)->next->object : NULL)

Traverse list

Fast macro to traverse the list. Call it first with copy of list header: it returns the first object and increments the passed list pointer. Call it with the same variable until it returns NULL.
#define		HTList_nextObject(me) \
		((me) && ((me) = (me)->next) ? (me)->object : NULL)

Free list

#define HTList_free(x)  HT_FREE(x)

#endif /* HTLIST_H */

end