summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/emutempl.h
blob: c4fd064c15540d9ce0f22b3d3dfc356f5092ee94 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/***************************************************************************

    emutempl.h

    Core templates for basic non-string types.

****************************************************************************

    Copyright Aaron Giles
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are
    met:

        * Redistributions of source code must retain the above copyright
          notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright
          notice, this list of conditions and the following disclaimer in
          the documentation and/or other materials provided with the
          distribution.
        * Neither the name 'MAME' nor the names of its contributors may be
          used to endorse or promote products derived from this software
          without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY AARON GILES ''AS IS'' AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL AARON GILES BE LIABLE FOR ANY DIRECT,
    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

***************************************************************************/

#pragma once

#ifndef __EMUTEMPL_H__
#define __EMUTEMPL_H__


//**************************************************************************
//  TYPE DEFINITIONS
//**************************************************************************

// ======================> simple_list

// a simple_list is a singly-linked list whose 'next' pointer is owned
// by the object
template<class T>
class simple_list
{
	// we don't support deep copying
	DISABLE_COPYING(simple_list);

public:
	// construction/destruction
	simple_list(resource_pool &pool = global_resource_pool) :
		m_head(NULL),
		m_tail(NULL),
		m_pool(pool),
		m_count(0) { }

	virtual ~simple_list() { reset(); }

	// simple getters
	resource_pool &pool() const { return m_pool; }
	T *first() const { return m_head; }
	T *last() const { return m_tail; }
	int count() const { return m_count; }

	// remove (free) all objects in the list, leaving an empty list
	void reset()
	{
		while (m_head != NULL)
			remove(*m_head);
	}

	// add the given object to the head of the list
	T &prepend(T &object)
	{
		object.m_next = m_head;
		m_head = &object;
		if (m_tail == NULL)
			m_tail = m_head;
		m_count++;
		return object;
	}

	// add the given list to the head of the list
	void prepend_list(simple_list<T> &list)
	{
		int count = list.count();
		if (count == 0)
			return;
		T *tail = list.last();
		T *head = list.detach_all();
		tail->m_next = m_head;
		m_head = head;
		if (m_tail == NULL)
			m_tail = tail;
		m_count += count;
	}

	// add the given object to the tail of the list
	T &append(T &object)
	{
		object.m_next = NULL;
		if (m_tail != NULL)
			m_tail = m_tail->m_next = &object;
		else
			m_tail = m_head = &object;
		m_count++;
		return object;
	}

	// add the given list to the tail of the list
	void append_list(simple_list<T> &list)
	{
		int count = list.count();
		if (count == 0)
			return;
		T *tail = list.last();
		T *head = list.detach_all();
		if (m_tail != NULL)
			m_tail->m_next = head;
		else
			m_head = head;
		m_tail = tail;
		m_count += count;
	}

	// insert the given object after a particular object (NULL means prepend)
	T &insert_after(T &object, T *insert_after)
	{
		if (insert_after == NULL)
			return prepend(object);
		object.m_next = insert_after->m_next;
		insert_after->m_next = &object;
		m_count++;
		return object;
	}

	// replace an item in the list at the same location, and remove it
	T &replace_and_remove(T &object, T &toreplace)
	{
		T *prev = NULL;
		for (T *cur = m_head; cur != NULL; prev = cur, cur = cur->m_next)
			if (cur == &toreplace)
			{
				if (prev != NULL)
					prev->m_next = &object;
				else
					m_head = &object;
				if (m_tail == &toreplace)
					m_tail = &object;
				object.m_next = toreplace.m_next;
				pool_free(m_pool, &toreplace);
				return object;
			}
		return append(object);
	}

	// detach the head item from the list, but don't free its memory
	T *detach_head()
	{
		T *result = m_head;
		if (result != NULL)
		{
			m_head = result->m_next;
			m_count--;
			if (m_head == NULL)
				m_tail = NULL;
		}
		return result;
	}

	// detach the given item from the list, but don't free its memory
	T &detach(T &object)
	{
		T *prev = NULL;
		for (T *cur = m_head; cur != NULL; prev = cur, cur = cur->m_next)
			if (cur == &object)
			{
				if (prev != NULL)
					prev->m_next = object.m_next;
				else
					m_head = object.m_next;
				if (m_tail == &object)
					m_tail = prev;
				m_count--;
				return object;
			}
		return object;
	}

	// deatch the entire list, returning the head, but don't free memory
	T *detach_all()
	{
		T *result = m_head;
		m_head = m_tail = NULL;
		m_count = 0;
		return result;
	}

	// remove the given object and free its memory
	void remove(T &object)
	{
		detach(object);
		pool_free(m_pool, &object);
	}

	// find an object by index in the list
	T *find(int index) const
	{
		for (T *cur = m_head; cur != NULL; cur = cur->m_next)
			if (index-- == 0)
				return cur;
		return NULL;
	}

