2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r17434...
[blender.git] / source / blender / blenlib / BLI_memarena.h
1 /* 
2  * Memory arena ADT
3  * 
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  * 
31  * Memory arena's are commonly used when the program
32  * needs to quickly allocate lots of little bits of
33  * data, which are all freed at the same moment.
34  * 
35  */
36
37 #ifndef BLI_MEMARENA_H
38 #define BLI_MEMARENA_H
39
40         /* A reasonable standard buffer size, big
41          * enough to not cause much internal fragmentation, 
42          * small enough not to waste resources
43          */
44 #define BLI_MEMARENA_STD_BUFSIZE        (1<<14)
45
46 struct MemArena;
47 typedef struct MemArena MemArena;
48
49
50 struct MemArena*        BLI_memarena_new        (int bufsize);
51 void                            BLI_memarena_free       (struct MemArena *ma);
52
53 void                            BLI_memarena_use_malloc (struct MemArena *ma);
54 void                            BLI_memarena_use_calloc (struct MemArena *ma);
55
56 void*                           BLI_memarena_alloc      (struct MemArena *ma, int size);
57
58 #endif
59