/*
- * Sherlock Library -- Linked Lists
+ * UCW Library -- Linked Lists
*
- * (c) 1997--1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
+ * (c) 1997--1999 Martin Mares <mj@ucw.cz>
+ *
+ * This software may be freely distributed and used according to the terms
+ * of the GNU Lesser General Public License.
*/
-#ifndef _SHERLOCK_LISTS_H
-#define _SHERLOCK_LISTS_H
+#ifndef _UCW_LISTS_H
+#define _UCW_LISTS_H
+
+/*
+ * I admit the list structure is very tricky and also somewhat awkward,
+ * but it's both efficient and easy to manipulate once one understands the
+ * basic trick: The list head always contains two synthetic nodes which are
+ * always present in the list: the head and the tail. But as the `next'
+ * entry of the tail and the `prev' entry of the head are both NULL, the
+ * nodes can overlap each other:
+ *
+ * head head_node.next
+ * null head_node.prev tail_node.next
+ * tail tail_node.prev
+ */
typedef struct node {
struct node *next, *prev;
void init_list(list *);
void insert_node(node *, node *);
-#if !defined(_SHERLOCK_LISTS_C) && defined(__GNUC__)
+#if !defined(_UCW_LISTS_C) && defined(__GNUC__)
#define LIST_INLINE extern inline
#include "lib/lists.c"
#undef LIST_INLINE