update rcheevos

RetroAchievements · Mar 2, 2024 · 6d63ace · 6d63ace
1 parent a1aa95f
commit 6d63ace
Show file tree

Hide file tree

Showing 9 changed files with 101 additions and 89 deletions.
diff --git a/rcheevos b/rcheevos
diff --git a/src/RA_Integration.vcxproj b/src/RA_Integration.vcxproj
@@ -443,7 +443,7 @@
   <ItemDefinitionGroup Condition="'$(Configuration)'=='Debug'">
     <ClCompile>
       <Optimization>Disabled</Optimization>
-      <PreprocessorDefinitions>_DEBUG;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>_DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <BasicRuntimeChecks>EnableFastChecks</BasicRuntimeChecks>
       <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
@@ -467,7 +467,7 @@
   <ItemDefinitionGroup Condition="'$(Configuration)'=='Analysis'">
     <ClCompile>
       <Optimization>Disabled</Optimization>
-      <PreprocessorDefinitions>NDEBUG;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <BasicRuntimeChecks>EnableFastChecks</BasicRuntimeChecks>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
@@ -497,7 +497,7 @@
       <Optimization>Full</Optimization>
       <IntrinsicFunctions>true</IntrinsicFunctions>
       <WholeProgramOptimization>true</WholeProgramOptimization>
-      <PreprocessorDefinitions>NDEBUG;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
@@ -516,7 +516,7 @@
       <Optimization>Full</Optimization>
       <IntrinsicFunctions>true</IntrinsicFunctions>
       <WholeProgramOptimization>true</WholeProgramOptimization>
-      <PreprocessorDefinitions>NDEBUG;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
@@ -535,7 +535,7 @@
       <Optimization>Full</Optimization>
       <IntrinsicFunctions>true</IntrinsicFunctions>
       <WholeProgramOptimization>true</WholeProgramOptimization>
-      <PreprocessorDefinitions>NDEBUG;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
@@ -555,7 +555,7 @@
       <IntrinsicFunctions>true</IntrinsicFunctions>
       <WholeProgramOptimization>true</WholeProgramOptimization>
       <AdditionalIncludeDirectories>..\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
-      <PreprocessorDefinitions>NDEBUG;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>

diff --git a/src/base.props b/src/base.props
@@ -33,7 +33,7 @@
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
       <ForcedIncludeFiles>pch.h</ForcedIncludeFiles>
-      <PreprocessorDefinitions>_ARCH=$(PlatformArchitecture);%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>_ARCH=$(PlatformArchitecture);RC_CLIENT_SUPPORTS_HASH;RA_EXPORTS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <ConformanceMode>true</ConformanceMode>
       <RuntimeTypeInfo>true</RuntimeTypeInfo>
     </ClCompile>

diff --git a/src/rcheevos.vcxproj b/src/rcheevos.vcxproj
@@ -65,7 +65,7 @@
       <Optimization>MaxSpeed</Optimization>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <IntrinsicFunctions>true</IntrinsicFunctions>
-      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;RC_CLIENT_SUPPORTS_HASH;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <CompileAs>CompileAsC</CompileAs>
       <AdditionalIncludeDirectories>$(SolutionDir)lua;$(SolutionDir)rcheevos\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <ExceptionHandling>false</ExceptionHandling>
@@ -89,7 +89,7 @@
       <Optimization>MaxSpeed</Optimization>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <IntrinsicFunctions>true</IntrinsicFunctions>
-      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;RC_CLIENT_SUPPORTS_HASH;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <CompileAs>CompileAsC</CompileAs>
       <AdditionalIncludeDirectories>$(SolutionDir)lua;$(SolutionDir)rcheevos\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <ExceptionHandling>false</ExceptionHandling>
@@ -112,7 +112,7 @@
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
     <ClCompile>
       <Optimization>Disabled</Optimization>
-      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;RC_CLIENT_SUPPORTS_HASH;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <CompileAs>CompileAsC</CompileAs>
       <AdditionalIncludeDirectories>$(SolutionDir)lua;$(SolutionDir)rcheevos\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <ExceptionHandling>false</ExceptionHandling>
