lots of todo notes

CHANGELOG.md

@@ -1,11 +1,11 @@
 * added new options to the overlay to allow copying a friend's ID, plus current player ID, suggested by **[Vlxst]**
 * added a new option to the overlay to invite all friends playing the same game, suggested by **[Vlxst]**
-* addded new `auto_accept_invite.txt` setting to automatically accept game/lobby invites from this list, each SteamID64 on a separate line  
+* added new `auto_accept_invite.txt` setting to automatically accept game/lobby invites from this list, each SteamID64 on a separate line  
   also you can leave the file empty to accept invitations from anyone, check the updated release readme, suggested by **[Vlxst]**
 * added new `disable_overlay_warning_*.txt` settings to disable certain or all warnings in the overlay, suggested by **[Vlxst]**
   * `disable_overlay_warning_forced_setting.txt`:  
     - disable the warning for the usage of any file `force_*.txt` in the overlay
-    - unlocks the settigs menu, this may result in an undesirable output
+    - unlocks the settings menu, this may result in an undesirable output
   * `disable_overlay_warning_bad_appid.txt`: disable the warning for bad app ID (when app ID = 0) in the overlay
   * `disable_overlay_warning_local_save.txt`: disable the warning for using local save in the overlay
   * `disable_overlay_warning_any.txt`: all the above

dll/dll.cpp

@@ -823,12 +823,12 @@ STEAMAPI_API uint32 SteamGameServer_GetIPCCallCount()
 
 STEAMAPI_API void S_CALLTYPE SteamAPI_UseBreakpadCrashHandler( char const *pchVersion, char const *pchDate, char const *pchTime, bool bFullMemoryDumps, void *pvContext, PFNPreMinidumpCallback m_pfnPreMinidumpCallback )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMAPI_API void S_CALLTYPE SteamAPI_SetBreakpadAppID( uint32 unAppID )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 struct cb_data {
@@ -1104,27 +1104,27 @@ STEAMCLIENT_API void *CreateInterface( const char *pName, int *pReturnCode )
 
 STEAMCLIENT_API void Breakpad_SteamMiniDumpInit( uint32 a, const char *b, const char *c )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Breakpad_SteamSetAppID( uint32 unAppID )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Breakpad_SteamSetSteamID( uint64 ulSteamID )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Breakpad_SteamWriteMiniDumpSetComment( const char *pchMsg )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Breakpad_SteamWriteMiniDumpUsingExceptionInfoWithBuildId( int a, int b )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API bool Steam_BConnected( HSteamUser hUser, HSteamPipe hSteamPipe )
@@ -1141,153 +1141,153 @@ STEAMCLIENT_API bool Steam_BLoggedOn( HSteamUser hUser, HSteamPipe hSteamPipe )
 
 STEAMCLIENT_API bool Steam_BReleaseSteamPipe( HSteamPipe hSteamPipe )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API HSteamUser Steam_ConnectToGlobalUser( HSteamPipe hSteamPipe )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return 0;
 }
 
 STEAMCLIENT_API HSteamUser Steam_CreateGlobalUser( HSteamPipe *phSteamPipe )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return 0;
 }
 
 STEAMCLIENT_API HSteamUser Steam_CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return 0;
 }
 
 STEAMCLIENT_API HSteamPipe Steam_CreateSteamPipe()
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return 0;
 }
 
 STEAMCLIENT_API bool Steam_GSBLoggedOn( void *phSteamHandle )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSBSecure( void *phSteamHandle)
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSGetSteam2GetEncryptionKeyToSendToNewClient( void *phSteamHandle, void *pvEncryptionKey, uint32 *pcbEncryptionKey, uint32 cbMaxEncryptionKey )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API uint64 Steam_GSGetSteamID()
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return 0;
 }
 
 STEAMCLIENT_API void Steam_GSLogOff( void *phSteamHandle )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Steam_GSLogOn( void *phSteamHandle )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API bool Steam_GSRemoveUserConnect( void *phSteamHandle, uint32 unUserID )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSSendSteam2UserConnect( void *phSteamHandle, uint32 unUserID, const void *pvRawKey, uint32 unKeyLen, uint32 unIPPublic, uint16 usPort, const void *pvCookie, uint32 cubCookie )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSSendSteam3UserConnect( void *phSteamHandle, uint64 steamID, uint32 unIPPublic, const void *pvCookie, uint32 cubCookie )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSSendUserDisconnect( void *phSteamHandle, uint64 ulSteamID, uint32 unUserID )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSSendUserStatusResponse( void *phSteamHandle, uint64 ulSteamID, int nSecondsConnected, int nSecondsSinceLast )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API bool Steam_GSSetServerType( void *phSteamHandle, int32 nAppIdServed, uint32 unServerFlags, uint32 unGameIP, uint32 unGamePort, const char *pchGameDir, const char *pchVersion )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API void Steam_GSSetSpawnCount( void *phSteamHandle, uint32 ucSpawn )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API bool Steam_GSUpdateStatus( void *phSteamHandle, int cPlayers, int cPlayersMax, int cBotPlayers, const char *pchServerName, const char *pchMapName )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return false;
 }
 
 STEAMCLIENT_API void* Steam_GetGSHandle( HSteamUser hUser, HSteamPipe hSteamPipe )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return NULL;
 }
 
 STEAMCLIENT_API int Steam_InitiateGameConnection( HSteamUser hUser, HSteamPipe hSteamPipe, void *pBlob, int cbMaxBlob, uint64 steamID, int nGameAppID, uint32 unIPServer, uint16 usPortServer, bool bSecure )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
     return 0;
 }
 
 STEAMCLIENT_API void Steam_LogOff( HSteamUser hUser, HSteamPipe hSteamPipe )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Steam_LogOn( HSteamUser hUser, HSteamPipe hSteamPipe, uint64 ulSteamID )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Steam_ReleaseThreadLocalMemory(bool thread_exit)
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Steam_ReleaseUser( HSteamPipe hSteamPipe, HSteamUser hUser )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Steam_SetLocalIPBinding( uint32 unIP, uint16 usLocalPort )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }
 
 STEAMCLIENT_API void Steam_TerminateGameConnection( HSteamUser hUser, HSteamPipe hSteamPipe, uint32 unIPServer, uint16 usPortServer )
 {
-    PRINT_DEBUG("%s\n", __FUNCTION__);
+    PRINT_DEBUG("TODO dll::%s\n", __FUNCTION__);
 }

