fix [#29380] VParent + Mask Mod,
[blender-staging.git] / source / blender / blenlib / BLI_mempool.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Geoffrey Bantle.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27  
28 #ifndef BLI_MEMPOOL_H
29 #define BLI_MEMPOOL_H
30
31 /** \file BLI_mempool.h
32  *  \ingroup bli
33  *  \author Geoffrey Bantle
34  *  \brief Simple fast memory allocator.
35  */
36
37 #ifdef __cplusplus
38 extern "C"
39 {
40 #endif
41
42 struct BLI_mempool;
43 struct BLI_mempool_chunk;
44
45 typedef struct BLI_mempool BLI_mempool;
46
47 /*allow_iter allows iteration on this mempool.  note: this requires that the
48   first four bytes of the elements never contain the character string
49   'free'.  use with care.*/
50
51 BLI_mempool *BLI_mempool_create(int esize, int tote, int pchunk,
52                                 short use_sysmalloc, short allow_iter);
53 void *BLI_mempool_alloc(BLI_mempool *pool);
54 void *BLI_mempool_calloc(BLI_mempool *pool);
55 void BLI_mempool_free(BLI_mempool *pool, void *addr);
56 void BLI_mempool_destroy(BLI_mempool *pool);
57 int BLI_mempool_count(BLI_mempool *pool);
58
59 /** iteration stuff.  note: this may easy to produce bugs with **/
60 /*private structure*/
61 typedef struct BLI_mempool_iter {
62         BLI_mempool *pool;
63         struct BLI_mempool_chunk *curchunk;
64         int curindex;
65 } BLI_mempool_iter;
66
67 /*allow iteration on this mempool.  note: this requires that the
68   first four bytes of the elements never contain the character string
69   'free'.  use with care.*/
70 void BLI_mempool_allow_iter(BLI_mempool *pool);
71 void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter);
72 void *BLI_mempool_iterstep(BLI_mempool_iter *iter);
73
74 #ifdef __cplusplus
75 }
76 #endif
77
78 #endif