From 69e64ac8c39f5415161a1d763d04b595347fd866 Mon Sep 17 00:00:00 2001
From: Kawe Mazidjatari <48657826+Mauler125@users.noreply.github.com>
Date: Sat, 23 Dec 2023 17:21:20 +0100
Subject: [PATCH] Create utlstringmap.h

---
 src/public/tier1/utlstringmap.h | 185 ++++++++++++++++++++++++++++++++
 1 file changed, 185 insertions(+)
 create mode 100644 src/public/tier1/utlstringmap.h

diff --git a/src/public/tier1/utlstringmap.h b/src/public/tier1/utlstringmap.h
new file mode 100644
index 00000000..82c2e975
--- /dev/null
+++ b/src/public/tier1/utlstringmap.h
@@ -0,0 +1,185 @@
+//===== Copyright � 1996-2005, Valve Corporation, All rights reserved. ======//
+//
+// Purpose: 
+//
+//===========================================================================//
+
+#ifndef UTLSTRINGMAP_H
+#define UTLSTRINGMAP_H
+#ifdef _WIN32
+#pragma once
+#endif
+
+#include "utlsymbol.h"
+
+template <class T>
+class CUtlStringMap
+{
+public:
+	typedef UtlSymId_t IndexType_t;
+	CUtlStringMap( bool caseInsensitive = true, int initsize = 32 ) :
+	  m_SymbolTable( 0, 32, caseInsensitive ),
+		  m_Vector( initsize )
+	{
+	}
+
+	// Get data by the string itself:
+	T& operator[]( const char *pString )
+	{
+		CUtlSymbol symbol = m_SymbolTable.AddString( pString );
+		int index = ( int )( UtlSymId_t )symbol;
+		if( m_Vector.Count() <= index )
+		{
+			m_Vector.EnsureCount( index + 1 );
+		}
+		return m_Vector[index];
+	}
+
+	// Get data by the string's symbol table ID - only used to retrieve a pre-existing symbol, not create a new one!
+	T& operator[]( UtlSymId_t n )
+	{
+		Assert( n <= m_Vector.Count() );
+		return m_Vector[n];
+	}
+
+	const T& operator[]( UtlSymId_t n ) const
+	{
+		Assert( n <= m_Vector.Count() );
+		return m_Vector[n];
+	}
+
+	unsigned int Count() const
+	{
+		Assert( m_Vector.Count() == m_SymbolTable.GetNumStrings() );
+		return m_Vector.Count();
+	}
+
+	bool Defined( const char *pString ) const
+	{
+		return m_SymbolTable.Find( pString ) != UTL_INVAL_SYMBOL;
+	}
+
+	UtlSymId_t Find( const char *pString ) const
+	{
+		return m_SymbolTable.Find( pString );
+	}
+
+	UtlSymId_t AddString( const char *pString )
+	{
+		CUtlSymbol symbol = m_SymbolTable.AddString( pString );
+		int index = ( int )( UtlSymId_t )symbol;
+		if( m_Vector.Count() <= index )
+		{
+			m_Vector.EnsureCount( index + 1 );
+		}
+		return symbol;
+	}
+
+	/// Add a string to the map and also insert an item at 
+	/// its location in the same operation. Returns the 
+	/// newly created index (or the one that was just 
+	/// overwritten, if pString already existed.)
+	UtlSymId_t Insert( const char *pString, const T &item )
+	{
+		CUtlSymbol symbol = m_SymbolTable.AddString( pString );
+		UtlSymId_t index = symbol; // implicit coercion
+		if ( m_Vector.Count() > index ) 
+		{
+			// this string is already in the dictionary.
+
+		}
+		else if ( m_Vector.Count() == index )
+		{
+			// this is the expected case when we've added one more to the tail.
+			m_Vector.AddToTail( item );
+		}
+		else // ( m_Vector.Count() < index )
+		{
+			// this is a strange shouldn't-happen case.
+			AssertMsg( false, "CUtlStringMap insert unexpected entries." );
+			m_Vector.EnsureCount( index + 1 );
+			m_Vector[index] = item;
+		}
+		return index;
+	}
+
+	/// iterate, not in any particular order.
+	IndexType_t First() const 
+	{
+		if ( Count() > 0 )
+		{
+			return 0;
+		}
+		else
+		{
+			return InvalidIndex();
+		}
+	}
+
+	static UtlSymId_t InvalidIndex()
+	{
+		return UTL_INVAL_SYMBOL;
+	}
+
+	// iterators (for uniformity with other map types)
+	inline UtlSymId_t Head() const
+	{
+		return m_SymbolTable.GetNumStrings() > 0 ? 0 : InvalidIndex();
+	}
+
+	inline UtlSymId_t Next( const UtlSymId_t &i ) const
+	{
+		UtlSymId_t n = i+1;
+		return n < m_SymbolTable.GetNumStrings() ? n : InvalidIndex();
+	}
+
+
+	int GetNumStrings( void ) const
+	{
+		return m_SymbolTable.GetNumStrings();
+	}
+
+	const char *String( int n )	const
+	{
+		return m_SymbolTable.String( n );
+	}
+
+	// Clear all of the data from the map
+	void Clear()
+	{
+		m_Vector.RemoveAll();
+		m_SymbolTable.RemoveAll();
+	}
+
+	void Purge()
+	{
+		m_Vector.Purge();
+		m_SymbolTable.RemoveAll();
+	}
+
+	void PurgeAndDeleteElements()
+	{
+		m_Vector.PurgeAndDeleteElements();
+		m_SymbolTable.RemoveAll();
+	}
+
+
+
+private:
+	CUtlVector<T> m_Vector;
+	CUtlSymbolTable m_SymbolTable;
+};
+
+
+template< class T >
+class CUtlStringMapAutoPurge : public CUtlStringMap < T >
+{
+public:
+	~CUtlStringMapAutoPurge( void )
+	{
+		this->PurgeAndDeleteElements();
+	}
+
+};
+
+#endif // UTLSTRINGMAP_H