svn merge -r40140:r40148 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / blenlib / BLI_linklist.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (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, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29  
30 #ifndef BLI_LINKLIST_H
31 #define BLI_LINKLIST_H
32
33 /** \file BLI_linklist.h
34  *  \ingroup bli
35  *  \brief Routines for working with singly linked lists
36  *   of 'links' - pointers to other data.
37  * 
38  */
39
40 struct MemArena;
41
42 typedef void (*LinkNodeFreeFP)(void *link);
43 typedef void (*LinkNodeApplyFP)(void *link, void *userdata);
44
45 struct LinkNode;
46 typedef struct LinkNode {
47         struct LinkNode *next;
48         void *link;
49 } LinkNode;
50
51 int             BLI_linklist_length             (struct LinkNode *list);
52 int             BLI_linklist_index              (struct LinkNode *list, void *ptr);
53
54 struct LinkNode *BLI_linklist_find      (struct LinkNode *list, int index);
55
56 void    BLI_linklist_reverse    (struct LinkNode **listp);
57
58 void    BLI_linklist_prepend            (struct LinkNode **listp, void *ptr);
59 void    BLI_linklist_append             (struct LinkNode **listp, void *ptr);
60 void    BLI_linklist_prepend_arena      (struct LinkNode **listp, void *ptr, struct MemArena *ma);
61 void    BLI_linklist_insert_after       (struct LinkNode **listp, void *ptr);
62
63 void    BLI_linklist_free               (struct LinkNode *list, LinkNodeFreeFP freefunc);
64 void    BLI_linklist_apply              (struct LinkNode *list, LinkNodeApplyFP applyfunc, void *userdata);
65
66 #endif
67