lib-lib/list.h

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19
  20 /*
  21  * Copyright notice from original mutt:
  22  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  23  */
  24
  25 #ifndef MUTT_LIB_LIB_LIST_H
  26 #define MUTT_LIB_LIB_LIST_H
  27
  28 #include "mem.h"
  29 #include "str.h"
  30
  31 #define DO_SLIST(type, prefix, dtor)                                         \
  32     static inline type *prefix##_list_pop(type **list) {                     \
  33         if (*list) {                                                         \
  34             type *res = *list;                                               \
  35             *list = res->next;                                               \
  36             res->next = NULL;                                                \
  37             return res;                                                      \
  38         }                                                                    \
  39         return NULL;                                                         \
  40     }                                                                        \
  41     static inline void prefix##_list_push(type **list, type *item) {         \
  42         item->next = *list;                                                  \
  43         *list = item;                                                        \
  44     }                                                                        \
  45                                                                              \
  46     static inline type **prefix##_list_last(type **list) {                   \
  47         while (*list) {                                                      \
  48             list = &(*list)->next;                                           \
  49         }                                                                    \
  50         return list;                                                         \
  51     }                                                                        \
  52                                                                              \
  53     static inline type **prefix##_list_append(type **list, type *item) {     \
  54         list = prefix##_list_last(list);                                     \
  55         *list = item;                                                        \
  56         return list;                                                         \
  57     }                                                                        \
  58                                                                              \
  59     static inline type **prefix##_list_init(type **list) {                   \
  60         *list = NULL;                                                        \
  61         return list;                                                         \
  62     }                                                                        \
  63     static inline void prefix##_list_wipe(type **list) {                     \
  64         while (*list) {                                                      \
  65             type *item = prefix##_list_pop(list);                            \
  66             dtor(&item);                                                     \
  67         }                                                                    \
  68     }                                                                        \
  69
  70
  71 typedef struct string_list_t {
  72     struct string_list_t *next;
  73     char *data;
  74 } string_list_t;
  75
  76 DO_INIT(string_list_t, string_item);
  77 static inline void string_item_wipe(string_list_t *it) {
  78     p_delete(&it->data);
  79 }
  80 DO_NEW(string_list_t, string_item);
  81 DO_DELETE(string_list_t, string_item);
  82 DO_SLIST(string_list_t, string, string_item_delete);
  83
  84 string_list_t *string_list_dup(const string_list_t *);
  85
  86 /* FIXME: b0rken API's, replace that at any cost */
  87 /* add an element to a list */
  88 string_list_t *mutt_add_list_n(string_list_t*, const void*, size_t len);
  89 static inline string_list_t *mutt_add_list(string_list_t *head, const char *data) {
  90     size_t len = m_strlen(data);
  91     return mutt_add_list_n(head, data, len ? len + 1 : 0);
  92 }
  93
  94 #endif /* MUTT_LIB_LIB_LIST_H */