isle/LEGO1/mxhashtable.h

#ifndef MXHASHTABLE_H
#define MXHASHTABLE_H

#include "mxcollection.h"
#include "mxcore.h"
#include "mxtypes.h"

#define HASH_TABLE_INIT_SIZE 128

template <class T>
class MxHashTableCursor;

template <class T>
class MxHashTableNode {
public:
	MxHashTableNode<T>(T p_obj, MxU32 p_hash)
	{
		m_obj = p_obj;
		m_hash = p_hash;
		m_prev = NULL;
		m_next = NULL;
	}

	// DECOMP: Should use getter and setter methods here per the style guide.
	// However, LEGO1D (with no functions inlined) does not use them.
	T m_obj;
	MxU32 m_hash;
	MxHashTableNode* m_prev;
	MxHashTableNode* m_next;
};

template <class T>
class MxHashTable : protected MxCollection<T> {
public:
	enum HashTableOpt {
		HashTableOpt_NoExpand = 0,
		HashTableOpt_ExpandAdd = 1,
		HashTableOpt_ExpandMultiply = 2,
	};

	MxHashTable()
	{
		m_numSlots = HASH_TABLE_INIT_SIZE;
		m_slots = new MxHashTableNode<T>*[HASH_TABLE_INIT_SIZE];
		memset(m_slots, 0, sizeof(MxHashTableNode<T>*) * m_numSlots);
		m_resizeOption = HashTableOpt_NoExpand;
	}

	virtual ~MxHashTable() override;

	void Resize();
	void Add(T);
	void DeleteAll();

	virtual MxU32 Hash(T) { return 0; }

	friend class MxHashTableCursor<T>;

protected:
	void _NodeInsert(MxHashTableNode<T>*);

	MxHashTableNode<T>** m_slots; // +0x10
	MxU32 m_numSlots;             // +0x14
	MxU32 m_autoResizeRatio;      // +0x18
	HashTableOpt m_resizeOption;  // +0x1c
	// FIXME: or FIXME? This qword is used as an integer or double depending
	// on the value of m_resizeOption. Hard to say whether this is how the devs
	// did it, but a simple cast in either direction doesn't match.
	union {
		MxU32 m_increaseAmount;  // +0x20
		double m_increaseFactor; // +0x20
	};
};

template <class T>
class MxHashTableCursor : public MxCore {
public:
	MxHashTableCursor(MxHashTable<T>* p_table)
	{
		m_table = p_table;
		m_match = NULL;
	}

	MxBool Find(T p_obj);
	MxBool Current(T& p_obj);
	void DeleteMatch();

private:
	MxHashTable<T>* m_table;
	MxHashTableNode<T>* m_match;
};

template <class T>
MxBool MxHashTableCursor<T>::Find(T p_obj)
{
	MxU32 hash = m_table->Hash(p_obj);
	MxS32 bucket = hash % m_table->m_numSlots;

	MxHashTableNode<T>* t = m_table->m_slots[bucket];

	while (t) {
		if (t->m_hash == hash && !m_table->Compare(t->m_obj, p_obj))
			m_match = t;
		t = t->m_next;
	}

	return m_match != NULL;
}

template <class T>
MxBool MxHashTableCursor<T>::Current(T& p_obj)
{
	if (m_match) {
		p_obj = m_match->m_obj;
	}

	return m_match != NULL;
}

template <class T>
void MxHashTableCursor<T>::DeleteMatch()
{
	// Cut the matching node out of the linked list
	// by updating pointer references.
	if (m_match == NULL)
		return;

	if (m_match->m_prev) {
		m_match->m_prev->m_next = m_match->m_next;
	}
	else {
		// No "prev" node, so move "next" to the head of the list.
		MxS32 bucket = m_match->m_hash % m_table->m_numSlots;
		m_table->m_slots[bucket] = m_match->m_next;
	}

	if (m_match->m_next)
		m_match->m_next->m_prev = m_match->m_prev;

	m_table->m_customDestructor(m_match->m_obj);
	delete m_match;
	m_table->m_count--;
}

template <class T>
MxHashTable<T>::~MxHashTable()
{
	DeleteAll();
}

template <class T>
void MxHashTable<T>::DeleteAll()
{
	for (MxS32 i = 0; i < m_numSlots; i++) {
		MxHashTableNode<T>* t = m_slots[i];

		while (t) {
			MxHashTableNode<T>* next = t->m_next;
			m_customDestructor(t->m_obj);
			delete t;
			t = next;
		}
	}

	m_count = 0;
	memset(m_slots, 0, sizeof(MxHashTableNode<T>*) * m_numSlots);

	delete[] m_slots;
}

template <class T>
inline void MxHashTable<T>::Resize()
{
	// Save a reference to the current table
	// so we can walk nodes and re-insert
	MxU32 old_size = m_numSlots;
	MxHashTableNode<T>** old_table = m_slots;

	switch (m_resizeOption) {
	case HashTableOpt_ExpandAdd:
		m_numSlots += m_increaseAmount;
		break;
	case HashTableOpt_ExpandMultiply:
		m_numSlots *= m_increaseFactor;
		break;
	}

	MxHashTableNode<T>** new_table = new MxHashTableNode<T>*[m_numSlots];
	m_slots = new_table;
	memset(m_slots, 0, sizeof(MxHashTableNode<T>*) * m_numSlots);
	m_count = 0;

	for (MxS32 i = 0; i != old_size; i++) {
		MxHashTableNode<T>* t = old_table[i];

		while (t) {
			MxHashTableNode<T>* next = t->m_next;
			_NodeInsert(t);
			t = next;
		}
	}

	delete[] old_table;
}

template <class T>
inline void MxHashTable<T>::_NodeInsert(MxHashTableNode<T>* p_node)
{
	MxS32 bucket = p_node->m_hash % m_numSlots;

	p_node->m_next = m_slots[bucket];

	if (m_slots[bucket])
		m_slots[bucket]->m_prev = p_node;

	m_slots[bucket] = p_node;
	m_count++;
}

template <class T>
inline void MxHashTable<T>::Add(T p_newobj)
{
	if (m_resizeOption && ((m_count + 1) / m_numSlots) > m_autoResizeRatio)
		MxHashTable<T>::Resize();

	MxU32 hash = Hash(p_newobj);
	MxHashTableNode<T>* node = new MxHashTableNode<T>(p_newobj, hash);

	MxHashTable<T>::_NodeInsert(node);
}

#undef HASH_TABLE_INIT_SIZE

#endif // MXHASHTABLE_H