Cleanup: remove redundant, invalid info from headers
[blender.git] / intern / memutil / MEM_CacheLimiterC-Api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file memutil/MEM_CacheLimiterC-Api.h
18  *  \ingroup memutil
19  */
20
21
22 #ifndef __MEM_CACHELIMITERC_API_H__
23 #define __MEM_CACHELIMITERC_API_H__
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 struct MEM_CacheLimiter_s;
30 struct MEM_CacheLimiterHandle_s;
31
32 typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
33 typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
34
35 /* function used to remove data from memory */
36 typedef void (*MEM_CacheLimiter_Destruct_Func)(void*);
37
38 /* function used to measure stored data element size */
39 typedef size_t (*MEM_CacheLimiter_DataSize_Func) (void*);
40
41 /* function used to measure priority of item when freeing memory */
42 typedef int (*MEM_CacheLimiter_ItemPriority_Func) (void*, int);
43
44 /* function to check whether item could be destroyed */
45 typedef bool (*MEM_CacheLimiter_ItemDestroyable_Func) (void*);
46
47 #ifndef __MEM_CACHELIMITER_H__
48 void MEM_CacheLimiter_set_maximum(size_t m);
49 size_t MEM_CacheLimiter_get_maximum(void);
50 void MEM_CacheLimiter_set_disabled(bool disabled);
51 bool MEM_CacheLimiter_is_disabled(void);
52 #endif /* __MEM_CACHELIMITER_H__ */
53
54 /**
55  * Create new MEM_CacheLimiter object
56  * managed objects are destructed with the data_destructor
57  *
58  * \param data_destructor
59  * \return A new MEM_CacheLimter object
60  */
61
62 MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
63                                          MEM_CacheLimiter_DataSize_Func data_size);
64
65 /**
66  * Delete MEM_CacheLimiter
67  *
68  * Frees the memory of the CacheLimiter but does not touch managed objects!
69  *
70  * \param This "This" pointer
71  */
72
73 void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
74
75 /**
76  * Manage object
77  *
78  * \param This "This" pointer, data data object to manage
79  * \return CacheLimiterHandle to ref, unref, touch the managed object
80  */
81
82 MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *data);
83
84 /**
85  * Free objects until memory constraints are satisfied
86  *
87  * \param This "This" pointer
88  */
89
90 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 handle of object
97  */
98
99 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 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 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 void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
127
128 /**
129  * Get reference counter.
130  *
131  * \param handle of object
132  */
133
134 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 void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
143
144 void MEM_CacheLimiter_ItemPriority_Func_set(MEM_CacheLimiterC *This,
145                                             MEM_CacheLimiter_ItemPriority_Func item_priority_func);
146
147 void MEM_CacheLimiter_ItemDestroyable_Func_set(MEM_CacheLimiterC *This,
148                                                MEM_CacheLimiter_ItemDestroyable_Func item_destroyable_func);
149
150 size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This);
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156
157 #endif // __MEM_CACHELIMITERC_API_H__