R5Reloaded/r5sdk
1
0
Fork 0
mirror of https://github.com/Mauler125/r5sdk.git synced 2025-02-09 19:15:03 +01:00
Code Issues Packages Projects Releases Wiki Activity
r5sdk/r5dev/public/utility/utility.h

85 lines
3.6 KiB
C
Raw Normal View History

Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
#pragma once
/////////////////////////////////////////////////////////////////////////////
// Internals
Add client and debug utilities + cleanup
2022-01-04 11:53:54 +01:00
BOOL IsBadReadPtrV2(void* ptr);
FileExist cleanup Use fs::path constructor for all strings. Renamed CPakFile::AsyncLoad to CPakFile::LoadAsync. Renamed CPakFile::Load to CPakFile::LoadPak.
2022-06-12 12:40:26 +02:00
BOOL FileExists(const fs::path& svFilePath);
Add utility for checking if a file is empty or not
2022-09-10 00:06:26 +02:00
BOOL FileEmpty(ifstream& pFile);
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
MODULEINFO GetModuleInfo(const char* szModule);
/////////////////////////////////////////////////////////////////////////////
Add file extension support to .vpkignore
2022-06-07 13:44:31 +02:00
// Debug
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
void DbgPrint(LPCSTR sFormat, ...);
Move 'PrintLastError()' to utility.cpp
2022-01-19 23:14:50 +01:00
void PrintLastError(void);
Small improvements
2022-04-24 19:32:47 +02:00
void HexDump(const char* szHeader, const char* szLogger, const void* pData, int nSize);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
Implement convar_list and convar_differences Also added more CCvarUtilities methods which are yet to be implemented.
2022-08-13 12:39:57 +02:00
/////////////////////////////////////////////////////////////////////////////
// Char
char* StripTabsAndReturns(const char* pInBuffer, char* pOutBuffer, int nOutBufferSize);
char* StripQuotes(const char* pInBuffer, char* pOutBuffer, int nOutBufferSize);
Add file extension support to .vpkignore
2022-06-07 13:44:31 +02:00
/////////////////////////////////////////////////////////////////////////////
// String
Add case insensitive search for developer console input field This has been requested by a user. This change will allow for searching convars from partial input regardless of the case.
2022-11-13 23:44:30 +01:00
bool HasPartial(const string& svInput, const string& svPartial);
Add file extension support to .vpkignore
2022-06-07 13:44:31 +02:00
bool HasExtension(const string& svInput, const string& svExtension);
string GetExtension(const string& svInput, bool bReturnOriginal = false, bool bKeepDelimiter = false);
Add additional useful string utils
2022-05-30 01:50:21 +02:00
string RemoveExtension(const string& svInput);
Add file extension support to .vpkignore
2022-06-07 13:44:31 +02:00
bool HasFileName(const string& svInput, const string& svFileName);
utility.cpp light cleanup * Use ternary operator for simple tests. * Default 'GetFileName's 'bRemoveExtension' parameter to false.
2022-11-23 16:54:10 +01:00
string GetFileName(const string& svInput, bool bRemoveExtension = false, bool bWindows = false);
Fix string utility bugs GetFileName returned null string if file is not within a path, now returns the input file name. RemoveFileName returned file name if file is not within a path, now returns null string. Added StringReplaceC (string replace with copy instead of modifying the reference object).
2022-06-02 01:55:41 +02:00
string RemoveFileName(const string& svInput, bool bWindows = false);
Add additional useful string utils
2022-05-30 01:50:21 +02:00
Proper VPK repacking Initial proper implementation pending cleanup. The new system builds a manifest file when a VPK is unpacked. The manifest files contains data such as the entry flags and texture flags. It also contains a field determining whether the file should be compressed or not. When a user repacks a pack, the system attempts to load this manifest file and does a lookup to the object to retrieve the flags (most of these flags are unknown, but they are used by the engine and are necessary for stuff like cubemaps and texture files to work correctly. Cubemaps won't work with proper flags, and textures (decals, particle system components, etc..) will look washed out without them. I think some also determine whether a file within the VPK should be cached or not, so simply marking everything as 0x101 will probably end up in more CPU time and higher filesystem cache usage (depot/ is only 0x1, I don't think anything there is getting cached ever without the 0x100 flag). User could also repack a VPK while excluding anything that is not in the manifest file. So you could unpack all VPK's into a single directory (each VPK has its own manifest file tied to its level name), and rebuild all the VPK's with only the files that where originally in them. fs_pack_vpk command usage: <locale> <context> <level_name> <manifest_only> locale determines the pak language (default english), context determines whether is a server/client vpk, level_name determines the BSP name of the pak, manifest_only determines whether the pack system should only include files within the manifest (leaving this arg out will build all files into the vpk). The VPK workspace path is determined with ConVar 'fs_packedstore_workspace'.
2022-06-04 01:08:23 +02:00
string CreateDirectories(string svInput, bool bWindows = false);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
string ConvertToWinPath(const string& svInput);
Start or 'mdl/error.rmdl' fallback implementation (see description) In 'datacache/mdlcache.cpp' the function 'CMDLCache::FindMDL' attempts to find 'mdl/error.rmdl' and assigns the studiohdr and handle to the members of CMDLFallback. In 'CMDLCache::FindUncachedMDL' we check if a model exists, if a model does not exist, we replace the studiohdr with the one of error.rmdl we stored in the CMDLFallback structure. This does actually work (on the dedicated server it doesn't crash at all!), but on the client it crashes when trying to gather props (right before rendering), setting the ConVar* 'old_gather_props' does interesting things (check IDA around this ConVar*). setting this to 1 causes it to crash in another CMDLCache method when trying to deref something in the global cache pool. This method is easy to rebuild. I will do this soon and attempt to return error.rmdl parts from here as well if results are null (this might actually just work). Leaving 'old_gather_props' to 0 causes it to crash in the middle of the function which is supposed to gather the props the 'new' way. The gather props functions are kind of daunting NOTE: Currently only confirmed to work somewhat properly on the dedicated server for prop_static. prop_dynamic is unconfirmed. And (almost?) works on the client.
2022-04-29 05:30:06 +02:00
string ConvertToUnixPath(const string& svInput);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
Proper NET_SetKey sanity checks * Checks if input encoded key is 24 characters long. * Checks if the input data is a valid base64.
2022-08-30 20:04:59 +02:00
bool IsValidBase64(string& svInput);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
string Base64Encode(const string& svInput);
string Base64Decode(const string& svInput);
Add additional useful string utils
2022-05-30 01:50:21 +02:00
string UTF8Encode(const wstring& wsvInput);
Temp fix so I can compile (UTF8Decode)
2022-06-02 16:30:35 +02:00
string UTF8Decode(const string& svInput);
Add 'UTF8CharLength(..)' to utility.cpp
2022-06-24 12:12:30 +02:00
size_t UTF8CharLength(const uint8_t cInput);
Server authentication code improvements * Added validity checks for player names, they must be UTF-8 encoded, else game clients will crash attempting to set non-UTF-8 player names in RUI. * CServer::RejectConnection now takes a 'v_netadr_t*', previously it was 'user_creds_s*', which worked as 'v_netadr_t' is the first member in 'user_creds_s'. * Programmer must now manually pass a character buffer to 'v_net_adr::GetAddress(...)'.
2022-11-03 02:30:57 +01:00
bool IsValidUTF8(char* pszString);
Add additional useful string utils
2022-05-30 01:50:21 +02:00
See description * Finished designer code for launcher gui. * Basic implementation of setting flags for host launch option. * Check in 'CHostState::LoadConfig' if -launcher is below 1.. if condition is met the cfg's will be executed from 'CHostState::LoadConfig'. * Added 'StringIsDigit' utility.
2022-05-24 02:23:37 +02:00
bool StringIsDigit(const string& svInput);
More detailed system stats Fixed physical core count always returning logical core count (this engine does not run on the AMD Phenom processor).
2022-04-18 16:45:26 +02:00
bool CompareStringAlphabetically(const string& svA, const string& svB);
bool CompareStringLexicographically(const string& svA, const string& svB);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
bool StringReplace(string& svInput, const string& svFrom, const string& svTo);
Fix string utility bugs GetFileName returned null string if file is not within a path, now returns the input file name. RemoveFileName returned file name if file is not within a path, now returns null string. Added StringReplaceC (string replace with copy instead of modifying the reference object).
2022-06-02 01:55:41 +02:00
string StringReplaceC(const string& svInput, const string& svFrom, const string& svTo);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
string StringEscape(const string& svInput);
string StringUnescape(const string& svInput);
Implement StrintCount utility Counts the number or delimiters found in a given string
2022-09-22 17:08:20 +02:00
size_t StringCount(const string& svInput, char cDelim);
Netconsole and ConVar improvements Implemented StringSplit() (split string with a delimiter, and stop splitting after either the last delimiter has been reached, or nMax, so when nMax is 2, then 'SET mat_sky_color 255 255 0 255' gets split into: "SET" "mat_sky_color" "255 255 0 255"). Netconsole now sends ConVar's/ConCommands and values separately with use of StringSplit. ConVar now uses internal ChangeStringValue (this runs the callback).
2022-07-31 17:07:35 +02:00
vector<string> StringSplit(string svInput, char cDelim, size_t nMax = SIZE_MAX);
Display '%' symbol properly in console
2022-05-10 23:32:44 +02:00
Improve string trimming logic Add option to trim anything before/after the criteria.
2022-11-11 01:17:11 +01:00
string& StringLTrim(string& svInput, const char* pszToTrim, bool bTrimBefore = false);
string& StringRTrim(string& svInput, const char* pszToTrim, bool bTrimAfter = false);
string& StringTrim(string& svInput, const char* pszToTrim, bool bTrimAll = false);
ImGui and DirectX code improvements * Fix history duplication by removing trailing white space characters from submitted commands in console. * Fix out of range exception caused by caching svConVar.size() in CConsole::BuildSummary while we are modifying it. * Fixed memory leak caused by extraneous Strdup calls in CConsole. * Renamed variables and structure members, static vars in id3dx.cpp are not prefixed with s_, IBrowser_Config is now m_BrowserConfig. * Performed code cleanup in id3dx.cpp.
2022-10-20 12:29:21 +02:00
Add pak_listtypes command
2022-12-22 21:44:38 +00:00
string FourCCToString(int n);
Small ImGui theme adjustments
2022-06-27 14:48:03 +02:00
/////////////////////////////////////////////////////////////////////////////
// Bytes
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
vector<int> StringToBytes(const string& svInput, bool bNullTerminator);
Implemented CModule::GetVirtualMethodTable. * Added CModule::GetVirtualMethodTable. Gets you a pointer to a VTable by its rtti type descriptor name. * Added StringToMaskedBytes. Turns a string into masked bytes. * CModule::FindPatternSIMD now allows you to custom define a section it should search in.
2022-07-20 18:03:35 +02:00
pair<vector<uint8_t>, string> StringToMaskedBytes(const string& svInput, bool bNullTerminator);
Address class cleanup/improvements * Move most definitions to implementation file to avoid recompiling whole program for small changes * Pass strings by reference for where possible. * Split Module class to dedicated file. * Add const qualifiers to all eligible methods for address/module class * Some renaming
2022-04-10 19:59:34 +02:00
vector<int> PatternToBytes(const string& svInput);
Rename PatternToBytesAndMask to PatternToMaskedBytes
2022-06-26 17:45:54 +02:00
pair<vector<uint8_t>, string> PatternToMaskedBytes(const string& svInput);
Add additional useful string utils
2022-05-30 01:50:21 +02:00
vector<int> IntToDigits(int iValue);
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
Add file extension support to .vpkignore
2022-06-07 13:44:31 +02:00
/////////////////////////////////////////////////////////////////////////////
// Print
Add print functions for printing '__m128i' datatypes
2022-05-10 23:36:01 +02:00
void PrintM128i8(__m128i in);
void PrintM128i16(__m128i in);
void PrintM128i32(__m128i in);
void PrintM128i64(__m128i in);
Implement convar_list and convar_differences Also added more CCvarUtilities methods which are yet to be implemented.
2022-08-13 12:39:57 +02:00
void AppendPrintf(char* pBuffer, size_t nBufSize, char const* pFormat, ...);
Display '%' symbol properly in console
2022-05-10 23:32:44 +02:00
string PrintPercentageEscape(const string& svInput);
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
/////////////////////////////////////////////////////////////////////////////
Improve timer logic Accurate interval to duration conversion.
2022-08-31 02:15:54 +02:00
// Time
std::chrono::nanoseconds IntervalToDuration(const float flInterval);
/////////////////////////////////////////////////////////////////////////////
Reference in New Issue Copy Permalink