X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Flist.h;h=e8dec766d234e5ec70b9d3f9b0bb8e44cda232f2;hb=258c7dc15d2c4815c0996fc98fdc0155d99adfea;hp=744f60bc1765f16e6b4ea8acd5672f842f0cd066;hpb=76c53bfa0136be55cf17e57b1ee098e5dfeefa70;p=bertos.git

diff --git a/mware/list.h b/mware/list.h
index 744f60bc..e8dec766 100755
--- a/mware/list.h
+++ b/mware/list.h
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
@@ -15,6 +15,21 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.20  2006/07/19 12:56:28  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.19  2006/03/20 17:50:29  bernie
+ *#* Fix typo.
+ *#*
+ *#* Revision 1.18  2006/02/27 22:40:21  bernie
+ *#* Add support for poor pre-C99 compilers.
+ *#*
+ *#* Revision 1.17  2006/02/24 01:18:34  bernie
+ *#* LIST_ENQUEUE(): New macro; Remove obsolete names.
+ *#*
+ *#* Revision 1.16  2006/01/23 23:10:38  bernie
+ *#* REVERSE_FOREACH_NODE(): New macro; FOREACHNODE(): Rename to FOREACH_NODE.
+ *#*
  *#* Revision 1.15  2005/11/04 16:20:02  bernie
  *#* Fix reference to README.devlib in header.
  *#*
@@ -68,7 +83,7 @@
 #include <cfg/compiler.h> /* INLINE */
 #include <cfg/debug.h> /* ASSERT() */
 
-/*!
+/**
  * This structure represents a node for bidirectional lists.
  *
  * Data is usually appended to nodes by making them the first
@@ -80,14 +95,14 @@ typedef struct _Node
 	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.
+ * tricky: use the FOREACH_NODE() macro instead.
  */
 typedef struct _List
 {
@@ -95,8 +110,17 @@ typedef struct _List
 	Node tail;
 } List;
 
+/**
+ * Extended node for priority queues.
+ */
+typedef struct _PriNode
+{
+	Node link;
+	int  pri;
+} PriNode;
+
 
-/*!
+/**
  * Template for a naked node in a list of \a T structures.
  *
  * To be used as data member in other structures:
@@ -118,9 +142,9 @@ typedef struct _List
  *        Foo *fp;
  *
  *        LIST_INIT(&foo_list);
- *        LIST_ADDHEAD(&foo_list, &foo1);
- *        INSERTBEFORE(&foo_list, &foo2);
- *        FOREACHNODE(fp, &foo_list)
+ *        ADDHEAD(&foo_list, &foo1);
+ *        INSERT_BEFORE(&foo_list, &foo2);
+ *        FOREACH_NODE(fp, &foo_list)
  *		fp->a = 10;
  *    }
  *
@@ -129,11 +153,11 @@ typedef struct _List
 #define DECLARE_NODE_ANON(T) \
 	T *succ; T *pred;
 
-/*! Declare a typesafe node for structures of type \a T. */
+/** Declare a typesafe node for structures of type \a T. */
 #define DECLARE_NODE_TYPE(T) \
 	typedef struct T##Node { T *succ; T *pred; } T##Node
 
-/*! Template for a list of \a T structures. */
+/** Template for a list of \a T structures. */
 #define DECLARE_LIST_TYPE(T) \
 	DECLARE_NODE_TYPE(T); \
 	typedef struct T##List { \
@@ -144,45 +168,66 @@ typedef struct _List
 #define NODE_TYPE(T) T##Node
 #define LIST_TYPE(T) T##List
 
-/*!
+/**
  * Get a pointer to the first node in a list.
  *
  * If \a l is empty, result points to l->tail.
  */
 #define LIST_HEAD(l) ((l)->head.succ)
 
-/*!
+/**
  * Get a pointer to the last node in a list.
  *
  * If \a l is empty, result points to l->head.
  */
 #define LIST_TAIL(l) ((l)->tail.pred)
 
