Merging r46111 through r46136 from trunk into soc-2011-tomato
[blender-staging.git] / source / blender / blenlib / BLI_memarena.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */ 
27
28 /** \file BLI_memarena.h
29  *  \ingroup bli
30  *  \brief Memory arena ADT.
31  *  \section aboutmemarena Memory Arena
32  * Memory arena's are commonly used when the program
33  * needs to quickly allocate lots of little bits of
34  * data, which are all freed at the same moment.
35  */
36
37 #ifndef __BLI_MEMARENA_H__
38 #define __BLI_MEMARENA_H__
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44         /* A reasonable standard buffer size, big
45          * enough to not cause much internal fragmentation, 
46          * small enough not to waste resources
47          */
48 #define BLI_MEMARENA_STD_BUFSIZE        (1<<14)
49
50 struct MemArena;
51 typedef struct MemArena MemArena;
52
53
54 struct MemArena*        BLI_memarena_new        (int bufsize, const char *name);
55 void                            BLI_memarena_free       (struct MemArena *ma);
56
57 void                            BLI_memarena_use_malloc (struct MemArena *ma);
58 void                            BLI_memarena_use_calloc (struct MemArena *ma);
59
60 void                            BLI_memarena_use_align(struct MemArena *ma, int align);
61
62 void*                           BLI_memarena_alloc      (struct MemArena *ma, int size);
63
64 #ifdef __cplusplus
65 }
66 #endif
67
68
69 #endif
70