	// return the index of the given object in the list
	int indexof(const T &object) const
	{
		int index = 0;
		for (T *cur = m_head; cur != NULL; cur = cur->m_next)
		{
			if (cur == &object)
				return index;
			index++;
		}
		return -1;
	}

private:
	// internal state
	T *				m_head;			// head of the singly-linked list
	T *				m_tail;			// tail of the singly-linked list
	resource_pool &	m_pool;			// resource pool where objects are freed
	int 			m_count;		// number of objects in the list
};


// ======================> simple_list_wrapper

// a simple_list_wrapper wraps an existing object with a next pointer so it 
// can live in a simple_list without requiring the object to have a next
// pointer
template<class T>
class simple_list_wrapper
{
public:
	// construction/destruction
	simple_list_wrapper(T *object)
		: m_next(NULL),
		  m_object(object) { }
	
	// operators
	operator T *() { return m_object; }
	operator T *() const { return m_object; }
	T *operator *() { return m_object; }
	T *operator *() const { return m_object; }
	
	// getters
	simple_list_wrapper *next() const { return m_next; }
	T *object() const { return m_object; }

private:
	// internal state
	simple_list_wrapper *	m_next;
	T *						m_object;
};


// ======================> fixed_allocator

// a fixed_allocator is a simple class that maintains a free pool of objects
template<class T>
class fixed_allocator
{
	// we don't support deep copying
	DISABLE_COPYING(fixed_allocator);

public:
	// construction/destruction
	fixed_allocator(resource_pool &pool = global_resource_pool)
		: m_freelist(pool) { }

	// allocate a new item, either by recycling an old one, or by allocating a new one
	T *alloc()
	{
		T *result = m_freelist.detach_head();
		if (result == NULL)
			result = m_freelist.pool().add_object(new T);
		return result;
	}

	// reclaim an item by adding it to the free list
	void reclaim(T *item) { if (item != NULL) m_freelist.append(*item); }
	void reclaim(T &item) { m_freelist.append(item); }

	// reclaim all items from a list
	void reclaim_all(simple_list<T> &list) { m_freelist.append_list(list); }

private:
	// internal state
	simple_list<T>	m_freelist;		// list of free objects
};


// ======================> tagged_list

// a tagged_list is a class that maintains a list of objects that can be quickly looked up by tag
template<class T>
class tagged_list
{
	// we don't support deep copying
	DISABLE_COPYING(tagged_list);

public:
	// construction/destruction
	tagged_list(resource_pool &pool = global_resource_pool) :
		m_list(pool) { }

	// simple getters
	resource_pool &pool() const { return m_list.pool(); }
	T *first() const { return m_list.first(); }
	T *last() const { return m_list.last(); }
	int count() const { return m_list.count(); }

	// remove (free) all objects in the list, leaving an empty list
	void reset() { m_list.reset(); m_map.reset(); }

	// add the given object to the head of the list
	T &prepend(const char *tag, T &object)
	{
		if (m_map.add_unique_hash(tag, &object, false) != TMERR_NONE)
			throw emu_fatalerror("Error adding object named '%s'", tag);
		return m_list.prepend(object);
	}

	// add the given object to the tail of the list
	T &append(const char *tag, T &object)
	{
		if (m_map.add_unique_hash(tag, &object, false) != TMERR_NONE)
			throw emu_fatalerror("Error adding object named '%s'", tag);
		return m_list.append(object);
	}

	// insert the given object after a particular object (NULL means prepend)
	T &insert_after(const char *tag, T &object, T *insert_after)
	{
		if (m_map.add_unique_hash(tag, &object, false) != TMERR_NONE)
			throw emu_fatalerror("Error adding object named '%s'", tag);
		return m_list.insert_after(object, insert_after);
	}

	// replace an item in the list at the same location, and remove it
	T &replace_and_remove(const char *tag, T &object, T &toreplace)
	{
		m_map.remove(&toreplace);
		m_list.replace_and_remove(object, toreplace);
		if (m_map.add_unique_hash(tag, &object, false) != TMERR_NONE)
			throw emu_fatalerror("Error replacing object named '%s'", tag);
		return object;
	}

	// detach the given item from the list, but don't free its memory
	T &detach(T &object)
	{
		m_map.remove(&object);
		return m_list.detach(object);
	}

	// remove the given object and free its memory
	void remove(T &object)
	{
		m_map.remove(&object);
		return m_list.remove(object);
	}

	// find an object by index in the list
	T *find(int index) const
	{
		return m_list.find(index);
	}

	// return the index of the given object in the list
	int indexof(const T &object) const
	{
		return m_list.indexof(object);
	}

	// operations by tag
	T &replace_and_remove(const char *tag, T &object) { T *existing = find(tag); return (existing == NULL) ? append(tag, object) : replace_and_remove(tag, object, *existing); }
	void remove(const char *tag) { T *object = find(tag); if (object != NULL) remove(*object); }
	T *find(const char *tag) const { return m_map.find_hash_only(tag); }
	int indexof(const char *tag) const { T *object = find(tag); return (object != NULL) ? m_list.indexof(*object) : NULL; }

private:
	// internal state
	simple_list<T>		m_list;
	tagmap_t<T *>		m_map;
};


#endif	/* __EMUTEMPL_H__ */