git.tinc-vpn.org Git - tinc/blob - src/list.h

   1 #ifndef TINC_LIST_H
   2 #define TINC_LIST_H
   3
   4 /*
   5     list.h -- header file for list.c
   6     Copyright (C) 2000-2005 Ivo Timmermans
   7                   2000-2012 Guus Sliepen <guus@tinc-vpn.org>
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17     GNU General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License along
  20     with this program; if not, write to the Free Software Foundation, Inc.,
  21     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22 */
  23
  24 typedef struct list_node_t {
  25         struct list_node_t *prev;
  26         struct list_node_t *next;
  27
  28         /* Payload */
  29
  30         void *data;
  31 } list_node_t;
  32
  33 typedef void (*list_action_t)(const void *data);
  34 typedef void (*list_action_node_t)(const list_node_t *node);
  35
  36 typedef struct list_t {
  37         list_node_t *head;
  38         list_node_t *tail;
  39         int count;
  40
  41         /* Callbacks */
  42
  43         list_action_t delete;
  44 } list_t;
  45
  46 /* (De)constructors */
  47
  48 extern void list_free(list_t *list);
  49 extern list_t *list_alloc(list_action_t delete) ATTR_MALLOC ATTR_DEALLOCATOR(list_free);
  50
  51 extern void list_free_node(list_t *list, list_node_t *node);
  52 extern list_node_t *list_alloc_node(void) ATTR_MALLOC ATTR_DEALLOCATOR(list_free_node);
  53
  54 /* Insertion and deletion */
  55
  56 extern list_node_t *list_insert_head(list_t *list, void *data);
  57 extern list_node_t *list_insert_tail(list_t *list, void *data);
  58 extern list_node_t *list_insert_after(list_t *list, list_node_t *node, void *data);
  59 extern list_node_t *list_insert_before(list_t *list, list_node_t *node, void *data);
  60
  61 extern void list_empty_list(list_t *list);
  62 extern void list_delete(list_t *list, const void *data);
  63
  64 extern void list_unlink_node(list_t *list, list_node_t *node);
  65 extern void list_delete_node(list_t *list, list_node_t *node);
  66
  67 extern void list_delete_head(list_t *list);
  68 extern void list_delete_tail(list_t *list);
  69
  70 /* Head/tail lookup */
  71
  72 extern void *list_get_head(list_t *list);
  73 extern void *list_get_tail(list_t *list);
  74
  75 /* Fast list deletion */
  76
  77 extern void list_delete_list(list_t *list);
  78
  79 /* Traversing */
  80
  81 extern void list_foreach(list_t *list, list_action_t action);
  82 extern void list_foreach_node(list_t *list, list_action_node_t action);
  83
  84 /*
  85    Iterates over a list.
  86
  87    CAUTION: while this construct supports deleting the current item,
  88    it does *not* support deleting *other* nodes while iterating on the list.
  89  */
  90 #define list_each(type, item, list) (type *item = (type *)1; item; item = NULL) for(list_node_t *node = (list)->head, *next; item = node ? node->data : NULL, next = node ? node->next : NULL, node; node = next)
  91
  92 #endif