ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenlib / BLI_memarena.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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bli
22  */
23
24 #ifndef __BLI_MEMARENA_H__
25 #define __BLI_MEMARENA_H__
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #include "BLI_compiler_attrs.h"
32
33 /* A reasonable standard buffer size, big
34  * enough to not cause much internal fragmentation,
35  * small enough not to waste resources
36  */
37 #define BLI_MEMARENA_STD_BUFSIZE MEM_SIZE_OPTIMAL(1 << 14)
38
39 struct MemArena;
40 typedef struct MemArena MemArena;
41
42 struct MemArena *BLI_memarena_new(const size_t bufsize, const char *name) ATTR_WARN_UNUSED_RESULT
43     ATTR_NONNULL(2) ATTR_MALLOC;
44 void BLI_memarena_free(struct MemArena *ma) ATTR_NONNULL(1);
45 void BLI_memarena_use_malloc(struct MemArena *ma) ATTR_NONNULL(1);
46 void BLI_memarena_use_calloc(struct MemArena *ma) ATTR_NONNULL(1);
47 void BLI_memarena_use_align(struct MemArena *ma, const size_t align) ATTR_NONNULL(1);
48 void *BLI_memarena_alloc(struct MemArena *ma, size_t size) ATTR_WARN_UNUSED_RESULT
49     ATTR_NONNULL(1) ATTR_MALLOC ATTR_ALLOC_SIZE(2);
50 void *BLI_memarena_calloc(struct MemArena *ma, size_t size) ATTR_WARN_UNUSED_RESULT
51     ATTR_NONNULL(1) ATTR_MALLOC ATTR_ALLOC_SIZE(2);
52
53 void BLI_memarena_clear(MemArena *ma) ATTR_NONNULL(1);
54
55 #ifdef __cplusplus
56 }
57 #endif
58
59 #endif /* __BLI_MEMARENA_H__ */