Docs: doxy corrections
[blender.git] / intern / memutil / MEM_CacheLimiterC-Api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file memutil/MEM_CacheLimiterC-Api.h
24  *  \ingroup memutil
25  */
26
27
28 #ifndef __MEM_CACHELIMITERC_API_H__
29 #define __MEM_CACHELIMITERC_API_H__
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 struct MEM_CacheLimiter_s;
36 struct MEM_CacheLimiterHandle_s;
37
38 typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
39 typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
40
41 /* function used to remove data from memory */
42 typedef void (*MEM_CacheLimiter_Destruct_Func)(void*);
43
44 /* function used to measure stored data element size */
45 typedef size_t (*MEM_CacheLimiter_DataSize_Func) (void*);
46
47 /* function used to measure priority of item when freeing memory */
48 typedef int (*MEM_CacheLimiter_ItemPriority_Func) (void*, int);
49
50 /* function to check whether item could be destroyed */
51 typedef bool (*MEM_CacheLimiter_ItemDestroyable_Func) (void*);
52
53 #ifndef __MEM_CACHELIMITER_H__
54 void MEM_CacheLimiter_set_maximum(size_t m);
55 size_t MEM_CacheLimiter_get_maximum(void);
56 void MEM_CacheLimiter_set_disabled(bool disabled);
57 bool MEM_CacheLimiter_is_disabled(void);
58 #endif /* __MEM_CACHELIMITER_H__ */
59
60 /**
61  * Create new MEM_CacheLimiter object
62  * managed objects are destructed with the data_destructor
63  *
64  * @param data_destructor
65  * @return A new MEM_CacheLimter object
66  */
67
68 MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
69                                          MEM_CacheLimiter_DataSize_Func data_size);
70
71 /**
72  * Delete MEM_CacheLimiter
73  *
74  * Frees the memory of the CacheLimiter but does not touch managed objects!
75  *
76  * @param This "This" pointer
77  */
78
79 void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
80
81 /**
82  * Manage object
83  *
84  * @param This "This" pointer, data data object to manage
85  * @return CacheLimiterHandle to ref, unref, touch the managed object
86  */
87
88 MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *data);
89
90 /**
91  * Free objects until memory constraints are satisfied
92  *
93  * @param This "This" pointer
94  */
95
96 void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
97
98 /**
99  * Unmanage object previously inserted object.
100  * Does _not_ delete managed object!
101  *
102  * @param This "This" pointer, handle of object
103  */
104
105 void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
106
107
108 /**
109  * Raise priority of object (put it at the tail of the deletion chain)
110  *
111  * @param handle of object
112  */
113
114 void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
115
116 /**
117  * Increment reference counter. Objects with reference counter != 0 are _not_
118  * deleted.
119  *
120  * @param handle of object
121  */
122
123 void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
124
125 /**
126  * Decrement reference counter. Objects with reference counter != 0 are _not_
127  * deleted.
128  *
129  * @param handle of object
130  */
131
132 void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
133
134 /**
135  * Get reference counter.
136  *
137  * @param handle of object
138  */
139
140 int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
141
142 /**
143  * Get pointer to managed object
144  *
145  * @param handle of object
146  */
147
148 void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
149
150 void MEM_CacheLimiter_ItemPriority_Func_set(MEM_CacheLimiterC *This,
151                                             MEM_CacheLimiter_ItemPriority_Func item_priority_func);
152
153 void MEM_CacheLimiter_ItemDestroyable_Func_set(MEM_CacheLimiterC *This,
154                                                MEM_CacheLimiter_ItemDestroyable_Func item_destroyable_func);
155
156 size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This);
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162
163 #endif // __MEM_CACHELIMITERC_API_H__