Cleanup: comment line length (blenlib)
[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  */
34
35 #ifdef __cplusplus
36 extern "C"
37 {
38 #endif
39
40 #include "BLI_compiler_attrs.h"
41
42 struct BLI_mempool;
43 struct BLI_mempool_chunk;
44
45 typedef struct BLI_mempool BLI_mempool;
46
47 BLI_mempool *BLI_mempool_create(unsigned int esize, unsigned int totelem,
48                                 unsigned int pchunk, unsigned int flag) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
49 void        *BLI_mempool_alloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
50 void        *BLI_mempool_calloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
51 void         BLI_mempool_free(BLI_mempool *pool, void *addr) ATTR_NONNULL(1, 2);
52 void         BLI_mempool_clear_ex(BLI_mempool *pool,
53                                   const int totelem_reserve) ATTR_NONNULL(1);
54 void         BLI_mempool_clear(BLI_mempool *pool) ATTR_NONNULL(1);
55 void         BLI_mempool_destroy(BLI_mempool *pool) ATTR_NONNULL(1);
56 int          BLI_mempool_len(BLI_mempool *pool) ATTR_NONNULL(1);
57 void        *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
58
59 void        BLI_mempool_as_table(BLI_mempool *pool, void **data) ATTR_NONNULL(1, 2);
60 void      **BLI_mempool_as_tableN(BLI_mempool *pool, const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
61 void        BLI_mempool_as_array(BLI_mempool *pool, void *data) ATTR_NONNULL(1, 2);
62 void       *BLI_mempool_as_arrayN(BLI_mempool *pool, const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
63
64 #ifndef NDEBUG
65 void        BLI_mempool_set_memory_debug(void);
66 #endif
67
68 /** iteration stuff.  note: this may easy to produce bugs with **/
69 /* private structure */
70 typedef struct BLI_mempool_iter {
71         BLI_mempool *pool;
72         struct BLI_mempool_chunk *curchunk;
73         unsigned int curindex;
74
75         struct BLI_mempool_chunk **curchunk_threaded_shared;
76 } BLI_mempool_iter;
77
78 /* flag */
79 enum {
80         BLI_MEMPOOL_NOP = 0,
81         /** allow iterating on this mempool.
82          *
83          * \note this requires that the first four bytes of the elements never begin with 'free' (FREEWORD).
84          * \note order of iteration is only assured to be the order of allocation when no chunks have been freed.
85          */
86         BLI_MEMPOOL_ALLOW_ITER = (1 << 0),
87 };
88
89 void  BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter) ATTR_NONNULL();
90 void *BLI_mempool_iterstep(BLI_mempool_iter *iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
91
92 BLI_mempool_iter *BLI_mempool_iter_threadsafe_create(BLI_mempool *pool, const size_t num_iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
93 void  BLI_mempool_iter_threadsafe_free(BLI_mempool_iter *iter_arr) ATTR_NONNULL();
94
95 #ifdef __cplusplus
96 }
97 #endif
98
99 #endif  /* __BLI_MEMPOOL_H__ */