revealing selected faces in the UV window with sync selection disabled and when both...
[blender-staging.git] / intern / guardedalloc / MEM_guardedalloc.h
1 /**
2  * $Id$
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /**
30
31  * $Id$
32  * Copyright (C) 2001 NaN Technologies B.V.
33  * Guarded memory (de)allocation
34  *
35  *
36  * @mainpage MEM - c-style guarded memory allocation
37  *
38  * @section about About the MEM module
39  *
40  * MEM provides guarded malloc/calloc calls. All memory is enclosed by
41  * pads, to detect out-of-bound writes. All blocks are placed in a
42  * linked list, so they remain reachable at all times. There is no
43  * back-up in case the linked-list related data is lost.
44  *
45  * @section issues Known issues with MEM
46  *
47  * There are currently no known issues with MEM. Note that there is a
48  * second intern/ module with MEM_ prefix, for use in c++.
49  * 
50  * @section dependencies Dependencies
51  *
52  * - stdlib
53  *
54  * - stdio
55  *
56  * */
57
58 #ifndef MEM_MALLOCN_H
59 #define MEM_MALLOCN_H
60
61 /* Needed for FILE* */
62 #include "stdio.h"
63
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67
68         /** Returns the lenght of the allocated memory segment pointed at
69          * by vmemh. If the pointer was not previously allocated by this
70          * module, the result is undefined.*/
71         int MEM_allocN_len(void *vmemh);
72
73         /**
74          * Release memory previously allocatred by this module. 
75          */
76         short MEM_freeN(void *vmemh);
77
78         /**
79          * Duplicates a block of memory, and returns a pointer to the
80          * newly allocated block.  */
81         void *MEM_dupallocN(void *vmemh);
82
83         /**
84          * Allocate a block of memory of size len, with tag name str. The
85          * memory is cleared. The name must be static, because only a
86          * pointer to it is stored ! */
87         void *MEM_callocN(unsigned int len, const char * str);
88         
89         /** Allocate a block of memory of size len, with tag name str. The
90                 * name must be a static, because only a pointer to it is stored !
91                 * */
92         void *MEM_mallocN(unsigned int len, const char * str);
93         
94         /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
95                 Can be free'd with MEM_freeN as usual.
96                 * */
97         void *MEM_mapallocN(unsigned int len, const char * str);
98
99         /** Print a list of the names and sizes of all allocated memory
100          * blocks. as a python dict for easy investigation */ 
101         void MEM_printmemlist_pydict(void);
102
103         /** Print a list of the names and sizes of all allocated memory
104          * blocks. */ 
105         void MEM_printmemlist(void);
106
107         /** Print statistics about memory usage */
108         void MEM_printmemlist_stats(void);
109         
110         /** Set the callback function for error output. */
111         void MEM_set_error_callback(void (*func)(char *));
112
113         /**
114          * Are the start/end block markers still correct ?
115          *
116          * @retval 0 for correct memory, 1 for corrupted memory. */
117         int MEM_check_memory_integrity(void);
118
119         /** Set thread locking functions for safe memory allocation from multiple
120             threads, pass NULL pointers to disable thread locking again. */
121         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
122         
123         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
124         void MEM_set_memory_debug(void);
125
126
127 #ifdef __cplusplus
128 }
129 #endif
130
131 #endif
132