Fea, 添加AutoCleanup

Author: mingkuang-Chuyu

UnitTest/AutoCleanupUnitTest.cpp

@@ -0,0 +1,28 @@
+#include "CppUnitTest.h"
+
+#include <YY/Base/Utils/AutoCleanup.h>
+
+using namespace Microsoft::VisualStudio::CppUnitTestFramework;
+
+namespace UnitTest
+{
+    TEST_CLASS(AutoCleanup)
+    {
+    public:
+        TEST_METHOD(普通)
+        {
+            int _iValue = 0;
+
+            {
+                auto _oCleanup = YY::MakeAutoCleanup(
+                    [&]()
+                    {
+                        _iValue++;
+                    });
+
+                Assert::AreEqual(0, _iValue);
+            }
+            Assert::AreEqual(1, _iValue);
+        }
+    };
+}

UnitTest/UnitTest.vcxproj

@@ -174,6 +174,7 @@
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="AsyncFileUnitTest.cpp" />
+    <ClCompile Include="AutoCleanupUnitTest.cpp" />
     <ClCompile Include="BindUnitTest.cpp" />
     <ClCompile Include="BitMapUnitTest.cpp" />
     <ClCompile Include="DynamicArrayUnitTest.cpp" />

UnitTest/UnitTest.vcxproj.filters

@@ -42,6 +42,9 @@
     <ClCompile Include="SpanUnitTest.cpp">
       <Filter>单元测试</Filter>
     </ClCompile>
+    <ClCompile Include="AutoCleanupUnitTest.cpp">
+      <Filter>单元测试</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="ToStringHelper.h">

include/YY/Base/Utils/AutoCleanup.h

@@ -0,0 +1,66 @@
+#pragma once
+#include <YY/Base/YY.h>
+
+/*
+AutoCleanup 使用RAII思想，在对象生命周期结束时，自动调用指定的清理函数。
+但是不建议频繁的使用它，优先建议使用智能指针等更合适的资源管理方式。
+
+```cpp
+{
+    int _iValue = 0;
+    {
+        auto _oCleanup = YY::MakeAutoCleanup(
+            [&]()
+            {
+                _iValue++;
+            });
+        // 在这里 _iValue 仍然是 0
+        _iValue == 0;
+    }
+    // 离开作用域后，清理函数被调用，_iValue 变为 1
+    _iValue == 1;
+}
+```
+*/
+
+#pragma pack(push, __YY_PACKING)
+
+namespace YY
+{
+    namespace Base
+    {
+        namespace Utils
+        {
+            template<typename Lambda>
+            class AutoCleanupImpl
+            {
+            private:
+                Lambda pfnCleanupCallBack;
+
+            public:
+                AutoCleanupImpl(Lambda&& _pfnCallBack) noexcept
+                    : pfnCleanupCallBack(std::forward<Lambda>(_pfnCallBack))
+                {
+                }
+
+                AutoCleanupImpl(const AutoCleanupImpl&) = delete;
+                AutoCleanupImpl& operator=(const AutoCleanupImpl&) = delete;
+
+                ~AutoCleanupImpl()
+                {
+                    pfnCleanupCallBack();
+                }
+            };
+
+            template<typename Lambda>
+            _Check_return_ AutoCleanupImpl<Lambda> __YYAPI MakeAutoCleanup(Lambda&& _pfnCallBack)
+            {
+                return AutoCleanupImpl<Lambda>(std::forward<Lambda>(_pfnCallBack));
+            }
+        }
+    }
+
+    using namespace YY::Base::Utils;
+}
+
+#pragma pack(pop)

src/YY.Base.vcxitems

@@ -58,6 +58,7 @@
     </ClCompile>
   </ItemGroup>
   <ItemGroup>
+    <ClInclude Include="$(MSBuildThisFileDirectory)..\include\YY\Base\Utils\AutoCleanup.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)\..\include\YY\Base\Containers\Array.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)\..\include\YY\Base\Containers\Span.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)\..\include\YY\Base\Containers\BitMap.h" />

src/YY.Base.vcxitems.filters

@@ -293,6 +293,9 @@
     <ClInclude Include="$(MSBuildThisFileDirectory)\..\include\YY\Base\Time\DataTime.h">
       <Filter>头文件\YY\Base\Time</Filter>
     </ClInclude>
+    <ClInclude Include="$(MSBuildThisFileDirectory)..\include\YY\Base\Utils\AutoCleanup.h">
+      <Filter>头文件\YY\Base\Utils</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Natvis Include="$(MSBuildThisFileDirectory)\YY.Base.natvis">