From a2d01907c5b24bab78cc055fa23354597bd44a03 Mon Sep 17 00:00:00 2001 From: Martin Mares Date: Mon, 15 Jan 2001 09:24:16 +0000 Subject: Added an explanatory comment. --- lib/lists.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'lib/lists.h') diff --git a/lib/lists.h b/lib/lists.h index acab292..5b36ec8 100644 --- a/lib/lists.h +++ b/lib/lists.h @@ -9,6 +9,19 @@ #ifndef _BIRD_LISTS_H_ #define _BIRD_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; } node; -- cgit v1.2.3