Subversion Repositories gelsvn

Rev

Rev 89 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 89 Rev 119
1
#ifndef __RESOURCE_MANAGER_H
1
#ifndef __RESOURCE_MANAGER_H
2
#define __RESOURCE_MANAGER_H
2
#define __RESOURCE_MANAGER_H
3
 
3
 
4
#include <cassert>
4
#include <cassert>
5
#include <string>
5
#include <string>
6
#include <list>
6
#include <list>
7
#include <typeinfo>
7
#include <typeinfo>
8
 
8
 
9
#define CLEAN_SHUTDOWN 1
9
#define CLEAN_SHUTDOWN 1
10
 
10
 
11
namespace Util
11
namespace Util
12
{
12
{
13
 
13
 
14
	typedef unsigned char FlagByte;
14
	typedef unsigned char FlagByte;
15
	const FlagByte REMOVE_WHEN_UNUSED = 0x01;
15
	const FlagByte REMOVE_WHEN_UNUSED = 0x01;
16
	const FlagByte STATIC_RESOURCE    = 0x02;
16
	const FlagByte STATIC_RESOURCE    = 0x02;
17
 
17
 
18
	/** \brief This class template represents a resource record. 
18
	/** \brief This class template represents a resource record. 
19
 
19
 
20
	    There is a pointer to 
20
	    There is a pointer to 
21
			the actual resource (of type RES) and a usage counter which should never
21
			the actual resource (of type RES) and a usage counter which should never
22
			be less than 0. */
22
			be less than 0. */
23
	template<class RES>
23
	template<class RES>
24
	class ResourceRecord
24
	class ResourceRecord
25
	{
25
	{
26
		/// Name of the resource (const)
26
		/// Name of the resource (const)
27
    const std::string name;
27
    const std::string name;
28
 
28
 
29
		/// A pointer to the resource (the pointer not the pointee is const)
29
		/// A pointer to the resource (the pointer not the pointee is const)
30
		RES * const res;
30
		RES * const res;
31
		
31
		
32
		/// Usage counter.
32
		/// Usage counter.
33
		int usage;
33
		int usage;
34
 
34
 
35
		/// Flags
35
		/// Flags
36
		FlagByte flags;
36
		FlagByte flags;
37
 
37
 
38
	public:
38
	public:
39
	
39
	
40
		/// Construct a null record.
40
		/// Construct a null record.
41
		ResourceRecord(): res(0), usage(0), flags(0) {}
41
		ResourceRecord(): res(0), usage(0), flags(0) {}
42
 
42
 
43
		/// Construct a resource record with a name and a pointer.
43
		/// Construct a resource record with a name and a pointer.
44
		ResourceRecord(const std::string& _name, RES* _res, bool static_res=false): 
44
		ResourceRecord(const std::string& _name, RES* _res, bool static_res=false): 
45
			name(_name), 
45
			name(_name), 
46
			res(_res), 
46
			res(_res), 
47
			usage(0), 
47
			usage(0), 
48
			flags(static_res ? STATIC_RESOURCE : 0) 
48
			flags(static_res ? STATIC_RESOURCE : 0) 
49
		{
49
		{
50
			assert(res != 0);
50
			assert(res != 0);
51
		}
51
		}
52
 
52
 
53
		~ResourceRecord() 
53
		~ResourceRecord() 
54
		{
54
		{
55
#if CLEAN_SHUTDOWN
55
#if CLEAN_SHUTDOWN
56
			assert(usage==0);		
56
			assert(usage==0);		
57
#endif
57
#endif
58
		}
58
		}
59
	
59
	
60
		void erase_resource()
60
		void erase_resource()
61
		{
61
		{
62
			assert(usage==0);
62
			assert(usage==0);
63
			if(!(flags&STATIC_RESOURCE)) 
63
			if(!(flags&STATIC_RESOURCE)) 
64
				{
64
				{
65
					delete res;
65
					delete res;
66
				}
66
				}
67
		}
67
		}
68
 
68
 
69
		/// Increment the usage counter
69
		/// Increment the usage counter
70
		void increment_usage() 
70
		void increment_usage() 
71
		{
71
		{
72
			assert(usage>=0);
72
			assert(usage>=0);
73
			++usage;
73
			++usage;
74
		}
74
		}
75
 
75
 
76
		/// Decrement the usage counter. assert that counter is >0
76
		/// Decrement the usage counter. assert that counter is >0
77
		void decrement_usage() 
77
		void decrement_usage() 
78
		{
78
		{
79
			assert(usage>0);
79
			assert(usage>0);
80
			--usage;
80
			--usage;
81
		}
81
		}
82
 
82
 
83
		/// Return the usage count (mostly for debugging)
83
		/// Return the usage count (mostly for debugging)
84
		int get_usage() const { return usage; }
84
		int get_usage() const { return usage; }
85
 
85
 
86
		/// Get the name of a resource
86
		/// Get the name of a resource
87
		const std::string& get_name() const {return name;}
87
		const std::string& get_name() const {return name;}
88
 
88
 
89
		/// Get a pointer to the resource (const pointer)
89
		/// Get a pointer to the resource (const pointer)
90
		RES * const get_ptr() 
90
		RES * const get_ptr() 
91
		{
91
		{
92
			return res;
92
			return res;
93
		}
93
		}
94
 
94
 
95
		/// Get a resource pointer (const pointer and pointee)
95
		/// Get a resource pointer (const pointer and pointee)
96
		const RES * const get_ptr() const 
96
		const RES * const get_ptr() const 
97
		{
97
		{
98
			return res;
98
			return res;
99
		}
99
		}
100
 
100
 
101
		void remove_when_unused() 
101
		void remove_when_unused() 
102
		{
102
		{
103
/* 			assert(!(flags&STATIC_RESOURCE)); */
103
/* 			assert(!(flags&STATIC_RESOURCE)); */
104
/* 			if(!(flags&STATIC_RESOURCE)) */
104
/* 			if(!(flags&STATIC_RESOURCE)) */
105
				flags = flags|REMOVE_WHEN_UNUSED;
105
				flags = flags|REMOVE_WHEN_UNUSED;
106
		}
106
		}
107
 
107
 
108
		FlagByte get_flags() const { return flags;}
108
		FlagByte get_flags() const { return flags;}
109
	
109
	
110
	};
110
	};
111
 
111
 
112
 
112
 
113
	template<class RES> class ResourceManager;
113
	template<class RES> class ResourceManager;
114
 
114
 
115
 
115
 
116
	/** \brief Template for a pointer to a reference counted resource.
116
	/** \brief Template for a pointer to a reference counted resource.
117
 
117
 
118
      The ResourcePtr class template is a template for a reference
118
      The ResourcePtr class template is a template for a reference
119
			counted resource pointer. It is a smart pointer that actually points
119
			counted resource pointer. It is a smart pointer that actually points
120
			to a ResourceRecord and not to the actual resource. Since the record
120
			to a ResourceRecord and not to the actual resource. Since the record
121
			contains a reference count, we can increase the reference count when
121
			contains a reference count, we can increase the reference count when
122
			the pointer is copied and decrease it in the destructor. Only the
122
			the pointer is copied and decrease it in the destructor. Only the
123
			ResourceManager can create ResourcePtr's directly from a raw
123
			ResourceManager can create ResourcePtr's directly from a raw
124
			ResourceRecord. */
124
			ResourceRecord. */
125
	template<class RES>
125
	template<class RES>
126
	class ResourcePtr
126
	class ResourcePtr
127
	{
127
	{
128
		typedef ResourceRecord<RES> RR;
128
		typedef ResourceRecord<RES> RR;
129
		typedef std::list<RR> RRList;
129
		typedef std::list<RR> RRList;
130
		typedef typename RRList::iterator RRListIter;
130
		typedef typename RRList::iterator RRListIter;
131
 
131
 
132
		friend class ResourceManager<RES>;
132
		friend class ResourceManager<RES>;
133
 
133
 
134
	private:
134
	private:
135
		RRListIter rr;
135
		RRListIter rr;
136
		RES* res;
136
		RES* res;
137
	
137
	
138
		/** Explicit constructor with value. The constructor can only be called
138
		/** Explicit constructor with value. The constructor can only be called
139
				by a friend, i.e. the resource manager. */
139
				by a friend, i.e. the resource manager. */
140
		explicit ResourcePtr(const RRListIter& _rr): rr(_rr), res(0)
140
		explicit ResourcePtr(const RRListIter& _rr): rr(_rr), res(0)
141
		{
141
		{
142
			if(rr != 0)
142
			if(rr != 0)
143
				{
143
				{
144
					rr->increment_usage();
144
					rr->increment_usage();
145
					res = rr->get_ptr();
145
					res = rr->get_ptr();
146
				}
146
				}
147
		}
147
		}
148
 
148
 
149
		void decrement_usage();
149
		void decrement_usage();
150
	
150
	
151
	public:
151
	public:
152
	
152
	
153
		ResourcePtr(): rr(0), res(0) {}
153
		ResourcePtr(): rr(0), res(0) {}
154
	
154
	
155
		ResourcePtr(const ResourcePtr& r2): rr(r2.rr), res(0)
155
		ResourcePtr(const ResourcePtr& r2): rr(r2.rr), res(0)
156
		{
156
		{
157
			if(rr != 0)
157
			if(rr != 0)
158
				{
158
				{
159
					rr->increment_usage();
159
					rr->increment_usage();
160
					res = rr->get_ptr();
160
					res = rr->get_ptr();
161
				}
161
				}
162
		}
162
		}
163
 
163
 
164
		const ResourcePtr& operator=(const ResourcePtr& r2) 
164
		const ResourcePtr& operator=(const ResourcePtr& r2) 
165
		{
165
		{
166
			// Guard against self-assignment
166
			// Guard against self-assignment
167
			if (r2.rr != this->rr)
167
			if (r2.rr != this->rr)
168
				{
168
				{
169
					if(rr != 0)	decrement_usage();
169
					if(rr != 0)	decrement_usage();
170
 
170
 
171
					rr  = r2.rr;
171
					rr  = r2.rr;
172
					res = 0;
172
					res = 0;
173
 
173
 
174
					if(rr != 0)
174
					if(rr != 0)
175
						{
175
						{
176
							res = rr->get_ptr();
176
							res = rr->get_ptr();
177
							rr->increment_usage();
177
							rr->increment_usage();
178
						}
178
						}
179
				}
179
				}
180
			return *this;
180
			return *this;
181
		}
181
		}
182
 
182
 
183
		~ResourcePtr() {decrement_usage();}
183
		~ResourcePtr() {decrement_usage();}
184
 
184
 
185
		RES& operator*() const 
185
		RES& operator*() const 
186
		{
186
		{
187
			assert(rr != 0);
187
			assert(rr != 0);
188
			assert(res != 0);
188
			assert(res != 0);
189
			return *res;
189
			return *res;
190
		}
190
		}
191
 
191
 
192
		RES* const operator->() const 
192
		RES* const operator->() const 
193
		{
193
		{
194
			assert(rr != 0);
194
			assert(rr != 0);
195
			assert(res !=0);
195
			assert(res !=0);
196
			return res;
196
			return res;
197
		}
197
		}
198
 
198
 
199
		RES* const get_raw_ptr() const 
199
		RES* const get_raw_ptr() const 
200
		{
200
		{
201
			assert(rr != 0);
201
			assert(rr != 0);
202
			assert(res != 0);
202
			assert(res != 0);
203
			return res;
203
			return res;
204
		}
204
		}
205
 
205
 
206
		int usage() const
206
		int usage() const
207
		{
207
		{
208
			if(rr != 0)
208
			if(rr != 0)
209
				return rr->get_usage();
209
				return rr->get_usage();
210
			return -1;
210
			return -1;
211
		}
211
		}
212
 
212
 
213
		bool is_valid() const {return rr != 0;}
213
		bool is_valid() const {return rr != 0;}
214
 
214
 
215
		void relinquish_resource()
215
		void relinquish_resource()
216
		{
216
		{
217
			ResourcePtr p;
217
			ResourcePtr p;
218
			*this = p;
218
			*this = p;
219
		}
219
		}
220
 
220
 
221
		/** Calling this function sets the REMOVE_WHEN_UNUSED flag. If this 
221
		/** Calling this function sets the REMOVE_WHEN_UNUSED flag. If this 
222
				flag is set, the resource record is removed from the manager */
222
				flag is set, the resource record is removed from the manager */
223
		void remove_when_unused() {	rr->remove_when_unused(); }
223
		void remove_when_unused() {	rr->remove_when_unused(); }
224
	};
224
	};
225
 
225
 
226
 
226
 
227
	/** \brief Resource manager class.
227
	/** \brief Resource manager class.
228
 
228
 
229
      The ResourceManager is a singleton, and it uses Scott Meyers construct
229
      The ResourceManager is a singleton, and it uses Scott Meyers construct
230
			on first use idiom, i.e. the static function get_instance() will
230
			on first use idiom, i.e. the static function get_instance() will
231
			construct it when first called. There may be a problem with this
231
			construct it when first called. There may be a problem with this
232
			idion if resources depend on each other. However, that is only
232
			idion if resources depend on each other. However, that is only
233
			when the program shuts down.  See modern C++ design by
233
			when the program shuts down.  See modern C++ design by
234
			Alexandrescu for more information.
234
			Alexandrescu for more information.
235
 
235
 
236
			I'll try to make everything in this class private and accessed
236
			I'll try to make everything in this class private and accessed
237
			by a simple interface of friend functions.
237
			by a simple interface of friend functions.
238
 
238
 
239
	*/
239
	*/
240
 
240
 
241
	template<class RES>
241
	template<class RES>
242
	class ResourceManager
242
	class ResourceManager
243
	{
243
	{
244
		typedef ResourceRecord<RES> RR;
244
		typedef ResourceRecord<RES> RR;
245
		typedef std::list<RR> RRList;
245
		typedef std::list<RR> RRList;
246
		typedef typename RRList::iterator RRListIter;
246
		typedef typename RRList::iterator RRListIter;
247
		RRList resources;
247
		RRList resources;
248
	
248
	
249
		ResourceManager(): resources(0) {}
249
		ResourceManager(): resources(0) {}
250
		ResourceManager(const ResourceManager&);
250
		ResourceManager(const ResourceManager&);
251
		ResourceManager& operator=(const ResourceManager&);
251
		ResourceManager& operator=(const ResourceManager&);
252
 
252
 
253
	public:
253
	public:
254
 
254
 
255
 
255
 
256
		~ResourceManager()
256
		~ResourceManager()
257
		{
257
		{
258
#if CLEAN_SHUTDOWN
258
#if CLEAN_SHUTDOWN
259
			RRListIter i = resources.begin(); 
259
			RRListIter i = resources.begin(); 
260
			while(i != resources.end())
260
			while(i != resources.end())
261
				{
261
				{
262
					if(i->get_usage()==0)
262
					if(i->get_usage()==0)
263
						{
263
						{
264
							RRListIter tmp = i;
264
							RRListIter tmp = i;
265
							++i;
265
							++i;
266
							erase_resource(tmp);
266
							erase_resource(tmp);
267
						}
267
						}
268
					else
268
					else
269
						{
269
						{
270
							std::cout << "Warning, ResourceManager:\n\n"
270
							std::cout << "Warning, ResourceManager:\n\n"
271
												<< (typeid(this).name())
271
												<< (typeid(this).name())
272
												<< "\n\nis shutting down, and resource \n\n" 
272
												<< "\n\nis shutting down, and resource \n\n" 
273
												<< i->get_name() << "\n\nhas usage: " << i->get_usage()
273
												<< i->get_name() << "\n\nhas usage: " << i->get_usage()
274
												<< std::endl;
274
												<< std::endl;
275
							std::cout <<
275
							std::cout <<
276
 								"In other words, this resource is not unused at this\n"
276
 								"In other words, this resource is not unused at this\n"
277
								"point. That is unfortunate because then it cannot\n"
277
								"point. That is unfortunate because then it cannot\n"
278
								"be deleted (since it might be used by some other\n"
278
								"be deleted (since it might be used by some other\n"
279
								"part of the program during shutdown). Please ensure\n"
279
								"part of the program during shutdown). Please ensure\n"
280
								"that all resources are unused at program\n"
280
								"that all resources are unused at program\n"
281
								"termination. If you use a global ResourcePtr, this is\n"
281
								"termination. If you use a global ResourcePtr, this is\n"
282
								"done by calling relinquish_resource just before\n"
282
								"done by calling relinquish_resource just before\n"
283
								"exiting.\n"
283
								"exiting.\n"
284
												<< std::endl;
284
												<< std::endl;
285
							++i;
285
							++i;
286
						}
286
						}
287
				}
287
				}
288
#endif
288
#endif
289
		}
289
		}
290
 
290
 
291
		int get_no_resources() const
291
		int get_no_resources() const
292
		{
292
		{
293
			return resources.size();
293
			return resources.size();
294
		}
294
		}
295
 
295
 
296
		static ResourceManager& get_instance() 
296
		static ResourceManager& get_instance() 
297
		{
297
		{
298
			static ResourceManager instance;
298
			static ResourceManager instance;
299
			return instance;
299
			return instance;
300
		}
300
		}
301
 
301
 
302
		void erase_resource(RRListIter iter)
302
		void erase_resource(RRListIter iter)
303
		{
303
		{
304
			iter->erase_resource();
304
			iter->erase_resource();
305
			resources.erase(iter);
305
			resources.erase(iter);
306
		}
306
		}
307
 
307
 
308
		/** Find a resource and return a ResourcePtr to it. Returns the 
308
		/** Find a resource and return a ResourcePtr to it. Returns the 
309
				0 ResourcePtr if no string found. */
309
				0 ResourcePtr if no string found. */
310
		ResourcePtr<RES> get_resource_ptr(const std::string& str)
310
		ResourcePtr<RES> get_resource_ptr(const std::string& str)
311
		{
311
		{
312
			for(RRListIter i = resources.begin(); i != resources.end(); ++i)
312
			for(RRListIter i = resources.begin(); i != resources.end(); ++i)
313
				if((*i).get_name() == str) 
313
				if((*i).get_name() == str) 
314
					return ResourcePtr<RES>(i);
314
					return ResourcePtr<RES>(i);
315
			return ResourcePtr<RES>(0);
315
			return ResourcePtr<RES>(0);
316
		}
316
		}
317
 
317
 
318
		/** Add a resource with name passed as first argument and a pointer
318
		/** Add a resource with name passed as first argument and a pointer
319
				passed as 2nd argument. A ResourcePtr to the just inserted
319
				passed as 2nd argument. A ResourcePtr to the just inserted
320
				element is returned. */
320
				element is returned. */
321
		ResourcePtr<RES> register_resource(const std::string& str, 
321
		ResourcePtr<RES> register_resource(const std::string& str, 
322
																			 RES* res, bool static_resource)
322
																			 RES* res, bool static_resource)
323
		{
323
		{
324
			for(RRListIter i = resources.begin(); i != resources.end(); ++i)
324
			for(RRListIter i = resources.begin(); i != resources.end(); ++i)
325
				if(i->get_name() == str)
325
				if(i->get_name() == str)
326
					return (ResourcePtr<RES>(0));
326
					return (ResourcePtr<RES>(0));
327
 
327
 
328
			resources.push_front(RR(str, res, static_resource));
328
			resources.push_front(RR(str, res, static_resource));
329
			ResourcePtr<RES> ptr = ResourcePtr<RES>(resources.begin());
329
			ResourcePtr<RES> ptr = ResourcePtr<RES>(resources.begin());
330
			return ptr;
330
			return ptr;
331
		}
331
		}
332
 
332
 
333
/*		friend class ResourcePtr<RES>;
333
/*		friend class ResourcePtr<RES>;
334
		friend int get_no_resources<RES>();
334
		friend int get_no_resources<RES>();
335
		friend ResourcePtr<RES> get_resource_ptr<RES>(const std::string& str); 
335
		friend ResourcePtr<RES> get_resource_ptr<RES>(const std::string& str); 
336
		friend ResourcePtr<RES> register_static_resource<RES>(const std::string&,
336
		friend ResourcePtr<RES> register_static_resource<RES>(const std::string&,
337
																													RES*); 
337
																													RES*); 
338
		friend ResourcePtr<RES> register_dynamic_resource<RES>(const std::string&,
338
		friend ResourcePtr<RES> register_dynamic_resource<RES>(const std::string&,
339
																													 RES*);*/ 
339
																													 RES*);*/ 
340
	};
340
	};
341
 
341
 
342
	template<class RES>
342
	template<class RES>
343
	inline void ResourcePtr<RES>::decrement_usage()
343
	inline void ResourcePtr<RES>::decrement_usage()
344
	{
344
	{
345
		assert( (rr == 0) || (res != 0));
345
		assert( (rr == 0) || (res != 0));
346
		if(rr != 0)
346
		if(rr != 0)
347
			{
347
			{
348
				rr->decrement_usage();
348
				rr->decrement_usage();
349
				if(rr->get_usage() == 0 && (rr->get_flags()&REMOVE_WHEN_UNUSED))
349
				if(rr->get_usage() == 0 && (rr->get_flags()&REMOVE_WHEN_UNUSED))
350
					{
350
					{
351
						ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
351
						ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
352
						man.erase_resource(rr);
352
						man.erase_resource(rr);
353
					}
353
					}
354
			}
354
			}
355
	}
355
	}
356
 
356
 
357
	template<class RES>
357
	template<class RES>
358
	inline int get_no_resources()
358
	inline int get_no_resources()
359
	{
359
	{
360
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
360
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
361
		return man.get_no_resources();
361
		return man.get_no_resources();
362
	}
362
	}
363
 
363
 
364
	template<class RES>
364
	template<class RES>
365
	inline ResourcePtr<RES> get_resource_ptr(const std::string& str)
365
	inline ResourcePtr<RES> get_resource_ptr(const std::string& str)
366
	{
366
	{
367
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
367
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
368
		return man.get_resource_ptr(str);
368
		return man.get_resource_ptr(str);
369
	}
369
	}
370
 
370
 
371
	template<class RES>
371
	template<class RES>
372
	inline ResourcePtr<RES> register_dynamic_resource(const std::string& str,RES* res)
372
	inline ResourcePtr<RES> register_dynamic_resource(const std::string& str,RES* res)
373
	{
373
	{
374
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
374
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
375
		ResourcePtr<RES> ptr = man.register_resource(str, res, false);
375
		ResourcePtr<RES> ptr = man.register_resource(str, res, false);
376
		return ptr;
376
		return ptr;
377
	}
377
	}
378
 
378
 
379
	template<class RES>
379
	template<class RES>
380
	inline ResourcePtr<RES> register_static_resource(const std::string& str,RES* res)
380
	inline ResourcePtr<RES> register_static_resource(const std::string& str,RES* res)
381
	{
381
	{
382
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
382
		ResourceManager<RES>& man = ResourceManager<RES>::get_instance();
383
		ResourcePtr<RES> ptr = man.register_resource(str, res, true);
383
		ResourcePtr<RES> ptr = man.register_resource(str, res, true);
384
		return ptr;
384
		return ptr;
385
	}
385
	}
386
 
386
 
387
}
387
}
388
 
388
 
389
 
389
 
390
#endif
390
#endif
391
 
391