Merge branch 'pull-request/#985-Add-uncopyable.h-class-uncopyable' in…

…to development
ETLCPP · Dec 12, 2024 · aa7af8b · aa7af8b
2 parents cabc3a4 + 70da0ee
commit aa7af8b
Show file tree

Hide file tree

Showing 11 changed files with 186 additions and 0 deletions.
diff --git a/include/etl/uncopyable.h b/include/etl/uncopyable.h
@@ -0,0 +1,59 @@
+///\file
+
+/******************************************************************************
+The MIT License(MIT)
+
+Embedded Template Library.
+https://github.com/ETLCPP/etl
+https://www.etlcpp.com
+
+Copyright(c) 2024 BMW AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files(the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions :
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+******************************************************************************/
+
+#ifndef ETL_UNCOPYABLE_INCLUDED
+#define ETL_UNCOPYABLE_INCLUDED
+
+#include "platform.h"
+
+namespace etl
+{
+#if ETL_USING_CPP11
+  //***************************************************************************
+  /// An uncopyable base class.
+  /// Can be used to make a class uncopyable by deriving from it.
+  //***************************************************************************
+  class uncopyable
+  {
+  public:
+
+    uncopyable(uncopyable const&)            = delete;
+    uncopyable& operator=(uncopyable const&) = delete;
+
+  protected:
+
+    uncopyable()  = default;
+    ~uncopyable() = default;
+  };
+
+#endif
+}
+
+#endif
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -288,6 +288,7 @@ add_executable(etl_tests
 	test_type_traits.cpp
 	test_unaligned_type.cpp
 	test_unaligned_type_constexpr.cpp
+	test_uncopyable.cpp
 	test_unordered_map.cpp
 	test_unordered_multimap.cpp
 	test_unordered_multiset.cpp

diff --git a/test/syntax_check/c++03/CMakeLists.txt b/test/syntax_check/c++03/CMakeLists.txt
@@ -296,6 +296,7 @@ target_sources(t98 PRIVATE etl_profile.h
 		../u8string.h.t.cpp
 		../u8string_stream.h.t.cpp
 		../unaligned_type.h.t.cpp
+		../uncopyable.h.t.cpp
 		../unordered_map.h.t.cpp
 		../unordered_multimap.h.t.cpp
 		../unordered_multiset.h.t.cpp

diff --git a/test/syntax_check/c++11/CMakeLists.txt b/test/syntax_check/c++11/CMakeLists.txt
@@ -296,6 +296,7 @@ target_sources(t11 PRIVATE etl_profile.h
 		../u8string.h.t.cpp
 		../u8string_stream.h.t.cpp
 		../unaligned_type.h.t.cpp
+		../uncopyable.h.t.cpp
 		../unordered_map.h.t.cpp
 		../unordered_multimap.h.t.cpp
 		../unordered_multiset.h.t.cpp

diff --git a/test/syntax_check/c++14/CMakeLists.txt b/test/syntax_check/c++14/CMakeLists.txt
@@ -296,6 +296,7 @@ target_sources(t14 PRIVATE etl_profile.h
 		../u8string.h.t.cpp
 		../u8string_stream.h.t.cpp
 		../unaligned_type.h.t.cpp
+		../uncopyable.h.t.cpp
 		../unordered_map.h.t.cpp
 		../unordered_multimap.h.t.cpp
 		../unordered_multiset.h.t.cpp

diff --git a/test/syntax_check/c++17/CMakeLists.txt b/test/syntax_check/c++17/CMakeLists.txt
@@ -296,6 +296,7 @@ target_sources(t17 PRIVATE etl_profile.h
 		../u8string.h.t.cpp
 		../u8string_stream.h.t.cpp
 		../unaligned_type.h.t.cpp
+		../uncopyable.h.t.cpp
 		../unordered_map.h.t.cpp
 		../unordered_multimap.h.t.cpp
 		../unordered_multiset.h.t.cpp

diff --git a/test/syntax_check/c++20/CMakeLists.txt b/test/syntax_check/c++20/CMakeLists.txt
@@ -296,6 +296,7 @@ target_sources(t20 PRIVATE etl_profile.h
 		../u8string.h.t.cpp
 		../u8string_stream.h.t.cpp
 		../unaligned_type.h.t.cpp
+		../uncopyable.h.t.cpp
 		../unordered_map.h.t.cpp
 		../unordered_multimap.h.t.cpp
 		../unordered_multiset.h.t.cpp

diff --git a/test/syntax_check/uncopyable.h.t.cpp b/test/syntax_check/uncopyable.h.t.cpp
@@ -0,0 +1,29 @@
+/******************************************************************************
+The MIT License(MIT)
+
+Embedded Template Library.
+https://github.com/ETLCPP/etl
+https://www.etlcpp.com
+
+Copyright(c) 2024 John Wellbelove
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files(the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions :
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+******************************************************************************/
+
+#include <etl/uncopyable.h>
diff --git a/test/test_uncopyable.cpp b/test/test_uncopyable.cpp
@@ -0,0 +1,66 @@
+/******************************************************************************
+The MIT License(MIT)
+
+Embedded Template Library.
+https://github.com/ETLCPP/etl
+https://www.etlcpp.com
+
+Copyright(c) 2024 BMW AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files(the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions :
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+******************************************************************************/
+
+#include "unit_test_framework.h"
+
+#include "etl/uncopyable.h"
+
+namespace
+{
+  class UncopyableClass: public etl::uncopyable
+  {
+  };
+
+  SUITE(test_uncopyable)
+  {
+    //*************************************************************************
+    TEST(test_construct)
+    {
+      UncopyableClass uc;
+
+      (void) uc;
+    }
+
+    //*************************************************************************
+    // This code is intentionally not compilable when activated
+#if 0
+    TEST(test_copy)
+    {
+      UncopyableClass uc1;
+
+      // Can't be copied by construction
+      UncopyableClass uc2{uc1}; // compile error
+      (void) uc2;
+
+      // Can't be copied by copy assignment
+      UncopyableClass uc3;
+      uc3 = uc1; // compile error
+    }
+#endif
+  };
+}
diff --git a/test/vs2022/etl.vcxproj b/test/vs2022/etl.vcxproj
@@ -3257,6 +3257,7 @@
     <ClInclude Include="..\..\include\etl\u8string.h" />
     <ClInclude Include="..\..\include\etl\u8string_stream.h" />
     <ClInclude Include="..\..\include\etl\unaligned_type.h" />
+    <ClInclude Include="..\..\include\etl\uncopyable.h" />
     <ClInclude Include="..\..\include\etl\variance.h" />
     <ClInclude Include="..\..\include\etl\variant_pool.h" />
     <ClInclude Include="..\..\include\etl\version.h" />
@@ -7629,6 +7630,21 @@
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++14 - No STL|Win32'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20 - Force C++03|Win32'">true</ExcludedFromBuild>
     </ClCompile>
+    <ClCompile Include="..\syntax_check\uncopyable.h.t.cpp">
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20 - No virtual imessage|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++ 20 - No Tests|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20 - No STL|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++14|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release MSVC C++20 - No STL - Optimised -O2|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release MSVC C++20 - No STL - Optimised -O2 - Sanitiser|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++17|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++17 - No STL|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release MSVC C++20 - Optimised O2|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20 - No virtual messages|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++14 - No STL|Win32'">true</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20 - Force C++03|Win32'">true</ExcludedFromBuild>
+    </ClCompile>
     <ClCompile Include="..\syntax_check\unordered_map.h.t.cpp">
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20|Win32'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug MSVC C++20 - No virtual imessage|Win32'">true</ExcludedFromBuild>
@@ -8966,6 +8982,7 @@
     <ClCompile Include="..\test_string_stream_u32.cpp" />
     <ClCompile Include="..\test_unaligned_type.cpp" />
     <ClCompile Include="..\test_unaligned_type_constexpr.cpp" />
+    <ClCompile Include="..\test_uncopyable.cpp" />
     <ClCompile Include="..\test_unordered_map.cpp" />
     <ClCompile Include="..\test_unordered_multimap.cpp" />
     <ClCompile Include="..\test_unordered_multiset.cpp" />

diff --git a/test/vs2022/etl.vcxproj.filters b/test/vs2022/etl.vcxproj.filters
@@ -1413,6 +1413,9 @@
     <ClInclude Include="..\..\include\etl\private\diagnostic_cxx_20_compat_push.h">
       <Filter>ETL\Private</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\include\etl\uncopyable.h">
+      <Filter>ETL\Utilities</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="..\test_string_char.cpp">
@@ -3386,6 +3389,12 @@
     <ClCompile Include="..\syntax_check\stringify.h.t.cpp">
       <Filter>Tests\Syntax Checks\Source</Filter>
     </ClCompile>
+    <ClCompile Include="..\test_uncopyable.cpp">
+      <Filter>Tests\Misc</Filter>
+    </ClCompile>
+    <ClCompile Include="..\syntax_check\uncopyable.h.t.cpp">
+      <Filter>Tests\Syntax Checks\Source</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="..\..\library.properties">