synched with trunk at revision 36569
[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 #ifndef MEM_CACHELIMITER_H
46 extern void MEM_CacheLimiter_set_maximum(int m);
47 extern int MEM_CacheLimiter_get_maximum(void);
48 #endif // MEM_CACHELIMITER_H
49 /** 
50  * Create new MEM_CacheLimiter object 
51  * managed objects are destructed with the data_destructor
52  *
53  * @param data_destructor
54  * @return A new MEM_CacheLimter object
55  */
56
57 extern MEM_CacheLimiterC * new_MEM_CacheLimiter(
58         MEM_CacheLimiter_Destruct_Func data_destructor);
59
60 /** 
61  * Delete MEM_CacheLimiter
62  * 
63  * Frees the memory of the CacheLimiter but does not touch managed objects!
64  *
65  * @param This "This" pointer
66  */
67
68 extern void delete_MEM_CacheLimiter(MEM_CacheLimiterC * This);
69
70 /** 
71  * Manage object
72  * 
73  * @param This "This" pointer, data data object to manage
74  * @return CacheLimiterHandle to ref, unref, touch the managed object
75  */
76         
77 extern MEM_CacheLimiterHandleC * MEM_CacheLimiter_insert(
78         MEM_CacheLimiterC * This, void * data);
79
80 /** 
81  * Free objects until memory constraints are satisfied
82  * 
83  * @param This "This" pointer
84  */
85
86 extern void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC * This);
87
88 /** 
89  * Unmanage object previously inserted object. 
90  * Does _not_ delete managed object!
91  * 
92  * @param This "This" pointer, handle of object
93  */
94         
95 extern void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC * handle);
96
97
98 /** 
99  * Raise priority of object (put it at the tail of the deletion chain)
100  * 
101  * @param handle of object
102  */
103         
104 extern void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC * handle);
105
106 /** 
107  * Increment reference counter. Objects with reference counter != 0 are _not_
108  * deleted.
109  * 
110  * @param handle of object
111  */
112         
113 extern void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC * handle);
114
115 /** 
116  * Decrement reference counter. Objects with reference counter != 0 are _not_
117  * deleted.
118  * 
119  * @param handle of object
120  */
121         
122 extern void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC * handle);
123
124 /** 
125  * Get reference counter.
126  * 
127  * @param This "This" pointer, handle of object
128  */
129         
130 extern int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC * handle);
131
132 /** 
133  * Get pointer to managed object
134  * 
135  * @param handle of object
136  */
137         
138 extern void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC * handle);
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144
145 #endif // MEM_CACHELIMITERC_API_H