www.tinc-vpn.org Git - tinc/blob - lib/list.h

   1 /*
   2     list.h -- header file for list.c
   3     Copyright (C) 2000,2001 Ivo Timmermans <itimmermans@bigfoot.com>
   4                   2000,2001 Guus Sliepen <guus@sliepen.warande.net>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20     $Id: list.h,v 1.1.2.5 2002/03/27 15:01:16 guus Exp $
  21 */
  22
  23 #ifndef __TINC_LIST_H__
  24 #define __TINC_LIST_H__
  25
  26 typedef struct list_node_t
  27 {
  28   struct list_node_t *prev;
  29   struct list_node_t *next;
  30
  31   /* Payload */
  32
  33   void *data;
  34 } list_node_t;
  35
  36 typedef void (*list_action_t) (const void *);
  37 typedef void (*list_action_node_t) (const list_node_t *);
  38
  39 typedef struct list_t
  40 {
  41   list_node_t *head;
  42   list_node_t *tail;
  43   int count;
  44
  45   /* Callbacks */
  46
  47   list_action_t delete;
  48 } list_t;
  49
  50 /* (De)constructors */
  51
  52 extern list_t *list_alloc(list_action_t);
  53 extern void list_free(list_t *);
  54 extern list_node_t *list_alloc_node(void);
  55 extern void list_free_node(list_t *, list_node_t *);
  56
  57 /* Insertion and deletion */
  58
  59 extern list_node_t *list_insert_head(list_t *, void *);
  60 extern list_node_t *list_insert_tail(list_t *, void *);
  61
  62 extern void list_unlink_node(list_t *, list_node_t *);
  63 extern void list_delete_node(list_t *, list_node_t *);
  64
  65 extern void list_delete_head(list_t *);
  66 extern void list_delete_tail(list_t *);
  67
  68 /* Head/tail lookup */
  69
  70 extern void *list_get_head(list_t *);
  71 extern void *list_get_tail(list_t *);
  72
  73 /* Fast list deletion */
  74
  75 extern void list_delete_list(list_t *);
  76
  77 /* Traversing */
  78
  79 extern void list_foreach(list_t *, list_action_t);
  80 extern void list_foreach_node(list_t *, list_action_node_t);
  81
  82 #endif /* __TINC_LIST_H__ */