@@ -130,7 +130,7 @@
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <ClCompile>
       <Optimization>Disabled</Optimization>
-      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>WIN32;RC_DISABLE_LUA;RC_CLIENT_SUPPORTS_HASH;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <CompileAs>CompileAsC</CompileAs>
       <AdditionalIncludeDirectories>$(SolutionDir)lua;$(SolutionDir)rcheevos\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <ExceptionHandling>false</ExceptionHandling>

diff --git a/src/services/AchievementRuntimeExports.cpp b/src/services/AchievementRuntimeExports.cpp
@@ -463,16 +463,16 @@ class AchievementRuntimeExports : private AchievementRuntime
         return rc_client_progress_size(pClient.GetClient());
     }
 
-    static int serialize_progress(uint8_t* buffer)
+    static int serialize_progress(uint8_t* buffer, size_t buffer_size)
     {
         const auto& pClient = ra::services::ServiceLocator::Get<ra::services::AchievementRuntime>();
-        return rc_client_serialize_progress(pClient.GetClient(), buffer);
+        return rc_client_serialize_progress_sized(pClient.GetClient(), buffer, buffer_size);
     }
 
-    static int deserialize_progress(const uint8_t* buffer)
+    static int deserialize_progress(const uint8_t* buffer, size_t buffer_size)
     {
         auto& pClient = ra::services::ServiceLocator::GetMutable<ra::services::AchievementRuntime>();
-        return rc_client_deserialize_progress(pClient.GetClient(), buffer);
+        return rc_client_deserialize_progress_sized(pClient.GetClient(), buffer, buffer_size);
     }
 
     static void set_raintegration_write_memory_function(rc_client_t* client, rc_client_raintegration_write_memory_func_t handler) noexcept

