Cleanup: quiet warning
[blender.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 for fixed size chunks.
35  */
36
37 #ifdef __cplusplus
38 extern "C"
39 {
40 #endif
41
42 #include "BLI_compiler_attrs.h"
43
44 struct BLI_mempool;
45 struct BLI_mempool_chunk;
46
47 typedef struct BLI_mempool BLI_mempool;
48
49 /* allow_iter allows iteration on this mempool.  note: this requires that the
50  * first four bytes of the elements never contain the character string
51  * 'free'.  use with care.*/
52
53 BLI_mempool *BLI_mempool_create(unsigned int esize, unsigned int totelem,
54                                 unsigned int pchunk, unsigned int flag) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
55 void        *BLI_mempool_alloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
56 void        *BLI_mempool_calloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
57 void         BLI_mempool_free(BLI_mempool *pool, void *addr) ATTR_NONNULL(1, 2);
58 void         BLI_mempool_clear_ex(BLI_mempool *pool,
59                                   const int totelem_reserve) ATTR_NONNULL(1);
60 void         BLI_mempool_clear(BLI_mempool *pool) ATTR_NONNULL(1);
61 void         BLI_mempool_destroy(BLI_mempool *pool) ATTR_NONNULL(1);
62 int          BLI_mempool_count(BLI_mempool *pool) ATTR_NONNULL(1);
63 void        *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
64
65 void        BLI_mempool_as_table(BLI_mempool *pool, void **data) ATTR_NONNULL(1, 2);
66 void      **BLI_mempool_as_tableN(BLI_mempool *pool, const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
67 void        BLI_mempool_as_array(BLI_mempool *pool, void *data) ATTR_NONNULL(1, 2);
68 void       *BLI_mempool_as_arrayN(BLI_mempool *pool, const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
69
70 #ifndef NDEBUG
71 void        BLI_mempool_set_memory_debug(void);
72 #endif
73
74 /** iteration stuff.  note: this may easy to produce bugs with **/
75 /* private structure */
76 typedef struct BLI_mempool_iter {
77         BLI_mempool *pool;
78         struct BLI_mempool_chunk *curchunk;
79         unsigned int curindex;
80 } BLI_mempool_iter;
81
82 /* flag */
83 enum {
84         BLI_MEMPOOL_NOP = 0,
85         BLI_MEMPOOL_ALLOW_ITER = (1 << 0),
86 };
87
88 void  BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter) ATTR_NONNULL();
89 void *BLI_mempool_iterstep(BLI_mempool_iter *iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
90
91 #ifdef __cplusplus
92 }
93 #endif
94
95 #endif  /* __BLI_MEMPOOL_H__ */