Cleanup: comments (long lines) in blenlib
[blender.git] / source / blender / blenlib / BLI_mempool.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_MEMPOOL_H__
21 #define __BLI_MEMPOOL_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #include "BLI_compiler_attrs.h"
32
33 struct BLI_mempool;
34 struct BLI_mempool_chunk;
35
36 typedef struct BLI_mempool BLI_mempool;
37
38 BLI_mempool *BLI_mempool_create(unsigned int esize,
39                                 unsigned int totelem,
40                                 unsigned int pchunk,
41                                 unsigned int flag) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
42 void *BLI_mempool_alloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
43 void *BLI_mempool_calloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
44 void BLI_mempool_free(BLI_mempool *pool, void *addr) ATTR_NONNULL(1, 2);
45 void BLI_mempool_clear_ex(BLI_mempool *pool, const int totelem_reserve) ATTR_NONNULL(1);
46 void BLI_mempool_clear(BLI_mempool *pool) ATTR_NONNULL(1);
47 void BLI_mempool_destroy(BLI_mempool *pool) ATTR_NONNULL(1);
48 int BLI_mempool_len(BLI_mempool *pool) ATTR_NONNULL(1);
49 void *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index) ATTR_WARN_UNUSED_RESULT
50     ATTR_NONNULL(1);
51
52 void BLI_mempool_as_table(BLI_mempool *pool, void **data) ATTR_NONNULL(1, 2);
53 void **BLI_mempool_as_tableN(BLI_mempool *pool,
54                              const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
55     ATTR_NONNULL(1, 2);
56 void BLI_mempool_as_array(BLI_mempool *pool, void *data) ATTR_NONNULL(1, 2);
57 void *BLI_mempool_as_arrayN(BLI_mempool *pool,
58                             const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
59     ATTR_NONNULL(1, 2);
60
61 #ifndef NDEBUG
62 void BLI_mempool_set_memory_debug(void);
63 #endif
64
65 /** iteration stuff.  note: this may easy to produce bugs with */
66 /* private structure */
67 typedef struct BLI_mempool_iter {
68   BLI_mempool *pool;
69   struct BLI_mempool_chunk *curchunk;
70   unsigned int curindex;
71
72   struct BLI_mempool_chunk **curchunk_threaded_shared;
73 } BLI_mempool_iter;
74
75 /* flag */
76 enum {
77   BLI_MEMPOOL_NOP = 0,
78   /** allow iterating on this mempool.
79    *
80    * \note this requires that the first four bytes of the elements
81    * never begin with 'free' (#FREEWORD).
82    * \note order of iteration is only assured to be the
83    * order of allocation when no chunks have been freed.
84    */
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 BLI_mempool_iter *BLI_mempool_iter_threadsafe_create(BLI_mempool *pool,
92                                                      const size_t num_iter) ATTR_WARN_UNUSED_RESULT
93     ATTR_NONNULL();
94 void BLI_mempool_iter_threadsafe_free(BLI_mempool_iter *iter_arr) ATTR_NONNULL();
95
96 #ifdef __cplusplus
97 }
98 #endif
99
100 #endif /* __BLI_MEMPOOL_H__ */