diff --git a/src/ui/viewmodels/MemorySearchViewModel.cpp b/src/ui/viewmodels/MemorySearchViewModel.cpp
@@ -748,8 +748,7 @@ void MemorySearchViewModel::UpdateResults()
     if (!pDesktop.IsOnUIThread())
     {
         m_bUpdateResultsPending = true;
-        pDesktop.InvokeOnUIThread([this]()
-        {
+        pDesktop.InvokeOnUIThread([this]() {
             if (m_bUpdateResultsPending)
             {
                 m_bUpdateResultsPending = false;
@@ -760,91 +759,102 @@ void MemorySearchViewModel::UpdateResults()
         return;
     }
 
-    std::lock_guard lock(m_oMutex);
+    // inlining this code was causing an analysis warning suggesting the lock was being released from
+    // the early returns above
+    DoUpdateResults();
+}
 
-    if (m_vSearchResults.size() < 2)
-        return;
+void MemorySearchViewModel::DoUpdateResults()
+{
+    // intentionally release the lock before calling EndUpdate to ensure callbacks aren't within the lock scope
+    {
+        std::lock_guard lock(m_oMutex);
 
-    const auto& pCurrentResults = *m_vSearchResults.at(m_nSelectedSearchResult).get();
-    ra::services::SearchResults::Result pResult;
-    const auto nIndex = gsl::narrow_cast<gsl::index>(GetScrollOffset());
+        if (m_vSearchResults.size() < 2)
+            return;
 
-    const auto& vmBookmarks = ra::services::ServiceLocator::Get<ra::ui::viewmodels::WindowManager>().MemoryBookmarks;
-    const auto& pGameContext = ra::services::ServiceLocator::Get<ra::data::context::GameContext>();
-    const auto& pConsoleContext = ra::services::ServiceLocator::Get<ra::data::context::ConsoleContext>();
-    const auto& pEmulatorContext = ra::services::ServiceLocator::Get<ra::data::context::EmulatorContext>();
-    const auto* pCodeNotes = pGameContext.Assets().FindCodeNotes();
+        const auto& pCurrentResults = *m_vSearchResults.at(m_nSelectedSearchResult).get();
+        ra::services::SearchResults::Result pResult;
+        const auto nIndex = gsl::narrow_cast<gsl::index>(GetScrollOffset());
 
-    m_vResults.RemoveNotifyTarget(*this);
-    m_vResults.BeginUpdate();
+        const auto& vmBookmarks = ra::services::ServiceLocator::Get<ra::ui::viewmodels::WindowManager>().MemoryBookmarks;
+        const auto& pGameContext = ra::services::ServiceLocator::Get<ra::data::context::GameContext>();
+        const auto& pConsoleContext = ra::services::ServiceLocator::Get<ra::data::context::ConsoleContext>();
+        const auto& pEmulatorContext = ra::services::ServiceLocator::Get<ra::data::context::EmulatorContext>();
+        const auto* pCodeNotes = pGameContext.Assets().FindCodeNotes();
 
-    unsigned int nRow = 0;
-    while (nRow < SEARCH_ROWS_DISPLAYED)
-    {
-        if (!pCurrentResults.pResults.GetMatchingAddress(nIndex + nRow, pResult))
-            break;
+        m_vResults.RemoveNotifyTarget(*this);
+        m_vResults.BeginUpdate();
 
-        auto* pRow = m_vResults.GetItemAt(nRow);
-        if (pRow == nullptr)
+        unsigned int nRow = 0;
+        while (nRow < SEARCH_ROWS_DISPLAYED)
         {
-            pRow = &m_vResults.Add();
-            Ensures(pRow != nullptr);
-        }
+            if (!pCurrentResults.pResults.GetMatchingAddress(nIndex + nRow, pResult))
+                break;
 
-        pRow->nAddress = pResult.nAddress;
+            auto* pRow = m_vResults.GetItemAt(nRow);
+            if (pRow == nullptr)
+            {
+                pRow = &m_vResults.Add();
+                Ensures(pRow != nullptr);
+            }
 
-        auto sAddress = ra::ByteAddressToString(pResult.nAddress);
-        switch (pResult.nSize)
-        {
-            case MemSize::Nibble_Lower:
-                sAddress.push_back('L');
-                pRow->nAddress <<= 1;
-                break;
+            pRow->nAddress = pResult.nAddress;
 
-            case MemSize::Nibble_Upper:
-                sAddress.push_back('U');
-                pRow->nAddress = (pRow->nAddress << 1) | 1;
-                break;
-        }
+            auto sAddress = ra::ByteAddressToString(pResult.nAddress);
+            switch (pResult.nSize)
+            {
+                case MemSize::Nibble_Lower:
+                    sAddress.push_back('L');
+                    pRow->nAddress <<= 1;
+                    break;
 
-        pRow->SetAddress(ra::Widen(sAddress));
+                case MemSize::Nibble_Upper:
+                    sAddress.push_back('U');
+                    pRow->nAddress = (pRow->nAddress << 1) | 1;
+                    break;
+            }
 
-        UpdateResult(*pRow, pCurrentResults.pResults, pResult, true, pEmulatorContext);
+            pRow->SetAddress(ra::Widen(sAddress));
 
-        const auto pCodeNote = (pCodeNotes != nullptr) ? pCodeNotes->FindCodeNote(pResult.nAddress, pResult.nSize) : std::wstring(L"");
-        if (!pCodeNote.empty())
-        {
-            pRow->bHasCodeNote = true;
-            pRow->SetDescription(pCodeNote);
-            pRow->SetDescriptionColor(ra::ui::Color(ra::to_unsigned(SearchResultViewModel::DescriptionColorProperty.GetDefaultValue())));
-        }
-        else
-        {
-            pRow->bHasCodeNote = false;
+            UpdateResult(*pRow, pCurrentResults.pResults, pResult, true, pEmulatorContext);
 
-            const auto* pRegion = pConsoleContext.GetMemoryRegion(pResult.nAddress);
-            if (pRegion)
+            const auto pCodeNote = (pCodeNotes != nullptr) ?
+                pCodeNotes->FindCodeNote(pResult.nAddress, pResult.nSize) : std::wstring(L"");
+            if (!pCodeNote.empty())
             {
-                pRow->SetDescription(ra::Widen(pRegion->Description));
-                pRow->SetDescriptionColor(ra::ui::Color(0xFFA0A0A0));
+                pRow->bHasCodeNote = true;
+                pRow->SetDescription(pCodeNote);
+                pRow->SetDescriptionColor(ra::ui::Color(ra::to_unsigned(SearchResultViewModel::DescriptionColorProperty.GetDefaultValue())));
             }
             else
             {
-                pRow->SetDescription(L"");
-                pRow->SetDescriptionColor(ra::ui::Color(ra::to_unsigned(SearchResultViewModel::DescriptionColorProperty.GetDefaultValue())));
+                pRow->bHasCodeNote = false;
+
+                const auto* pRegion = pConsoleContext.GetMemoryRegion(pResult.nAddress);
+                if (pRegion)
+                {
+                    pRow->SetDescription(ra::Widen(pRegion->Description));
+                    pRow->SetDescriptionColor(ra::ui::Color(0xFFA0A0A0));
+                }
+                else
+                {
+                    pRow->SetDescription(L"");
+                    pRow->SetDescriptionColor(ra::ui::Color(ra::to_unsigned(SearchResultViewModel::DescriptionColorProperty.GetDefaultValue())));
+                }
             }
-        }
 
-        pRow->SetSelected(m_vSelectedAddresses.find(pRow->nAddress) != m_vSelectedAddresses.end());
+            pRow->SetSelected(m_vSelectedAddresses.find(pRow->nAddress) != m_vSelectedAddresses.end());
 
-        pRow->bHasBookmark = vmBookmarks.HasBookmark(pResult.nAddress);
-        pRow->bHasBeenModified = (pCurrentResults.vModifiedAddresses.find(pRow->nAddress) != pCurrentResults.vModifiedAddresses.end());
-        pRow->UpdateRowColor();
-        ++nRow;
-    }
+            pRow->bHasBookmark = vmBookmarks.HasBookmark(pResult.nAddress);
+            pRow->bHasBeenModified = (pCurrentResults.vModifiedAddresses.find(pRow->nAddress) != pCurrentResults.vModifiedAddresses.end());
+            pRow->UpdateRowColor();
+            ++nRow;
+        }
 
-    while (m_vResults.Count() > nRow)
-        m_vResults.RemoveAt(m_vResults.Count() - 1);
+        while (m_vResults.Count() > nRow)
+            m_vResults.RemoveAt(m_vResults.Count() - 1);
+    }
 
     m_vResults.EndUpdate();
     m_vResults.AddNotifyTarget(*this);

diff --git a/src/ui/viewmodels/MemorySearchViewModel.hh b/src/ui/viewmodels/MemorySearchViewModel.hh
@@ -467,6 +467,7 @@ private:
     bool ParseFilterRange(_Out_ ra::ByteAddress& nStart, _Out_ ra::ByteAddress& nEnd);
     void ApplyContinuousFilter();
     void UpdateResults();
+    void DoUpdateResults();
     void UpdateResult(SearchResultViewModel& pRow, const ra::services::SearchResults& pResults,
         ra::services::SearchResults::Result& pResult, bool bForceFilterCheck,
         const ra::data::context::EmulatorContext& pEmulatorContext);
+19 −0		.github/workflows/c-cpp.yml
+6 −0		include/rc_api_editor.h
+3 −0		include/rc_api_info.h
+3 −0		include/rc_api_user.h
+24 −0		include/rc_client.h
+1 −1		include/rc_client_raintegration.h
+2 −1		include/rc_error.h
+7 −1		include/rc_runtime.h
+188 −67		src/rc_client.c
+3 −2		src/rc_client_external.h
+2 −0		src/rc_client_internal.h
+10 −4		src/rc_client_raintegration.c
+1 −0		src/rc_util.c
+107 −24		src/rcheevos/runtime_progress.c
+18 −10		test/Makefile
+5 −5		test/rcheevos-test.vcxproj
+3 −1		test/rcheevos-test.vcxproj.filters
+3 −0		test/rcheevos/test_format.c
+103 −0		test/rcheevos/test_runtime_progress.c
+4 −1		test/test.c
+376 −18		test/test_rc_client.c
+44 −2		test/test_rc_client_external.c