Merging r46096 through r46110 from trunk into soc-2011-tomato
[blender-staging.git] / source / blender / blenlib / BLI_memarena.h
1 /* 
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */ 
28
29 /** \file BLI_memarena.h
30  *  \ingroup bli
31  *  \brief Memory arena ADT.
32  *  \section aboutmemarena Memory Arena
33  * Memory arena's are commonly used when the program
34  * needs to quickly allocate lots of little bits of
35  * data, which are all freed at the same moment.
36  */
37
38 #ifndef __BLI_MEMARENA_H__
39 #define __BLI_MEMARENA_H__
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45         /* A reasonable standard buffer size, big
46          * enough to not cause much internal fragmentation, 
47          * small enough not to waste resources
48          */
49 #define BLI_MEMARENA_STD_BUFSIZE        (1<<14)
50
51 struct MemArena;
52 typedef struct MemArena MemArena;
53
54
55 struct MemArena*        BLI_memarena_new        (int bufsize, const char *name);
56 void                            BLI_memarena_free       (struct MemArena *ma);
57
58 void                            BLI_memarena_use_malloc (struct MemArena *ma);
59 void                            BLI_memarena_use_calloc (struct MemArena *ma);
60
61 void                            BLI_memarena_use_align(struct MemArena *ma, int align);
62
63 void*                           BLI_memarena_alloc      (struct MemArena *ma, int size);
64
65 #ifdef __cplusplus
66 }
67 #endif
68
69
70 #endif
71