doxygen: intern/itasc tagged
[blender.git] / intern / memutil / intern / MEM_CacheLimiterC-Api.cpp
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. The Blender
6  * Foundation also sells licenses for use in proprietary software under
7  * the Blender License.  See http://www.blender.org/BL/ for information
8  * about this.
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  */
22
23 #include <cstddef>
24
25 #include "MEM_CacheLimiter.h"
26 #include "MEM_CacheLimiterC-Api.h"
27
28 static intptr_t & get_max() 
29 {
30         static intptr_t m = 32*1024*1024;
31         return m;
32 }
33
34 void MEM_CacheLimiter_set_maximum(intptr_t m)
35 {
36         get_max() = m;
37 }
38
39 intptr_t MEM_CacheLimiter_get_maximum()
40 {
41         return get_max();
42 }
43
44 class MEM_CacheLimiterHandleCClass;
45 class MEM_CacheLimiterCClass;
46
47 typedef MEM_CacheLimiterHandle<MEM_CacheLimiterHandleCClass> handle_t;
48 typedef MEM_CacheLimiter<MEM_CacheLimiterHandleCClass> cache_t;
49 typedef std::list<MEM_CacheLimiterHandleCClass*,
50                   MEM_Allocator<MEM_CacheLimiterHandleCClass* > > list_t;
51
52 class MEM_CacheLimiterCClass {
53 public:
54         MEM_CacheLimiterCClass(MEM_CacheLimiter_Destruct_Func data_destructor_)
55                 : data_destructor(data_destructor_) { 
56         }
57         ~MEM_CacheLimiterCClass();
58         
59         handle_t * insert(void * data);
60
61         void destruct(void * data,
62                       list_t::iterator it);
63
64         cache_t * get_cache() {
65                 return &cache;
66         }
67 private:
68         MEM_CacheLimiter_Destruct_Func data_destructor;
69
70         MEM_CacheLimiter<MEM_CacheLimiterHandleCClass> cache;
71         
72         list_t cclass_list;
73 };
74
75 class MEM_CacheLimiterHandleCClass {
76 public:
77         MEM_CacheLimiterHandleCClass(void * data_,
78                                    MEM_CacheLimiterCClass * parent_)
79                 : data(data_), parent(parent_) { }
80         ~MEM_CacheLimiterHandleCClass();
81         void set_iter(list_t::iterator it_) {
82                 it = it_;
83         }
84         void set_data(void * data_) {
85                 data = data_;
86         }
87         void * get_data() const {
88                 return data;
89         }
90 private:
91         void * data;
92         MEM_CacheLimiterCClass * parent;
93         list_t::iterator it;
94 };
95
96 handle_t * MEM_CacheLimiterCClass::insert(void * data) 
97 {
98         cclass_list.push_back(new MEM_CacheLimiterHandleCClass(data, this));
99         list_t::iterator it = cclass_list.end();
100         --it;
101         cclass_list.back()->set_iter(it);
102         
103         return cache.insert(cclass_list.back());
104 }
105
106 void MEM_CacheLimiterCClass::destruct(void * data, list_t::iterator it) 
107 {
108         data_destructor(data);
109         cclass_list.erase(it);
110 }
111
112 MEM_CacheLimiterHandleCClass::~MEM_CacheLimiterHandleCClass()
113 {
114         if (data) {
115                 parent->destruct(data, it);
116         }
117 }
118
119 MEM_CacheLimiterCClass::~MEM_CacheLimiterCClass()
120 {
121         // should not happen, but don't leak memory in this case...
122         for (list_t::iterator it = cclass_list.begin();
123              it != cclass_list.end(); it++) {
124                 (*it)->set_data(0);
125                 delete *it;
126         }
127 }
128
129 // ----------------------------------------------------------------------
130
131 static inline MEM_CacheLimiterCClass* cast(MEM_CacheLimiterC * l)
132 {
133         return (MEM_CacheLimiterCClass*) l;
134 }
135
136 static inline handle_t* cast(MEM_CacheLimiterHandleC * l)
137 {
138         return (handle_t*) l;
139 }
140
141 MEM_CacheLimiterC * new_MEM_CacheLimiter(
142         MEM_CacheLimiter_Destruct_Func data_destructor)
143 {
144         return (MEM_CacheLimiterC*) new MEM_CacheLimiterCClass(
145                 data_destructor);
146 }
147
148 void delete_MEM_CacheLimiter(MEM_CacheLimiterC * This)
149 {
150         delete cast(This);
151 }
152
153 MEM_CacheLimiterHandleC * MEM_CacheLimiter_insert(
154         MEM_CacheLimiterC * This, void * data)
155 {
156         return (MEM_CacheLimiterHandleC *) cast(This)->insert(data);
157 }
158
159 void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC * This)
160 {
161         cast(This)->get_cache()->enforce_limits();
162 }
163         
164 void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC * handle)
165 {
166         cast(handle)->unmanage();
167 }
168         
169 void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC * handle)
170 {
171         cast(handle)->touch();
172 }
173         
174 void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC * handle)
175 {
176         cast(handle)->ref();
177 }
178         
179 void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC * handle)
180 {
181         cast(handle)->unref();
182 }
183
184 int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC * handle)
185 {
186         return cast(handle)->get_refcount();
187 }
188
189         
190 void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC * handle)
191 {
192         return cast(handle)->get()->get_data();
193 }