-/*!
+// TODO: move in compiler.h
+#if COMPILER_TYPEOF
+	#define TYPEOF_OR_VOIDPTR(type) typeof(type)
+#else
+	#define TYPEOF_OR_VOIDPTR(type) void *
+#endif
+
+/**
  * 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) \
+#define FOREACH_NODE(n, l) \
 	for( \
-		(n) = (typeof(n))LIST_HEAD(l); \
+		(n) = (TYPEOF_OR_VOIDPTR(n))LIST_HEAD(l); \
 		((Node *)(n))->succ; \
-		(n) = (typeof(n))(((Node *)(n))->succ) \
+		(n) = (TYPEOF_OR_VOIDPTR(n))(((Node *)(n))->succ) \
 	)
 
-/*! Initialize a list. */
+/**
+ * Iterate backwards 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 REVERSE_FOREACH_NODE(n, l) \
+	for( \
+		(n) = (TYPEOF_OR_VOIDPTR(n))LIST_TAIL(l); \
+		((Node *)(n))->pred; \
+		(n) = (TYPEOF_OR_VOIDPTR(n))(((Node *)(n))->pred) \
+	)
+
+/** Initialize a list. */
 #define LIST_INIT(l) \
 	do { \
-		(l)->head.succ = (typeof((l)->head.succ)) &(l)->tail; \
+		(l)->head.succ = (TYPEOF_OR_VOIDPTR((l)->head.succ)) &(l)->tail; \
 		(l)->head.pred = NULL; \
 		(l)->tail.succ = NULL; \
-		(l)->tail.pred = (typeof((l)->tail.pred)) &(l)->head; \
+		(l)->tail.pred = (TYPEOF_OR_VOIDPTR((l)->tail.pred)) &(l)->head; \
 	} while (0)
 
 #ifdef _DEBUG
-	/*! Make sure that a list is valid (it was initialized and is not corrupted). */
+	/** Make sure that a list is valid (it was initialized and is not corrupted). */
 	#define LIST_ASSERT_VALID(l) \
 		do { \
 			Node *n, *pred; \
@@ -191,7 +236,7 @@ typedef struct _List
 			ASSERT((l)->tail.succ == NULL); \
 			ASSERT((l)->tail.pred != NULL); \
 			pred = &(l)->head; \
-			FOREACHNODE(n, l) \
+			FOREACH_NODE(n, l) \
 			{ \
 				ASSERT(n->pred == pred); \
 				pred = n; \
@@ -205,7 +250,7 @@ typedef struct _List
 	#define INVALIDATE_NODE(n) do {} while (0)
 #endif
 
-/*! Add node to list head. */
+/** Add node to list head. */
 #define ADDHEAD(l,n) \
 	do { \
 		ASSERT(l); \
@@ -216,7 +261,7 @@ typedef struct _List
 		(n)->pred->succ = (n); \
 	} while (0)
 
-/*! Add node to list tail. */
+/** Add node to list tail. */
 #define ADDTAIL(l,n) \
 	do { \
 		ASSERT(l); \
@@ -227,7 +272,7 @@ typedef struct _List
 		(l)->tail.pred = (n); \
 	} while (0)
 
-/*!
+/**
  * Insert node \a n before node \a ln.
  *
  * \note You can't pass in a list header as \a ln, but
@@ -241,7 +286,7 @@ typedef struct _List
 		(ln)->pred = (n); \
 	} while (0)
 
-/*!
+/**
  * Remove \a n from whatever list it is in.
  *
  * \note Removing a node that has not previously been
@@ -254,10 +299,27 @@ typedef struct _List
 		INVALIDATE_NODE(n); \
 	} while (0)
 
-/*! Tell whether a list is empty. */
+/** Tell whether a list is empty. */
 #define LIST_EMPTY(l)  ( (void *)((l)->head.succ) == (void *)(&(l)->tail) )
 
-/*!
+/**
+ * Insert a priority node in a priority queue.
+ *
+ * The new node is inserted immediately before the
+ * first node with lower priority or appended to
+ * the tail if no such node exists.
+ */
+#define LIST_ENQUEUE(list, node) \
+	do { \
+		PriNode *ln; \
+		FOREACH_NODE(ln, (list)) \
+			if (ln->pri < (node)->pri) \
+				break; \
+		INSERT_BEFORE(&(node)->link, &ln->link); \
+	} while (0)
+
+
+/**
  * Unlink a node from the head of the list \a l.
  *
  * \return Pointer to node, or NULL if the list was empty.
@@ -277,7 +339,7 @@ INLINE Node *list_remHead(List *l)
 	return n;
 }
 
-/*!
+/**
  * Unlink a node from the tail of the list \a l.
  *
  * \return Pointer to node, or NULL if the list was empty.
@@ -297,11 +359,4 @@ INLINE Node *list_remTail(List *l)
 	return n;
 }
 
-/* OBSOLETE names */
-#define REMHEAD list_remHead
-#define REMTAIL list_remTail
-#define INSERTBEFORE INSERT_BEFORE
-#define ISLISTEMPTY LIST_EMPTY
-
-
 #endif /* MWARE_LIST_H */