Merging r39191 through r39250 from trunk into soc-2011-tomato
[blender.git] / intern / memutil / MEM_CacheLimiterC-Api.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  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file memutil/MEM_CacheLimiterC-Api.h
25  *  \ingroup memutil
26  */
27
28
29 #ifndef MEM_CACHELIMITERC_API_H
30 #define MEM_CACHELIMITERC_API_H
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35         
36 struct MEM_CacheLimiter_s;
37 struct MEM_CacheLimiterHandle_s;
38
39 typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
40 typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
41
42 /* function used to remove data from memory */
43 typedef void(*MEM_CacheLimiter_Destruct_Func)(void*);
44
45 /* function used to measure stored data element size */
46 typedef intptr_t(*MEM_CacheLimiter_DataSize_Func) (void*);
47
48 #ifndef MEM_CACHELIMITER_H
49 extern void MEM_CacheLimiter_set_maximum(int m);
50 extern int MEM_CacheLimiter_get_maximum(void);
51 #endif // MEM_CACHELIMITER_H
52 /** 
53  * Create new MEM_CacheLimiter object 
54  * managed objects are destructed with the data_destructor
55  *
56  * @param data_destructor
57  * @return A new MEM_CacheLimter object
58  */
59
60 extern MEM_CacheLimiterC * new_MEM_CacheLimiter(
61         MEM_CacheLimiter_Destruct_Func data_destructor,
62         MEM_CacheLimiter_DataSize_Func data_size);
63
64 /** 
65  * Delete MEM_CacheLimiter
66  * 
67  * Frees the memory of the CacheLimiter but does not touch managed objects!
68  *
69  * @param This "This" pointer
70  */
71
72 extern void delete_MEM_CacheLimiter(MEM_CacheLimiterC * This);
73
74 /** 
75  * Manage object
76  * 
77  * @param This "This" pointer, data data object to manage
78  * @return CacheLimiterHandle to ref, unref, touch the managed object
79  */
80         
81 extern MEM_CacheLimiterHandleC * MEM_CacheLimiter_insert(
82         MEM_CacheLimiterC * This, void * data);
83
84 /** 
85  * Free objects until memory constraints are satisfied
86  * 
87  * @param This "This" pointer
88  */
89
90 extern void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC * This);
91
92 /** 
93  * Unmanage object previously inserted object. 
94  * Does _not_ delete managed object!
95  * 
96  * @param This "This" pointer, handle of object
97  */
98         
99 extern void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC * handle);
100
101
102 /** 
103  * Raise priority of object (put it at the tail of the deletion chain)
104  * 
105  * @param handle of object
106  */
107         
108 extern void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC * handle);
109
110 /** 
111  * Increment reference counter. Objects with reference counter != 0 are _not_
112  * deleted.
113  * 
114  * @param handle of object
115  */
116         
117 extern void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC * handle);
118
119 /** 
120  * Decrement reference counter. Objects with reference counter != 0 are _not_
121  * deleted.
122  * 
123  * @param handle of object
124  */
125         
126 extern void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC * handle);
127
128 /** 
129  * Get reference counter.
130  * 
131  * @param This "This" pointer, handle of object
132  */
133         
134 extern int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC * handle);
135
136 /** 
137  * Get pointer to managed object
138  * 
139  * @param handle of object
140  */
141         
142 extern void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC * handle);
143
144 #ifdef __cplusplus
145 }
146 #endif
147
148
149 #endif // MEM_CACHELIMITERC_API_H