mirror of
https://github.com/moparisthebest/pacman
synced 2024-11-16 06:15:08 -05:00
bbe55b5ce9
We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
89 lines
3.1 KiB
C
89 lines
3.1 KiB
C
/*
|
|
* alpm_list.h
|
|
*
|
|
* Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
|
|
* USA.
|
|
*/
|
|
#ifndef _ALPM_LIST_H
|
|
#define _ALPM_LIST_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "alpm.h"
|
|
|
|
/**
|
|
* @brief Linked list type used by libalpm.
|
|
*
|
|
* It is exposed so front ends can use it to prevent the need to reimplement
|
|
* lists of their own; however, it is not required that the front end uses
|
|
* it.
|
|
*/
|
|
struct __alpm_list_t {
|
|
/** data held by the list node */
|
|
void *data;
|
|
/** pointer to the previous node */
|
|
struct __alpm_list_t *prev;
|
|
/** pointer to the next node */
|
|
struct __alpm_list_t *next;
|
|
};
|
|
|
|
/* TODO we should do away with these... they're messy*/
|
|
#define _FREELIST(p, f) do { alpm_list_free_inner(p, f); alpm_list_free(p); p = NULL; } while(0)
|
|
#define FREELIST(p) _FREELIST(p, free)
|
|
#define FREELISTPTR(p) do { alpm_list_free(p); p = NULL; } while(0)
|
|
|
|
typedef void (*alpm_list_fn_free)(void *); /* item deallocation callback */
|
|
typedef int (*alpm_list_fn_cmp)(const void *, const void *); /* item comparison callback */
|
|
|
|
/* allocation */
|
|
alpm_list_t *alpm_list_new(void);
|
|
void alpm_list_free(alpm_list_t *list);
|
|
void alpm_list_free_inner(alpm_list_t *list, alpm_list_fn_free fn);
|
|
|
|
/* item mutators */
|
|
alpm_list_t *alpm_list_add(alpm_list_t *list, void *data);
|
|
alpm_list_t *alpm_list_add_sorted(alpm_list_t *list, void *data, alpm_list_fn_cmp fn);
|
|
alpm_list_t *alpm_list_mmerge(alpm_list_t *left, alpm_list_t *right, alpm_list_fn_cmp fn);
|
|
alpm_list_t *alpm_list_msort(alpm_list_t *list, int n, alpm_list_fn_cmp fn);
|
|
alpm_list_t *alpm_list_remove(alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn, void **data);
|
|
alpm_list_t *alpm_list_remove_node(alpm_list_t *node);
|
|
alpm_list_t *alpm_list_remove_dupes(alpm_list_t *list);
|
|
alpm_list_t *alpm_list_strdup(alpm_list_t *list);
|
|
alpm_list_t *alpm_list_reverse(alpm_list_t *list);
|
|
|
|
/* item accessors */
|
|
alpm_list_t *alpm_list_first(alpm_list_t *list);
|
|
alpm_list_t *alpm_list_nth(alpm_list_t *list, int n);
|
|
alpm_list_t *alpm_list_next(alpm_list_t *list);
|
|
alpm_list_t *alpm_list_last(alpm_list_t *list);
|
|
void *alpm_list_getdata(const alpm_list_t *entry);
|
|
|
|
/* misc */
|
|
int alpm_list_count(const alpm_list_t *list);
|
|
int alpm_list_find(alpm_list_t *haystack, const void *needle);
|
|
int alpm_list_find_str(alpm_list_t *haystack,const char *needle);
|
|
alpm_list_t *alpm_list_diff(alpm_list_t *lhs, alpm_list_t *rhs, alpm_list_fn_cmp fn);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* _ALPM_LIST_H */
|
|
|
|
/* vim: set ts=2 sw=2 noet: */
|