dll/dll/steam_user_stats.h

@@ -600,7 +600,7 @@ bool StoreStats()
 // specified achievement.
 int GetAchievementIcon( const char *pchName )
 {
-    PRINT_DEBUG("Steam_User_Stats::GetAchievementIcon\n");
+    PRINT_DEBUG("TODO Steam_User_Stats::GetAchievementIcon\n");
     std::lock_guard<std::recursive_mutex> lock(global_mutex);
     if (pchName == nullptr) return 0;
 

dll/steam_applist.cpp

@@ -19,33 +19,33 @@
 
 uint32 Steam_Applist::GetNumInstalledApps()
 {
-    PRINT_DEBUG("Steam_Applist::GetNumInstalledApps\n");
+    PRINT_DEBUG("TODO Steam_Applist::GetNumInstalledApps\n");
     return 0;
 }
 
 uint32 Steam_Applist::GetInstalledApps( AppId_t *pvecAppID, uint32 unMaxAppIDs )
 {
-    PRINT_DEBUG("Steam_Applist::GetInstalledApps\n");
+    PRINT_DEBUG("TODO Steam_Applist::GetInstalledApps\n");
     return 0;
 }
 
 // returns -1 if no name was found
 int  Steam_Applist::GetAppName( AppId_t nAppID, STEAM_OUT_STRING() char *pchName, int cchNameMax )
 {
-    PRINT_DEBUG("Steam_Applist::GetAppName\n");
+    PRINT_DEBUG("TODO Steam_Applist::GetAppName\n");
     return -1;
 }
 
 // returns -1 if no dir was found
 int  Steam_Applist::GetAppInstallDir( AppId_t nAppID, char *pchDirectory, int cchNameMax )
 {
-    PRINT_DEBUG("Steam_Applist::GetAppInstallDir\n");
+    PRINT_DEBUG("TODO Steam_Applist::GetAppInstallDir\n");
     return -1;
 }
 
 // return the buildid of this app, may change at any time based on backend updates to the game
 int Steam_Applist::GetAppBuildId( AppId_t nAppID )
 {
-    PRINT_DEBUG("Steam_Applist::GetAppBuildId\n");
+    PRINT_DEBUG("TODO Steam_Applist::GetAppBuildId\n");
     return 10;
 }

dll/steam_apps.cpp

@@ -30,7 +30,7 @@ Steam_Apps::Steam_Apps(Settings *settings, class SteamCallResults *callback_resu
 int Steam_Apps::GetAppData( AppId_t nAppID, const char *pchKey, char *pchValue, int cchValueMax )
 {
     //TODO
-    PRINT_DEBUG("Steam_Apps::GetAppData %u %s\n", nAppID, pchKey);
+    PRINT_DEBUG("TODO Steam_Apps::GetAppData %u %s\n", nAppID, pchKey);
     return 0;
 }
 
@@ -207,7 +207,7 @@ static void FillProofOfPurchaseKey( AppProofOfPurchaseKeyResponse_t& data, AppId
 // the key is available (which may be immediately).
 void Steam_Apps::RequestAppProofOfPurchaseKey( AppId_t nAppID )
 {
-    PRINT_DEBUG("Steam_Apps::TODO RequestAppProofOfPurchaseKey\n");
+    PRINT_DEBUG("TODO Steam_Apps::RequestAppProofOfPurchaseKey\n");
     std::lock_guard<std::recursive_mutex> lock(global_mutex);
 
     AppProofOfPurchaseKeyResponse_t data{};
@@ -243,7 +243,7 @@ bool Steam_Apps::GetCurrentBetaName( char *pchName, int cchNameBufferSize )
 // signal Steam that game files seems corrupt or missing
 bool Steam_Apps::MarkContentCorrupt( bool bMissingFilesOnly )
 {
-    PRINT_DEBUG("Steam_Apps::MarkContentCorrupt\n");
+    PRINT_DEBUG("TODO Steam_Apps::MarkContentCorrupt\n");
     std::lock_guard<std::recursive_mutex> lock(global_mutex);
     //TODO: warn user
     return true;
@@ -308,12 +308,12 @@ bool Steam_Apps::BIsAppInstalled( AppId_t appID )
     // "0 Base Goldsource Shared Binaries"
     // https://developer.valvesoftware.com/wiki/Steam_Application_IDs
     if (appID == 0) return true;
-    // game LEGO® 2K Drive (app id 1451810) checks for a proper steam behavior by sending uint32_max and expects false in return
+    // game LEGO 2K Drive (app id 1451810) checks for a proper steam behavior by sending uint32_max and expects false in return
     if (appID == UINT32_MAX) return false;
     if (appID == settings->get_local_game_id().AppID()) return true;
 
     // only check for DLC if the the list is limited/bounded,
-    // calling hasDLC() wehn unlockAllDLCs is true will always satisfy the below condition
+    // calling hasDLC() when unlockAllDLCs is true will always satisfy the below condition
     if (!settings->allDLCUnlocked() && settings->hasDLC(appID)) {
         return false;
     }
@@ -335,7 +335,7 @@ CSteamID Steam_Apps::GetAppOwner()
 // but it is advised that you not param names beginning with an underscore for your own features.
 const char *Steam_Apps::GetLaunchQueryParam( const char *pchKey )
 {
-    PRINT_DEBUG("Steam_Apps::GetLaunchQueryParam\n");
+    PRINT_DEBUG("TODO Steam_Apps::GetLaunchQueryParam\n");
     return "";
 }
 
@@ -364,7 +364,7 @@ int Steam_Apps::GetAppBuildId()
 // member is k_uAppIdInvalid (zero).
 void Steam_Apps::RequestAllProofOfPurchaseKeys()
 {
-    PRINT_DEBUG("Steam_Apps::TODO RequestAllProofOfPurchaseKeys\n");
+    PRINT_DEBUG("TODO Steam_Apps::RequestAllProofOfPurchaseKeys\n");
     std::lock_guard<std::recursive_mutex> lock(global_mutex);
     // current app
     {
@@ -428,7 +428,7 @@ SteamAPICall_t Steam_Apps::GetFileDetails( const char* pszFileName )
 // If game was already running and launched again, the NewUrlLaunchParameters_t will be fired.
 int Steam_Apps::GetLaunchCommandLine( char *pszCommandLine, int cubCommandLine )
 {
-    PRINT_DEBUG("Steam_Apps::TODO GetLaunchCommandLine\n");
+    PRINT_DEBUG("TODO Steam_Apps::GetLaunchCommandLine\n");
     return 0;
 }