KeyValues class rebuild (see description)

Class has been mostly copied from the Valve SourceSDK.
Modified to fit this particular engine.

Modifications include:
* More consistent naming.
* Using c++ style casts over c style casts.
* Using c++ datatypes for assigning default.
  - nullptr and size_t for pointers and size types.

r5dev/engine/host_state.cpp

@@ -194,7 +194,7 @@ FORCEINLINE void CHostState::Setup(void)
 		NET_GenerateKey();
 	}
 	ResetLevelName();
-	KeyValues::Init();
+	KeyValues::Setup();
 }
 
 //-----------------------------------------------------------------------------

r5dev/vpc/keyvalues.h

@@ -1,9 +1,12 @@
 #pragma once
 #include "filesystem/filesystem.h"
+#include "mathlib/color.h"
 
 #define MAKE_3_BYTES_FROM_1_AND_2( x1, x2 ) (( (( uint16_t )x2) << 8 ) | (uint8_t)(x1))
+#define SPLIT_3_BYTES_INTO_1_AND_2( x1, x2, x3 ) do { x1 = (uint8)(x3); x2 = (uint16)( (x3) >> 8 ); } while( 0 )
+
 extern vector<string> g_vAllPlaylists;
-extern vector<string> g_vAllSearchPaths;
+extern vector<string> g_vGameInfoPaths;
 
 //---------------------------------------------------------------------------------
 // Purpose: Forward declarations
@@ -26,7 +29,7 @@ inline auto KeyValues_GetCurrentPlaylist = p_KeyValues_GetCurrentPlaylist.RCast<
 inline CMemory p_KeyValues_ReadKeyValuesFile;
 inline auto KeyValues_ReadKeyValuesFile = p_KeyValues_ReadKeyValuesFile.RCast<KeyValues* (*)(CFileSystem_Stdio* pFileSystem, const char* pFileName)>();
 
-enum KeyValuesTypes
+enum KeyValuesTypes_t : char
 {
 	TYPE_NONE              = 0x0,
 	TYPE_STRING            = 0x1,
@@ -41,36 +44,120 @@ enum KeyValuesTypes
 	TYPE_COMPILED_INT_1    = 0xA,
 	TYPE_NUMTYPES          = 0xB,
 };
+enum MergeKeyValuesOp_t
+{
+	MERGE_KV_ALL,
+	MERGE_KV_UPDATE,	// update values are copied into storage, adding new keys to storage or updating existing ones
+	MERGE_KV_DELETE,	// update values specify keys that get deleted from storage
+	MERGE_KV_BORROW,	// update values only update existing keys in storage, keys in update that do not exist in storage are discarded
+};
 
