sourcehook/sh_list.h
author Christian Hammacher <bmasterc@gmail.com>
Sun Feb 12 21:07:31 2006 +0000 (2006-02-12)
changeset 182 f60d482a6e07
parent 163 377bdd31c28d
child 279 4836de1350c5
permissions -rw-r--r--
Changed version number to 1.2.1
dvander@98
     1
/* ======== SourceMM ========
dvander@98
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@98
     3
* No warranties of any kind
dvander@98
     4
*
dvander@98
     5
* License: zlib/libpng
dvander@98
     6
*
dvander@98
     7
* Author(s): David "BAILOPAN" Anderson
dvander@98
     8
* ============================
dvander@98
     9
*/
dvander@98
    10
dvander@98
    11
#ifndef _INCLUDE_SMM_LIST_H
dvander@98
    12
#define _INCLUDE_SMM_LIST_H
dvander@98
    13
pavolmarko@119
    14
#include <new>
dvander@120
    15
#include <malloc.h>
dvander@107
    16
dvander@98
    17
namespace SourceHook
dvander@98
    18
{
pavolmarko@163
    19
pavolmarko@163
    20
	//This class is from CSDM for AMX Mod X
pavolmarko@163
    21
	/*
pavolmarko@163
    22
		A circular, doubly-linked list with one sentinel node
pavolmarko@163
    23
pavolmarko@163
    24
		Empty:
pavolmarko@163
    25
			m_Head = sentinel
pavolmarko@163
    26
			m_Head->next = m_Head;
pavolmarko@163
    27
			m_Head->prev = m_Head;
pavolmarko@163
    28
		One element:
pavolmarko@163
    29
			m_Head = sentinel
pavolmarko@163
    30
			m_Head->next = node1
pavolmarko@163
    31
			m_Head->prev = node1
pavolmarko@163
    32
			node1->next = m_Head
pavolmarko@163
    33
			node1->prev = m_Head
pavolmarko@163
    34
		Two elements:
pavolmarko@163
    35
			m_Head = sentinel
pavolmarko@163
    36
			m_Head->next = node1
pavolmarko@163
    37
			m_Head->prev = node2
pavolmarko@163
    38
			node1->next = node2
pavolmarko@163
    39
			node1->prev = m_Head
pavolmarko@163
    40
			node2->next = m_Head
pavolmarko@163
    41
			node2->prev = node1
pavolmarko@163
    42
	*/
pavolmarko@163
    43
	template <class T>
pavolmarko@163
    44
	class List
dvander@98
    45
	{
dvander@98
    46
	public:
pavolmarko@163
    47
		class iterator;
pavolmarko@163
    48
		friend class iterator;
pavolmarko@163
    49
		class ListNode
pavolmarko@163
    50
		{
pavolmarko@163
    51
		public:
pavolmarko@163
    52
			ListNode(const T & o) : obj(o) { };
pavolmarko@163
    53
			ListNode() { };
pavolmarko@163
    54
			T obj;
pavolmarko@163
    55
			ListNode *next;
pavolmarko@163
    56
			ListNode *prev;
pavolmarko@163
    57
		};
pavolmarko@163
    58
	private:
pavolmarko@163
    59
		// Initializes the sentinel node.
pavolmarko@163
    60
		// BAIL used malloc instead of new in order to bypass the need for a constructor.
pavolmarko@163
    61
		ListNode *_Initialize()
dvander@98
    62
		{
pavolmarko@163
    63
			ListNode *n = (ListNode *)malloc(sizeof(ListNode));
pavolmarko@163
    64
			n->next = n;
pavolmarko@163
    65
			n->prev = n;
pavolmarko@163
    66
			return n;
pavolmarko@163
    67
		}
pavolmarko@163
    68
	public:
pavolmarko@163
    69
		List() : m_Head(_Initialize()), m_Size(0)
pavolmarko@163
    70
		{
dvander@98
    71
		}
pavolmarko@163
    72
		List(const List &src) : m_Head(_Initialize()), m_Size(0)
pavolmarko@163
    73
		{
pavolmarko@163
    74
			iterator iter;
pavolmarko@163
    75
			for (iter=src.begin(); iter!=src.end(); iter++)
pavolmarko@163
    76
				push_back( (*iter) );
pavolmarko@163
    77
		}
pavolmarko@163
    78
		~List()
pavolmarko@163
    79
		{
pavolmarko@163
    80
			clear();
dvander@98
    81
pavolmarko@163
    82
			// Don't forget to free the sentinel
pavolmarko@163
    83
			if (m_Head)
pavolmarko@163
    84
			{
pavolmarko@163
    85
				free(m_Head);
pavolmarko@163
    86
				m_Head = NULL;
pavolmarko@163
    87
			}
pavolmarko@163
    88
		}
pavolmarko@163
    89
		void push_back(const T &obj)
dvander@98
    90
		{
pavolmarko@163
    91
			ListNode *node = new ListNode(obj);
pavolmarko@163
    92
dvander@98
    93
			node->prev = m_Head->prev;
dvander@98
    94
			node->next = m_Head;
dvander@98
    95
			m_Head->prev->next = node;
dvander@98
    96
			m_Head->prev = node;
pavolmarko@163
    97
pavolmarko@163
    98
			m_Size++;
dvander@98
    99
		}
pavolmarko@163
   100
		size_t size()
pavolmarko@163
   101
		{
pavolmarko@163
   102
			return m_Size;
pavolmarko@163
   103
		}
pavolmarko@163
   104
pavolmarko@163
   105
		void clear()
dvander@98
   106
		{
pavolmarko@163
   107
			ListNode *node = m_Head->next;
pavolmarko@163
   108
			ListNode *temp;
pavolmarko@163
   109
			m_Head->next = m_Head;
pavolmarko@163
   110
			m_Head->prev = m_Head;
pavolmarko@163
   111
pavolmarko@163
   112
			// Iterate through the nodes until we find g_Head (the sentinel) again
pavolmarko@163
   113
			while (node != m_Head)
pavolmarko@163
   114
			{
pavolmarko@163
   115
				temp = node->next;
pavolmarko@163
   116
				delete node;
pavolmarko@163
   117
				node = temp;
pavolmarko@163
   118
			}
pavolmarko@163
   119
			m_Size = 0;
dvander@98
   120
		}
pavolmarko@163
   121
		bool empty()
pavolmarko@163
   122
		{
pavolmarko@163
   123
			return (m_Size == 0);
pavolmarko@163
   124
		}
pavolmarko@163
   125
		T & back()
pavolmarko@163
   126
		{
pavolmarko@163
   127
			return m_Head->prev->obj;
pavolmarko@163
   128
		}
pavolmarko@163
   129
	private:
pavolmarko@163
   130
		ListNode *m_Head;
pavolmarko@163
   131
		size_t m_Size;
dvander@98
   132
	public:
pavolmarko@163
   133
		class iterator
dvander@98
   134
		{
pavolmarko@163
   135
		friend class List;
pavolmarko@163
   136
		public:
pavolmarko@163
   137
			iterator()
pavolmarko@163
   138
			{
pavolmarko@163
   139
				m_This = NULL;
pavolmarko@163
   140
			}
pavolmarko@163
   141
			iterator(const List &src)
pavolmarko@163
   142
			{
pavolmarko@163
   143
				m_This = src.m_Head;
pavolmarko@163
   144
			}
pavolmarko@163
   145
			iterator(ListNode *n) : m_This(n)
pavolmarko@163
   146
			{
pavolmarko@163
   147
			}
pavolmarko@163
   148
			iterator(const iterator &where)
pavolmarko@163
   149
			{
pavolmarko@163
   150
				m_This = where.m_This;
pavolmarko@163
   151
			}
pavolmarko@163
   152
			//pre decrement
pavolmarko@163
   153
			iterator & operator--()
pavolmarko@163
   154
			{
pavolmarko@163
   155
				if (m_This)
pavolmarko@163
   156
					m_This = m_This->prev;
pavolmarko@163
   157
				return *this;
pavolmarko@163
   158
			}
pavolmarko@163
   159
			//post decrement
pavolmarko@163
   160
			iterator operator--(int)
pavolmarko@163
   161
			{
pavolmarko@163
   162
				iterator old(*this);
pavolmarko@163
   163
				if (m_This)
pavolmarko@163
   164
					m_This = m_This->prev;
pavolmarko@163
   165
				return old;
pavolmarko@163
   166
			}	
pavolmarko@163
   167
			
pavolmarko@163
   168
			//pre increment
pavolmarko@163
   169
			iterator & operator++()
pavolmarko@163
   170
			{
pavolmarko@163
   171
				if (m_This)
pavolmarko@163
   172
					m_This = m_This->next;
pavolmarko@163
   173
				return *this;
pavolmarko@163
   174
			}
pavolmarko@163
   175
			//post increment
pavolmarko@163
   176
			iterator operator++(int)
pavolmarko@163
   177
			{
pavolmarko@163
   178
				iterator old(*this);
pavolmarko@163
   179
				if (m_This)
pavolmarko@163
   180
					m_This = m_This->next;
pavolmarko@163
   181
				return old;
pavolmarko@163
   182
			}
pavolmarko@163
   183
			
pavolmarko@163
   184
			const T & operator * () const
pavolmarko@163
   185
			{
pavolmarko@163
   186
				return m_This->obj;
pavolmarko@163
   187
			}
pavolmarko@163
   188
			T & operator * ()
pavolmarko@163
   189
			{
pavolmarko@163
   190
				return m_This->obj;
pavolmarko@163
   191
			}
pavolmarko@163
   192
			
pavolmarko@163
   193
			T * operator -> ()
pavolmarko@163
   194
			{
pavolmarko@163
   195
				return &(m_This->obj);
pavolmarko@163
   196
			}
pavolmarko@163
   197
			const T * operator -> () const
pavolmarko@163
   198
			{
pavolmarko@163
   199
				return &(m_This->obj);
pavolmarko@163
   200
			}
pavolmarko@163
   201
			
pavolmarko@163
   202
			bool operator != (const iterator &where) const
pavolmarko@163
   203
			{
pavolmarko@163
   204
				return (m_This != where.m_This);
pavolmarko@163
   205
			}
pavolmarko@163
   206
			bool operator ==(const iterator &where) const
pavolmarko@163
   207
			{
pavolmarko@163
   208
				return (m_This == where.m_This);
pavolmarko@163
   209
			}
pavolmarko@163
   210
		private:
pavolmarko@163
   211
			ListNode *m_This;
pavolmarko@163
   212
		};
pavolmarko@163
   213
	public:
pavolmarko@163
   214
		iterator begin() const
pavolmarko@111
   215
		{
pavolmarko@163
   216
			return iterator(m_Head->next);
pavolmarko@163
   217
		}
pavolmarko@163
   218
		iterator end() const
pavolmarko@163
   219
		{
pavolmarko@163
   220
			return iterator(m_Head);
pavolmarko@163
   221
		}
pavolmarko@163
   222
		iterator erase(iterator &where)
pavolmarko@163
   223
		{
pavolmarko@163
   224
			ListNode *pNode = where.m_This;
pavolmarko@163
   225
			iterator iter(where);
pavolmarko@163
   226
			iter++;
pavolmarko@163
   227
pavolmarko@163
   228
pavolmarko@163
   229
			// Works for all cases: empty list, erasing first element, erasing tail, erasing in the middle...
pavolmarko@163
   230
			pNode->prev->next = pNode->next;
pavolmarko@163
   231
			pNode->next->prev = pNode->prev;
pavolmarko@163
   232
pavolmarko@163
   233
			delete pNode;
pavolmarko@163
   234
			m_Size--;
pavolmarko@163
   235
pavolmarko@163
   236
			return iter;
pavolmarko@163
   237
		}
pavolmarko@163
   238
pavolmarko@163
   239
		iterator insert(iterator where, const T &obj)
dvander@98
   240
		{
pavolmarko@163
   241
			// Insert obj right before where
pavolmarko@163
   242
pavolmarko@163
   243
			ListNode *node = new ListNode(obj);
pavolmarko@163
   244
			ListNode *pWhereNode = where.m_This;
pavolmarko@163
   245
			
pavolmarko@163
   246
			pWhereNode->prev->next = node;
pavolmarko@163
   247
			node->prev = pWhereNode->prev;
pavolmarko@163
   248
			pWhereNode->prev = node;
pavolmarko@163
   249
			node->next = pWhereNode;
pavolmarko@163
   250
pavolmarko@163
   251
			m_Size++;
pavolmarko@163
   252
pavolmarko@163
   253
			return iterator(node);
pavolmarko@163
   254
		}
pavolmarko@163
   255
pavolmarko@163
   256
	public:
pavolmarko@163
   257
		void remove(const T & obj)
pavolmarko@163
   258
		{
pavolmarko@163
   259
			iterator b;
pavolmarko@163
   260
			for (b=begin(); b!=end(); b++)
pavolmarko@163
   261
			{
pavolmarko@163
   262
				if ( (*b) == obj )
pavolmarko@163
   263
				{
pavolmarko@163
   264
					erase( b );
pavolmarko@163
   265
					break;
pavolmarko@163
   266
				}
pavolmarko@163
   267
			}
pavolmarko@163
   268
		}
pavolmarko@163
   269
		template <typename U>
pavolmarko@163
   270
		iterator find(const U & equ)
pavolmarko@163
   271
		{
pavolmarko@163
   272
			iterator iter;
pavolmarko@163
   273
			for (iter=begin(); iter!=end(); iter++)
pavolmarko@163
   274
			{
pavolmarko@163
   275
				if ( (*iter) == equ )
pavolmarko@163
   276
					return iter;
pavolmarko@163
   277
			}
pavolmarko@163
   278
			return end();
pavolmarko@163
   279
		}
pavolmarko@163
   280
		List & operator =(const List &src)
pavolmarko@163
   281
		{
pavolmarko@163
   282
			clear();
pavolmarko@163
   283
			iterator iter;
pavolmarko@163
   284
			for (iter=src.begin(); iter!=src.end(); iter++)
pavolmarko@163
   285
				push_back( (*iter) );
dvander@98
   286
			return *this;
dvander@98
   287
		}
dvander@98
   288
	};
dvander@98
   289
};	//NAMESPACE
dvander@98
   290
dvander@98
   291
#endif //_INCLUDE_CSDM_LIST_H