pull ScopeExit into its own file

Author: jw098

Common/Cpp/ScopeExit.h

@@ -0,0 +1,31 @@
+/*  ScopeExit
+ *
+ *  From: https://github.com/PokemonAutomation/Arduino-Source
+ *
+ */
+
+#ifndef PokemonAutomation_ScopeExit_h
+#define PokemonAutomation_ScopeExit_h
+
+#include <functional>
+
+namespace PokemonAutomation{
+class ScopeExit{
+    ScopeExit(const ScopeExit&) = delete;
+    void operator=(const ScopeExit&) = delete;
+
+public:
+    template <typename Lambda>
+    ScopeExit(Lambda&& lambda)
+        : m_lambda(std::move(lambda))
+    {}
+    ~ScopeExit(){
+        m_lambda();
+    }
+
+private:
+    std::function<void()> m_lambda;
+};
+
+}
+#endif

SerialPrograms/Source/CommonFramework/Main.cpp

@@ -11,6 +11,7 @@
 #include "Common/Cpp/Concurrency/PeriodicRunner.h"
 #include "Common/Cpp/Exceptions.h"
 #include "Common/Cpp/ImageResolution.h"
+#include "Common/Cpp/ScopeExit.h"
 #include "Common/Qt/GlobalThreadPoolsQt.h"
 #include "StaticRegistration.h"
 #include "CommonFramework/Tools/GlobalThreadPools.h"
@@ -60,23 +61,6 @@ void set_working_directory(){
 }
 
 
-class ScopeExit{
-    ScopeExit(const ScopeExit&) = delete;
-    void operator=(const ScopeExit&) = delete;
-
-public:
-    template <typename Lambda>
-    ScopeExit(Lambda&& lambda)
-        : m_lambda(std::move(lambda))
-    {}
-    ~ScopeExit(){
-        m_lambda();
-    }
-
-private:
-    std::function<void()> m_lambda;
-};
-
 
 int run_program(int argc, char *argv[]){
 #if defined(__APPLE__)

SerialPrograms/Source/CommonFramework/ResourceDownload/DownloadThread.cpp

@@ -8,6 +8,7 @@
 #include "CommonFramework/Globals.h"
 #include "CommonFramework/Exceptions/OperationFailedException.h"
 #include "Common/Cpp/Filesystem.h"
+#include "Common/Cpp/ScopeExit.h"
 #include "CommonFramework/Tools/FileDownloader.h"
 #include "CommonFramework/Tools/FileUnzip.h"
 #include "CommonFramework/Tools/FileHash.h"
@@ -51,14 +52,9 @@ void DownloadThread::start_download_thread(){
         }
 
         // runs when lambda is finished
-        // updates action state, removes self from download queue
-        struct ScopeGuard {
-            DownloadThread* thread_ptr;
-            bool& success_ref;
-            ~ScopeGuard() {
-                thread_ptr->m_hooks.on_finished(success_ref);
-            }
-        } guard{this, success};
+        ScopeExit on_exit([&, this]{
+            m_hooks.on_finished(success);
+        });
 
         try {
             // std::this_thread::sleep_for(std::chrono::seconds(7));
@@ -78,10 +74,10 @@ void DownloadThread::start_download_thread(){
         }catch (const std::exception& e) {
             std::cout << "Standard exception: " << e.what() << std::endl;
             success = false;
-            m_hooks.report_exception_caught("ResourceDownloadButton::start_download");
+            m_hooks.report_exception_caught("DownloadThread::start_download_thread");
         } catch(...){
             success = false;
-            m_hooks.report_exception_caught("ResourceDownloadButton::start_download");
+            m_hooks.report_exception_caught("DownloadThread::start_download_thread");
         }
 
     }

SerialPrograms/Source/CommonFramework/Tools/FileUnzip.cpp

@@ -16,6 +16,7 @@
 #include "miniz-3.1.1/miniz.h"
 #include "Common/Cpp/Filesystem.h"
 #include "Common/Cpp/Exceptions.h"
+#include "Common/Cpp/ScopeExit.h"
 #include "FileUnzip.h"
 #include <filesystem>
 #include <fstream>
@@ -130,10 +131,9 @@ void unzip_file(
     } 
 
     // This automatically calls mz_zip_reader_end when this function exits for any reason.
-    struct ZipCleanup {
-        mz_zip_archive* p;
-        ~ZipCleanup() { mz_zip_reader_end(p); }
-    } cleanup{&zip_archive};
+    ScopeExit on_exit([&]{
+        mz_zip_reader_end(&zip_archive);
+    });
 
     // Get total number of files in the archive
     int num_files = (int)mz_zip_reader_get_num_files(&zip_archive);

SerialPrograms/cmake/SourceFiles.cmake

@@ -187,6 +187,7 @@ file(GLOB LIBRARY_SOURCES
     ../Common/Cpp/Rectangle.h
     ../Common/Cpp/Rectangle.tpp
     ../Common/Cpp/RecursiveThrottler.h
+    ../Common/Cpp/ScopeExit.h
     ../Common/Cpp/SIMDDebuggers.h
     ../Common/Cpp/SerialConnection/SerialConnection.cpp
     ../Common/Cpp/SerialConnection/SerialConnection.h