+
+//-----------------------------------------------------------------------------
+// Purpose: Simple recursive data access class
+//			Used in vgui for message parameters and resource files
+//			Destructor deletes all child KeyValues nodes
+//			Data is stored in key (string names) - (string/int/float)value pairs called nodes.
+//
+//	About KeyValues Text File Format:
+
+//	It has 3 control characters '{', '}' and '"'. Names and values may be quoted or
+//	not. The quote '"' character must not be used within name or values, only for
+//	quoting whole tokens. You may use escape sequences wile parsing and add within a
+//	quoted token a \" to add quotes within your name or token. When using Escape
+//	Sequence the parser must now that by setting KeyValues::UsesEscapeSequences( true ),
+//	which it's off by default. Non-quoted tokens ends with a whitespace, '{', '}' and '"'.
+//	So you may use '{' and '}' within quoted tokens, but not for non-quoted tokens.
+//  An open bracket '{' after a key name indicates a list of subkeys which is finished
+//  with a closing bracket '}'. Subkeys use the same definitions recursively.
+//  Whitespaces are space, return, newline and tabulator. Allowed Escape sequences
+//	are \n, \t, \\, \n and \". The number character '#' is used for macro purposes 
+//	(eg #include), don't use it as first character in key names.
+//-----------------------------------------------------------------------------
 class KeyValues
 {
 public:
-	static void Init(void);
-	KeyValues* FindKey(const char* pKeyName, bool bCreate);
-	const char* GetName(void) const;
-	int GetInt(const char* pKeyName, int nDefaultValue);
-	void SetInt(const char* pKeyName, int iValue);
-	void SetFloat(const char* keyName, float flValue);
+	// Constructors/destructors
+	KeyValues(const char* pszSetName);
+	KeyValues(const char* pszSetName, const char* pszFirstKey, const char* pszFirstValue);
+	KeyValues(const char* pszSetName, const char* pszFirstKey, const wchar_t* pwszFirstValue);
+	KeyValues(const char* pszSetName, const char* pszFirstKey, int iFirstValue);
+	KeyValues(const char* pszSetName, const char* pszFirstKey, const char* pszFirstValue, const char* pszSecondKey, const char* pszSecondValue);
+	KeyValues(const char* pszSetName, const char* pszFirstKey, int iFirstValue, const char* pszSecondKey, int iSecondValue);
+	~KeyValues(void);
 
+	void Init(void);
+	void Clear(void);
+	void DeleteThis(void);
+	void RemoveEverything();
+
+	KeyValues* FindKey(const char* pKeyName, bool bCreate = false);
+	KeyValues* FindLastSubKey(void) const;
+
+	void AddSubKey(KeyValues* pSubkey);
+	void RemoveSubKey(KeyValues* pSubKey);
+	void InsertSubKey(int nIndex, KeyValues* pSubKey);
+	bool ContainsSubKey(KeyValues* pSubKey);
+	void SwapSubKey(KeyValues* pExistingSubkey, KeyValues* pNewSubKey);
+	void ElideSubKey(KeyValues* pSubKey);
+
+	// Data access
+	bool IsEmpty(const char* pszKeyName);
+	KeyValues* GetFirstTrueSubKey(void) const;
+	KeyValues* GetNextTrueSubKey(void) const;
+	KeyValues* GetFirstValue(void) const;
+	KeyValues* GetNextValue(void) const;
+	KeyValues* GetFirstSubKey() const;
+	KeyValues* GetNextKey() const;
+	const char* GetName(void) const;
+	int GetInt(const char* pszKeyName, int iDefaultValue);
+	uint64_t GetUint64(const char* pszKeyName, uint64_t nDefaultValue);
+	void* GetPtr(const char* pszKeyName, void* pDefaultValue);
+	float GetFloat(const char* pszKeyName, float flDefaultValue);
+	const char* GetString(const char* pszKeyName = nullptr, const char* pszDefaultValue = "");
+	const wchar_t* GetWString(const char* pszKeyName = nullptr, const wchar_t* pwszDefaultValue = L"");
+	Color GetColor(const char* pszKeyName, const Color& defaultColor);
+	KeyValuesTypes_t GetDataType(const char* pszKeyName);
+	KeyValuesTypes_t GetDataType(void) const;
+
+	// Key writing
+	void SetInt(const char* pszKeyName, int iValue);
+	void SetUint64(const char* pszKeyName, uint64_t nValue);
+	void SetPtr(const char* pszKeyName, void* pValue);
+	void SetNextKey(KeyValues* pDat);
+	void SetName(const char* pszName);
+	void SetString(const char* pszKeyName, const char* pszValue);
+	void SetWString(const char* pszKeyName, const wchar_t* pwszValue);
+	void SetStringValue(char const* pszValue);
+	void SetColor(const char* pszKeyName, Color color);
+	void SetFloat(const char* pszKeyName, float flValue);
+
+	void RecursiveCopyKeyValues(KeyValues& src);
+	void CopySubkeys(KeyValues* pParent) const;
+	KeyValues* MakeCopy(void) const;
+
+	// Initialization
+	static void Setup(void);
 	static void InitPlaylists(void);
 	static void InitFileSystem(void);
 	static bool LoadPlaylist(const char* szPlaylist);
 	static KeyValues* ReadKeyValuesFile(CFileSystem_Stdio* pFileSystem, const char* pFileName);
 
 public:
-	uint32_t m_iKeyName              : 24;         // 0x0000
-	uint32_t m_iKeyNameCaseSensitive : 8;          // 0x0003
+	uint32_t m_iKeyName               : 24;        // 0x0000
+	uint32_t m_iKeyNameCaseSensitive1 : 8;         // 0x0003
 	char*            m_sValue;                     // 0x0008
 	wchar_t*         m_wsValue;                    // 0x0010
 	union                                          // 0x0018
 	{
-		int m_iValue;
-		float m_flValue;
-		void* m_pValue;
+		int           m_iValue;
+		float         m_flValue;
+		void*         m_pValue;
 		unsigned char m_Color[4];
 	};
 	char             m_szShortName[8];             // 0x0020
 	char             m_iDataType;                  // 0x0028
+	char             m_bHasEscapeSequences;        // 0x0029
 	uint16_t         m_iKeyNameCaseSensitive2;     // 0x002A
 	KeyValues*       m_pPeer;                      // 0x0030
 	KeyValues*       m_pSub;                       // 0x0038

r5dev/vpc/kvleaktrace.h

@@ -1,6 +1,6 @@
 #ifndef KVLEAKTRACE_H
 #define KVLEAKTRACE_H
-#include "tier1/utlvector.h"
+//#include "tier1/utlvector.h"
 
 #ifdef LEAKTRACK
 class CLeakTrack