lib/libalpm/alpm_list.h

   1 /*
   2  *  alpm_list.h
   3  *
   4  *  Copyright (c) 2002-2007 by Judd Vinet <jvinet@zeroflux.org>
   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, see <http://www.gnu.org/licenses/>.
  18  */
  19 #ifndef _ALPM_LIST_H
  20 #define _ALPM_LIST_H
  21
  22 #include <stdlib.h> /* size_t */
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * @brief Linked list type used by libalpm.
  30  *
  31  * It is exposed so front ends can use it to prevent the need to reimplement
  32  * lists of their own; however, it is not required that the front end uses
  33  * it.
  34  */
  35 typedef struct __alpm_list_t {
  36         /** data held by the list node */
  37         void *data;
  38         /** pointer to the previous node */
  39         struct __alpm_list_t *prev;
  40         /** pointer to the next node */
  41         struct __alpm_list_t *next;
  42 } alpm_list_t;
  43
  44 #define FREELIST(p) do { alpm_list_free_inner(p, free); alpm_list_free(p); p = NULL; } while(0)
  45
  46 typedef void (*alpm_list_fn_free)(void *); /* item deallocation callback */
  47 typedef int (*alpm_list_fn_cmp)(const void *, const void *); /* item comparison callback */
  48
  49 /* allocation */
  50 void alpm_list_free(alpm_list_t *list);
  51 void alpm_list_free_inner(alpm_list_t *list, alpm_list_fn_free fn);
  52
  53 /* item mutators */
  54 alpm_list_t *alpm_list_add(alpm_list_t *list, void *data);
  55 alpm_list_t *alpm_list_add_sorted(alpm_list_t *list, void *data, alpm_list_fn_cmp fn);
  56 alpm_list_t *alpm_list_join(alpm_list_t *first, alpm_list_t *second);
  57 alpm_list_t *alpm_list_mmerge(alpm_list_t *left, alpm_list_t *right, alpm_list_fn_cmp fn);
  58 alpm_list_t *alpm_list_msort(alpm_list_t *list, int n, alpm_list_fn_cmp fn);
  59 alpm_list_t *alpm_list_remove(alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn, void **data);
  60 alpm_list_t *alpm_list_remove_dupes(const alpm_list_t *list);
  61 alpm_list_t *alpm_list_strdup(const alpm_list_t *list);
  62 alpm_list_t *alpm_list_copy(const alpm_list_t *list);
  63 alpm_list_t *alpm_list_copy_data(const alpm_list_t *list, size_t size);
  64 alpm_list_t *alpm_list_reverse(alpm_list_t *list);
  65
  66 /* item accessors */
  67 alpm_list_t *alpm_list_first(const alpm_list_t *list);
  68 alpm_list_t *alpm_list_nth(const alpm_list_t *list, int n);
  69 alpm_list_t *alpm_list_next(const alpm_list_t *list);
  70 alpm_list_t *alpm_list_last(const alpm_list_t *list);
  71 void *alpm_list_getdata(const alpm_list_t *entry);
  72
  73 /* misc */
  74 int alpm_list_count(const alpm_list_t *list);
  75 void *alpm_list_find(const alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn);
  76 void *alpm_list_find_ptr(const alpm_list_t *haystack, const void *needle);
  77 char *alpm_list_find_str(const alpm_list_t *haystack, const char *needle);
  78 alpm_list_t *alpm_list_diff(const alpm_list_t *lhs, const alpm_list_t *rhs, alpm_list_fn_cmp fn);
  79
  80 #ifdef __cplusplus
  81 }
  82 #endif
  83 #endif /* _ALPM_LIST_H */
  84
  85 /* vim: set ts=2 sw=2 noet: */