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