/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */
 
#ifndef __BLI_LINKLIST_H__
#define __BLI_LINKLIST_H__

/** \file BLI_linklist.h
 *  \ingroup bli
 *  \brief Routines for working with singly linked lists
 *   of 'links' - pointers to other data.
 * 
 */

struct MemArena;
struct BLI_mempool;

typedef void (*LinkNodeFreeFP)(void *link);
typedef void (*LinkNodeApplyFP)(void *link, void *userdata);

struct LinkNode;
typedef struct LinkNode {
	struct LinkNode *next;
	void *link;
} LinkNode;

int     BLI_linklist_length(struct LinkNode *list);
int     BLI_linklist_index(struct LinkNode *list, void *ptr);

struct LinkNode *BLI_linklist_find(struct LinkNode *list, int index);

void    BLI_linklist_reverse(struct LinkNode **listp);

void    BLI_linklist_prepend_nlink(struct LinkNode **listp, void *ptr, struct LinkNode *nlink);
void    BLI_linklist_prepend(struct LinkNode **listp, void *ptr);
void    BLI_linklist_prepend_arena(struct LinkNode **listp, void *ptr, struct MemArena *ma);
void    BLI_linklist_prepend_pool(struct LinkNode **listp, void *ptr, struct BLI_mempool *mempool);

void    BLI_linklist_append_nlink(LinkNode **listp, void *ptr, LinkNode *nlink);
void    BLI_linklist_append(struct LinkNode **listp, void *ptr);
void    BLI_linklist_append_arena(LinkNode **listp, void *ptr, struct MemArena *ma);
void    BLI_linklist_append_pool(LinkNode **listp, void *ptr, struct BLI_mempool *mempool);

void   *BLI_linklist_pop(struct LinkNode **listp);
void   *BLI_linklist_pop_pool(struct LinkNode **listp, struct BLI_mempool *mempool);
void    BLI_linklist_insert_after(struct LinkNode **listp, void *ptr);

void    BLI_linklist_free(struct LinkNode *list, LinkNodeFreeFP freefunc);
void    BLI_linklist_freeN(struct LinkNode *list);
void    BLI_linklist_free_pool(LinkNode *list, LinkNodeFreeFP freefunc, struct BLI_mempool *mempool);
void    BLI_linklist_apply(struct LinkNode *list, LinkNodeApplyFP applyfunc, void *userdata);

#define BLI_linklist_prepend_alloca(listp, ptr) \
	BLI_linklist_prepend_nlink(listp, ptr, alloca(sizeof(LinkNode)))

#endif  /* __BLI_LINKLIST_H__ */