git.meshlink.io Git - meshlink/blob - src/list.h

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