lib/libalpm/alpm_list.h

   1 /*
   2  *  alpm_list.h
   3  *
   4  *  Copyright (c) 2006-2011 Pacman Development Team <pacman-dev@archlinux.org>
   5  *  Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20 #ifndef _ALPM_LIST_H
  21 #define _ALPM_LIST_H
  22
  23 #include <stdlib.h> /* size_t */
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /**
  30  * @brief Linked list type used by libalpm.
  31  *
  32  * It is exposed so front ends can use it to prevent the need to reimplement
  33  * lists of their own; however, it is not required that the front end uses
  34  * it.
  35  */
  36 typedef struct __alpm_list_t {
  37         /** data held by the list node */
  38         void *data;
  39         /** pointer to the previous node */
  40         struct __alpm_list_t *prev;
  41         /** pointer to the next node */
  42         struct __alpm_list_t *next;
  43 } alpm_list_t;
  44
  45 #define FREELIST(p) do { alpm_list_free_inner(p, free); alpm_list_free(p); p = NULL; } while(0)
  46
  47 typedef void (*alpm_list_fn_free)(void *); /* item deallocation callback */
  48 typedef int (*alpm_list_fn_cmp)(const void *, const void *); /* item comparison callback */
  49
  50 /* allocation */
  51 void alpm_list_free(alpm_list_t *list);
  52 void alpm_list_free_inner(alpm_list_t *list, alpm_list_fn_free fn);
  53
  54 /* item mutators */
  55 alpm_list_t *alpm_list_add(alpm_list_t *list, void *data);
  56 alpm_list_t *alpm_list_add_sorted(alpm_list_t *list, void *data, alpm_list_fn_cmp fn);
  57 alpm_list_t *alpm_list_join(alpm_list_t *first, alpm_list_t *second);
  58 alpm_list_t *alpm_list_mmerge(alpm_list_t *left, alpm_list_t *right, alpm_list_fn_cmp fn);
  59 alpm_list_t *alpm_list_msort(alpm_list_t *list, size_t n, alpm_list_fn_cmp fn);
  60 alpm_list_t *alpm_list_remove_item(alpm_list_t *haystack, alpm_list_t *item);
  61 alpm_list_t *alpm_list_remove(alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn, void **data);
  62 alpm_list_t *alpm_list_remove_str(alpm_list_t *haystack, const char *needle, char **data);
  63 alpm_list_t *alpm_list_remove_dupes(const alpm_list_t *list);
  64 alpm_list_t *alpm_list_strdup(const alpm_list_t *list);
  65 alpm_list_t *alpm_list_copy(const alpm_list_t *list);
  66 alpm_list_t *alpm_list_copy_data(const alpm_list_t *list, size_t size);
  67 alpm_list_t *alpm_list_reverse(alpm_list_t *list);
  68
  69 /* item accessors */
  70 alpm_list_t *alpm_list_nth(const alpm_list_t *list, size_t n);
  71 alpm_list_t *alpm_list_next(const alpm_list_t *list);
  72 alpm_list_t *alpm_list_previous(const alpm_list_t *list);
  73 alpm_list_t *alpm_list_last(const alpm_list_t *list);
  74
  75 /* misc */
  76 size_t alpm_list_count(const alpm_list_t *list);
  77 void *alpm_list_find(const alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn);
  78 void *alpm_list_find_ptr(const alpm_list_t *haystack, const void *needle);
  79 char *alpm_list_find_str(const alpm_list_t *haystack, const char *needle);
  80 alpm_list_t *alpm_list_diff(const alpm_list_t *lhs, const alpm_list_t *rhs, alpm_list_fn_cmp fn);
  81 void alpm_list_diff_sorted(const alpm_list_t *left, const alpm_list_t *right,
  82                 alpm_list_fn_cmp fn, alpm_list_t **onlyleft, alpm_list_t **onlyright);
  83 void *alpm_list_to_array(const alpm_list_t *list, size_t n, size_t size);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88 #endif /* _ALPM_LIST_H */
  89
  90 /* vim: set ts=2 sw=2 noet: */