moved on thread executor to common

PowerToys.sln

@@ -278,6 +278,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "utils", "utils", "{B39DC643
 		src\common\utils\modulesRegistry.h = src\common\utils\modulesRegistry.h
 		src\common\utils\MsiUtils.h = src\common\utils\MsiUtils.h
 		src\common\utils\MsWindowsSettings.h = src\common\utils\MsWindowsSettings.h
+		src\common\utils\OnThreadExecutor.h = src\common\utils\OnThreadExecutor.h
 		src\common\utils\os-detect.h = src\common\utils\os-detect.h
 		src\common\utils\package.h = src\common\utils\package.h
 		src\common\utils\ProcessWaiter.h = src\common\utils\ProcessWaiter.h

src/common/utils/OnThreadExecutor.h

@@ -0,0 +1,72 @@
+#pragma once
+
+#include <future>
+#include <thread>
+#include <functional>
+#include <queue>
+#include <atomic>
+
+// OnThreadExecutor allows its caller to off-load some work to a persistently running background thread.
+// This might come in handy if you use the API which sets thread-wide global state and the state needs
+// to be isolated.
+
+class OnThreadExecutor final
+{
+public:
+    using task_t = std::packaged_task<void()>;
+
+    OnThreadExecutor() :
+        _shutdown_request{ false },
+        _worker_thread{ [this] { worker_thread(); } }
+    {
+    }
+
+    ~OnThreadExecutor()
+    {
+        _shutdown_request = true;
+        _task_cv.notify_one();
+        _worker_thread.join();
+    }
+
+    std::future<void> submit(task_t task)
+    {
+        auto future = task.get_future();
+        std::lock_guard lock{ _task_mutex };
+        _task_queue.emplace(std::move(task));
+        _task_cv.notify_one();
+        return future;
+    }
+
+    void cancel()
+    {
+        std::lock_guard lock{ _task_mutex };
+        _task_queue = {};
+        _task_cv.notify_one();
+    }
+
+private:
+    void worker_thread()
+    {
+        while (!_shutdown_request)
+        {
+            task_t task;
+            {
+                std::unique_lock task_lock{ _task_mutex };
+                _task_cv.wait(task_lock, [this] { return !_task_queue.empty() || _shutdown_request; });
+                if (_shutdown_request)
+                {
+                    return;
+                }
+                task = std::move(_task_queue.front());
+                _task_queue.pop();
+            }
+            task();
+        }
+    }
+
+    std::mutex _task_mutex;
+    std::condition_variable _task_cv;
+    std::atomic_bool _shutdown_request;
+    std::queue<std::packaged_task<void()>> _task_queue;
+    std::thread _worker_thread;
+};

src/modules/Projects/ProjectsSnapshotTool/OnThreadExecutor.cpp

@@ -1,51 +0,0 @@
-#include "pch.h"
-
-#include "OnThreadExecutor.h"
-
-OnThreadExecutor::OnThreadExecutor() :
-    _shutdown_request{ false }, _worker_thread{ [this] { worker_thread(); } }
-{
-}
-
-std::future<void> OnThreadExecutor::submit(task_t task)
-{
-    auto future = task.get_future();
-    std::lock_guard lock{ _task_mutex };
-    _task_queue.emplace(std::move(task));
-    _task_cv.notify_one();
-    return future;
-}
-
-void OnThreadExecutor::cancel()
-{
-    std::lock_guard lock{ _task_mutex };
-    _task_queue = {};
-    _task_cv.notify_one();
-}
-
-
-void OnThreadExecutor::worker_thread()
-{
-    while (!_shutdown_request)
-    {
-        task_t task;
-        {
-            std::unique_lock task_lock{ _task_mutex };
-            _task_cv.wait(task_lock, [this] { return !_task_queue.empty() || _shutdown_request; });
-            if (_shutdown_request)
-            {
-                return;
-            }
-            task = std::move(_task_queue.front());
-            _task_queue.pop();
-        }
-        task();
-    }
-}
-
-OnThreadExecutor::~OnThreadExecutor()
-{
-    _shutdown_request = true;
-    _task_cv.notify_one();
-    _worker_thread.join();
-}

src/modules/Projects/ProjectsSnapshotTool/OnThreadExecutor.h

@@ -1,31 +0,0 @@
-#pragma once
-
-#include <future>
-#include <thread>
-#include <functional>
-#include <queue>
-#include <atomic>
-
-// OnThreadExecutor allows its caller to off-load some work to a persistently running background thread.
-// This might come in handy if you use the API which sets thread-wide global state and the state needs
-// to be isolated.
-
-class OnThreadExecutor final
-{
-public:
-    using task_t = std::packaged_task<void()>;
-
-    OnThreadExecutor();
-    ~OnThreadExecutor();
-    std::future<void> submit(task_t task);
-    void cancel();
-
-private:
-    void worker_thread();
-
-    std::mutex _task_mutex;
-    std::condition_variable _task_cv;
-    std::atomic_bool _shutdown_request;
-    std::queue<std::packaged_task<void()>> _task_queue;
-    std::thread _worker_thread;
-};

src/modules/Projects/ProjectsSnapshotTool/ProjectsSnapshotTool.vcxproj

@@ -124,7 +124,6 @@
   </ItemDefinitionGroup>
   <ItemGroup>
     <ClCompile Include="MonitorUtils.cpp" />
-    <ClCompile Include="OnThreadExecutor.cpp" />
     <ClCompile Include="main.cpp" />
     <ClCompile Include="pch.cpp">
       <PrecompiledHeader Condition="'$(UsePrecompiledHeaders)' != 'false'">Create</PrecompiledHeader>
@@ -132,7 +131,6 @@
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="MonitorUtils.h" />
-    <ClInclude Include="OnThreadExecutor.h" />
     <ClInclude Include="pch.h" />
     <ClInclude Include="resource.h" />
   </ItemGroup>

src/modules/Projects/ProjectsSnapshotTool/ProjectsSnapshotTool.vcxproj.filters

@@ -21,9 +21,6 @@
     <ClInclude Include="MonitorUtils.h">
       <Filter>Header Files</Filter>
     </ClInclude>
-    <ClInclude Include="OnThreadExecutor.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
     <ClInclude Include="resource.h">
       <Filter>Header Files</Filter>
     </ClInclude>
@@ -38,9 +35,6 @@
     <ClCompile Include="MonitorUtils.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="OnThreadExecutor.cpp">
-      <Filter>Source Files</Filter>
-    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />