X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Flist.h;h=4762c3b2ae81cfd77942ea61de0623151b659da0;hb=32841198fc4373115f71761a05088d10f0826223;hp=e05acfb0291bdd73b7e5e9ba77b2db3a5ed2a731;hpb=2708af4ade1a189c58adb4a6e543ea80be781730;p=bertos.git diff --git a/mware/list.h b/mware/list.h index e05acfb0..4762c3b2 100755 --- a/mware/list.h +++ b/mware/list.h @@ -1,8 +1,10 @@ /*! * \file - * Copyright (C) 2003,2004 Develer S.r.l. (http://www.develer.com/) - * Copyright (C) 2001 Bernardo Innocenti + * * * \version $Id$ * @@ -11,33 +13,69 @@ * \brief General pourpose double-linked lists */ -/* - * $Log$ - * Revision 1.5 2004/07/20 23:45:01 bernie - * Finally remove redundant protos. - * - * Revision 1.4 2004/07/18 22:12:53 bernie - * Fix warnings with GCC 3.3.2. - * - * Revision 1.3 2004/07/18 22:01:43 bernie - * REMHEAD(), REMTAIL(): Move to list.h as inline functions. - * - * Revision 1.2 2004/06/03 11:27:09 bernie - * Add dual-license information. - * - * Revision 1.1 2004/05/23 15:43:16 bernie - * Import mware modules. - * - */ +/*#* + *#* $Log$ + *#* Revision 1.11 2004/12/31 16:44:11 bernie + *#* list_remHead(), list_remTail(): Name like normal functions. + *#* + *#* Revision 1.10 2004/11/28 23:21:05 bernie + *#* Remove obsolete INITLIST macro. + *#* + *#* Revision 1.9 2004/10/21 09:37:55 bernie + *#* Revamp documentation. + *#* + *#* Revision 1.8 2004/10/19 08:46:34 bernie + *#* Fix header. + *#* + *#* Revision 1.7 2004/08/25 14:12:09 rasky + *#* Aggiornato il comment block dei log RCS + *#* + *#* Revision 1.6 2004/07/30 14:34:10 rasky + *#* Vari fix per documentazione e commenti + *#* Aggiunte PP_CATn e STATIC_ASSERT + *#* + *#* Revision 1.5 2004/07/20 23:45:01 bernie + *#* Finally remove redundant protos. + *#* + *#* Revision 1.4 2004/07/18 22:12:53 bernie + *#* Fix warnings with GCC 3.3.2. + *#* + *#* Revision 1.3 2004/07/18 22:01:43 bernie + *#* REMHEAD(), REMTAIL(): Move to list.h as inline functions. + *#* + *#* Revision 1.2 2004/06/03 11:27:09 bernie + *#* Add dual-license information. + *#* + *#* Revision 1.1 2004/05/23 15:43:16 bernie + *#* Import mware modules. + *#* + *#*/ #ifndef MWARE_LIST_H #define MWARE_LIST_H +#include // INLINE + +/*! + * This structure represents a node for bidirectional lists. + * + * Data is usually appended to nodes by making them the first + * field of another struture, as a poor-man's form of inheritance. + */ typedef struct _Node { struct _Node *succ; struct _Node *pred; } Node; +/*! + * Head of a doubly-linked list of \c Node structs. + * + * Lists must be initialized with LIST_INIT() prior to use. + * + * Nodes can be added and removed from either end of the list + * with O(1) performance. Iterating over these lists can be + * tricky: use the FOREACHNODE() macro instead. + */ typedef struct _List { Node *head; @@ -46,23 +84,24 @@ typedef struct _List } List; -/*! Template for a list of \a T structures */ +/*! Template for a list of \a T structures. */ #define DECLARE_LIST(T) \ struct { T *head; T *null; T *tail; } -/*! Template for a node in a list of \a T structures */ +/*! Template for a node in a list of \a T structures. */ #define DECLARE_NODE(T) \ struct { T *succ; T *pred; } -/*! Template for a node in a list of \a T structures */ +/*! Template for a node in a list of \a T structures. */ #define DECLARE_NODE_ANON(T) \ T *succ; T *pred; /*! - * Iterate over all nodes in a list. This statement defines a for cicle - * accepting the following parameters: - * \param n node pointer to be used in each iteration - * \param l pointer to list + * Iterate over all nodes in a list. + * + * This macro generates a "for" statement using the following parameters: + * \param n Node pointer to be used in each iteration. + * \param l Pointer to list. */ #define FOREACHNODE(n,l) \ for( \ @@ -71,15 +110,15 @@ typedef struct _List (n) = (typeof(n))(((Node *)(n))->succ) \ ) -/*! Initialize a list */ -#define INITLIST(l) \ +/*! Initialize a list. */ +#define LIST_INIT(l) \ do { \ (l)->head = (Node *)(&(l)->null); \ (l)->null = NULL; \ (l)->tail = (Node *)(&(l)->head); \ } while (0) -/*! Add node to list head */ +/*! Add node to list head. */ #define ADDHEAD(l,n) \ do { \ (n)->succ = (l)->head; \ @@ -88,7 +127,7 @@ typedef struct _List (l)->head = (n); \ } while (0) -/*! Add node to list tail */ +/*! Add node to list tail. */ #define ADDTAIL(l,n) \ do { \ (n)->succ = (Node *)(&(l)->null); \ @@ -98,9 +137,10 @@ typedef struct _List } while (0) /*! - * Insert node \a n before node \a ln - * Note: you can't pass in a list header as \a ln, but - * it is safe to pass list-\>head of an empty list. + * Insert node \a n before node \a ln. + * + * \note You can't pass in a list header as \a ln, but + * it is safe to pass list-\>head of an empty list. */ #define INSERTBEFORE(n,ln) \ do { \ @@ -110,21 +150,27 @@ typedef struct _List (ln)->pred = (n); \ } while (0) -/*! Remove \a n from whatever list it is in */ +/*! + * Remove \a n from whatever list it is in. + * + * \note Removing a node that has not previously been + * inserted into a list invokes undefined behavior. + */ #define REMOVE(n) \ do { \ (n)->pred->succ = (n)->succ; \ (n)->succ->pred = (n)->pred; \ } while (0) -/*! Tell whether a list is empty */ +/*! Tell whether a list is empty. */ #define ISLISTEMPTY(l) ( (l)->head == (Node *)(&(l)->null) ) /*! - * \name Unlink a node from the head of the list \a l. + * Unlink a node from the head of the list \a l. + * * \return Pointer to node, or NULL if the list was empty. */ -INLINE Node *REMHEAD(List *l) +INLINE Node *list_remHead(List *l) { Node *n; @@ -138,10 +184,11 @@ INLINE Node *REMHEAD(List *l) } /*! - * \name Unlink a node from the tail of the list \a l. + * Unlink a node from the tail of the list \a l. + * * \return Pointer to node, or NULL if the list was empty. */ -INLINE Node *REMTAIL(List *l) +INLINE Node *list_remTail(List *l) { Node *n; @@ -154,4 +201,8 @@ INLINE Node *REMTAIL(List *l) return n; } +/* OBSOLETE names */ +#define REMHEAD list_remHead +#define REMTAIL list_remTail + #endif /* MWARE_LIST_H */