Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_memiter.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
17 #ifndef __BLI_MEMITER_H__
18 #define __BLI_MEMITER_H__
19
20 /** \file \ingroup bli
21  */
22
23 #ifdef __cplusplus
24 extern "C"
25 {
26 #endif
27
28 #include "BLI_sys_types.h"
29 #include "BLI_compiler_attrs.h"
30 #include "BLI_compiler_compat.h"
31
32 /* 512kb, good default for small elems. */
33 #define BLI_MEMITER_DEFAULT_SIZE (1 << 19)
34
35 struct BLI_memiter;
36 struct BLI_memiter_chunk;
37
38 typedef struct BLI_memiter BLI_memiter;
39
40 /* warning, ATTR_MALLOC flag on BLI_memiter_alloc causes crash, see: D2756 */
41 BLI_memiter *BLI_memiter_create(unsigned int chunk_size) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
42 void        *BLI_memiter_alloc(BLI_memiter *mi, unsigned int size) ATTR_RETURNS_NONNULL ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
43 void         BLI_memiter_alloc_from(BLI_memiter *mi, uint elem_size, const void *data_from) ATTR_NONNULL(1, 3);
44 void        *BLI_memiter_calloc(BLI_memiter *mi, unsigned int size) ATTR_RETURNS_NONNULL ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
45 void         BLI_memiter_destroy(BLI_memiter *mi) ATTR_NONNULL(1);
46 void         BLI_memiter_clear(BLI_memiter *mi) ATTR_NONNULL(1);
47 unsigned int BLI_memiter_count(const BLI_memiter *mi) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
48
49 /* utils */
50 void *BLI_memiter_elem_first(BLI_memiter *mi);
51 void *BLI_memiter_elem_first_size(BLI_memiter *mi, unsigned int *r_size);
52
53 /* private structure */
54 typedef struct BLI_memiter_handle {
55         struct BLI_memiter_elem *elem;
56         uint elem_left;
57 } BLI_memiter_handle;
58
59 void  BLI_memiter_iter_init(BLI_memiter *mi, BLI_memiter_handle *iter) ATTR_NONNULL();
60 bool  BLI_memiter_iter_done(const BLI_memiter_handle *iter) ATTR_NONNULL();
61 void *BLI_memiter_iter_step(BLI_memiter_handle *iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
62 void *BLI_memiter_iter_step_size(BLI_memiter_handle *iter, uint *r_size) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
63
64 #ifdef __cplusplus
65 }
66 #endif
67
68 #endif  /* __BLI_MEMITER_H__ */