mspdebug/util/list.h

57 lines
1.7 KiB
C

/* MSPDebug - debugging tool for MSP430 MCUs
* Copyright (C) 2009, 2010 Daniel Beer
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LIST_H_
#define LIST_H_
/* This is the list node definition. It's intended to be embedded within
* another data structure.
*
* All lists are circular and doubly-linked. So, to iterate over the
* members of a list, do something like this:
*
* struct list_node *n;
*
* for (n = list->next; n != list; n = n->next) {
* ...
* }
*
* An empty list must be created first with list_init(). This sets the
* next and prev pointers to the list head itself.
*/
struct list_node {
struct list_node *next;
struct list_node *prev;
};
/* Check to see if a list contains anything. */
#define LIST_EMPTY(h) ((h)->next == (h))
/* Create an empty list */
void list_init(struct list_node *head);
/* Add an item to a list. The item will appear before the item
* specified as after.
*/
void list_insert(struct list_node *item, struct list_node *after);
/* Remove a node from its containing list. */
void list_remove(struct list_node *item);
#endif