Add a .clang-tidy file

Fix some of the clang-tidy diagnostics, mute a few specific ones. Try to consider Catch2 headers as system headers to make cang-tidy generate fewer warnings.
Morwenn · Nov 5, 2023 · aa5e067 · aa5e067
1 parent 0ef16f2
commit aa5e067
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 10 deletions.
diff --git a/.clang-tidy b/.clang-tidy
@@ -0,0 +1,13 @@
+# Copyright (c) 2023 Morwenn
+# SPDX-License-Identifier: MIT
+
+# Disabled:
+#  -modernize-avoid-c-arrays: C arrays are cool enough
+Checks: >
+  -*,
+  bugprone-*,
+  clang-analyzer-*,
+  modernize-*,
+  performance-*,
+  portability-*,
+  -modernize-avoid-c-arrays
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -32,6 +32,10 @@ else()
     )
     add_subdirectory(${Catch2_SOURCE_DIR} ${Catch2_BINARY_DIR})
     list(APPEND CMAKE_MODULE_PATH ${Catch2_SOURCE_DIR}/extras)
+
+    # Make Catch2::Catch2 a SYSTEM target
+    get_target_property(Catch2_INCLUDE_DIRECTORY Catch2 INTERFACE_INCLUDE_DIRECTORIES)
+    set_target_properties(Catch2 PROPERTIES INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${Catch2_INCLUDE_DIRECTORY}")
 endif()
 include(Catch)
 

diff --git a/tests/sorters/ska_sorter.cpp b/tests/sorters/ska_sorter.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2022 Morwenn
+ * Copyright (c) 2017-2023 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <algorithm>
@@ -23,6 +23,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with int iterable" )
     {
         std::vector<int> vec;
+        vec.reserve(100'000);
         distribution(std::back_inserter(vec), 100'000);
         cppsort::ska_sort(vec);
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -31,6 +32,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with unsigned int iterators" )
     {
         std::vector<unsigned> vec;
+        vec.reserve(100'000);
         distribution(std::back_inserter(vec), 100'000);
         cppsort::ska_sort(vec.begin(), vec.end());
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -40,6 +42,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with int128 iterable" )
     {
         std::vector<__int128_t> vec;
+        vec.reserve(100'000);
         distribution(std::back_inserter(vec), 100'000, -10'000);
         cppsort::ska_sort(vec);
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -48,6 +51,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with unsigned int128 iterable" )
     {
         std::vector<__uint128_t> vec;
+        vec.reserve(100'000);
         distribution(std::back_inserter(vec), 100'000);
         cppsort::ska_sort(vec);
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -57,6 +61,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with float iterable" )
     {
         std::vector<float> vec;
+        vec.reserve(100'000);
         distribution.call<float>(std::back_inserter(vec), 100'000);
         cppsort::ska_sort(vec);
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -65,6 +70,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with double iterators" )
     {
         std::vector<double> vec;
+        vec.reserve(100'000);
         distribution.call<double>(std::back_inserter(vec), 100'000);
         cppsort::ska_sort(vec.begin(), vec.end());
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -73,6 +79,7 @@ TEST_CASE( "ska_sorter tests", "[ska_sorter]" )
     SECTION( "sort with std::string" )
     {
         std::vector<std::string> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.push_back(std::to_string(i));
         }

diff --git a/tests/sorters/ska_sorter_projection.cpp b/tests/sorters/ska_sorter_projection.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2022 Morwenn
+ * Copyright (c) 2017-2023 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <algorithm>
@@ -19,6 +19,7 @@ TEST_CASE( "ska_sorter tests with projections",
     SECTION( "sort with int iterable" )
     {
         std::vector<std::pair<int, float>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, float(i));
         }
@@ -31,6 +32,7 @@ TEST_CASE( "ska_sorter tests with projections",
     SECTION( "sort with unsigned int iterators" )
     {
         std::vector<std::pair<unsigned, float>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, float(i));
         }
@@ -43,6 +45,7 @@ TEST_CASE( "ska_sorter tests with projections",
     SECTION( "sort with float iterable" )
     {
         std::vector<std::pair<int, float>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, float(i));
         }
@@ -55,6 +58,7 @@ TEST_CASE( "ska_sorter tests with projections",
     SECTION( "sort with double iterators" )
     {
         std::vector<std::pair<int, double>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, double(i));
         }
@@ -69,6 +73,7 @@ TEST_CASE( "ska_sorter tests with projections",
         using wrapper = generic_wrapper<std::string>;
 
         std::vector<wrapper> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(std::to_string(i));
         }

diff --git a/tests/sorters/spread_sorter.cpp b/tests/sorters/spread_sorter.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015-2022 Morwenn
+ * Copyright (c) 2015-2023 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <algorithm>
@@ -18,6 +18,7 @@ TEST_CASE( "spread_sorter tests", "[spread_sorter]" )
     SECTION( "sort with int iterable" )
     {
         std::vector<int> vec;
+        vec.reserve(100'000);
         distribution(std::back_inserter(vec), 100'000);
         cppsort::spread_sort(vec);
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -26,6 +27,7 @@ TEST_CASE( "spread_sorter tests", "[spread_sorter]" )
     SECTION( "sort with unsigned int iterators" )
     {
         std::vector<unsigned> vec;
+        vec.reserve(100'000);
         distribution(std::back_inserter(vec), 100'000);
         cppsort::spread_sort(vec.begin(), vec.end());
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -34,6 +36,7 @@ TEST_CASE( "spread_sorter tests", "[spread_sorter]" )
     SECTION( "sort with float iterable" )
     {
         std::vector<float> vec;
+        vec.reserve(100'000);
         distribution.call<float>(std::back_inserter(vec), 100'000);
         cppsort::spread_sort(vec);
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -42,6 +45,7 @@ TEST_CASE( "spread_sorter tests", "[spread_sorter]" )
     SECTION( "sort with double iterators" )
     {
         std::vector<double> vec;
+        vec.reserve(100'000);
         distribution.call<double>(std::back_inserter(vec), 100'000);
         cppsort::spread_sort(vec.begin(), vec.end());
         CHECK( std::is_sorted(vec.begin(), vec.end()) );
@@ -50,6 +54,7 @@ TEST_CASE( "spread_sorter tests", "[spread_sorter]" )
     SECTION( "sort with std::string" )
     {
         std::vector<std::string> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.push_back(std::to_string(i));
         }
@@ -66,6 +71,7 @@ TEST_CASE( "spread_sorter tests", "[spread_sorter]" )
     SECTION( "reverse sort with std::string" )
     {
         std::vector<std::string> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.push_back(std::to_string(i));
         }

diff --git a/tests/sorters/spread_sorter_projection.cpp b/tests/sorters/spread_sorter_projection.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2022 Morwenn
+ * Copyright (c) 2016-2023 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <algorithm>
@@ -19,6 +19,7 @@ TEST_CASE( "spread_sorter tests with projections",
     SECTION( "sort with int iterable" )
     {
         std::vector<std::pair<int, float>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, float(i));
         }
@@ -31,6 +32,7 @@ TEST_CASE( "spread_sorter tests with projections",
     SECTION( "sort with unsigned int iterators" )
     {
         std::vector<std::pair<unsigned, float>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, float(i));
         }
@@ -43,6 +45,7 @@ TEST_CASE( "spread_sorter tests with projections",
     SECTION( "sort with float iterable" )
     {
         std::vector<std::pair<int, float>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, float(i));
         }
@@ -55,6 +58,7 @@ TEST_CASE( "spread_sorter tests with projections",
     SECTION( "sort with double iterators" )
     {
         std::vector<std::pair<int, double>> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(i, double(i));
         }
@@ -69,6 +73,7 @@ TEST_CASE( "spread_sorter tests with projections",
         using wrapper = generic_wrapper<std::string>;
 
         std::vector<wrapper> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(std::to_string(i));
         }
@@ -83,6 +88,7 @@ TEST_CASE( "spread_sorter tests with projections",
         using wrapper = generic_wrapper<std::string>;
 
         std::vector<wrapper> vec;
+        vec.reserve(100'000);
         for (int i = 0 ; i < 100'000 ; ++i) {
             vec.emplace_back(std::to_string(i));
         }

diff --git a/tests/testing-tools/random.h b/tests/testing-tools/random.h
@@ -136,7 +136,7 @@ namespace hasard // Blame POSIX for picking the good name
     //
     // Returns a random integer in the range [low, high].
     // See *Optimal Discrete Uniform Generation from Coin Flips,
-    // and Applications* by Jérémie Lumbroso
+    // and Applications* by Jérémie Lumbroso
 
     template<typename Integer, typename URBG>
     auto randint(Integer low, Integer high, URBG& generator)

diff --git a/tests/utility/branchless_traits.cpp b/tests/utility/branchless_traits.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2022 Morwenn
+ * Copyright (c) 2017-2023 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <functional>
@@ -85,7 +85,7 @@ TEST_CASE( "test that some specific projections are branchless",
     struct foobar
     {
         int foo;
-        int bar() { return 0; }
+        auto bar() -> int { return 0; }
     };
 
     STATIC_CHECK( is_probably_branchless_projection_v<identity, std::string> );

diff --git a/tests/utility/chainable_projections.cpp b/tests/utility/chainable_projections.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2022 Morwenn
+ * Copyright (c) 2020-2023 Morwenn
  * SPDX-License-Identifier: MIT
  */
 #include <algorithm>
@@ -20,7 +20,8 @@ namespace
     struct proj1:
         cppsort::utility::projection_base
     {
-        int operator()(int value) const
+        auto operator()(int value) const
+            -> int
         {
             return -value;
         }
@@ -29,7 +30,8 @@ namespace
     struct proj2:
         cppsort::utility::projection_base
     {
-        int operator()(int value)
+        auto operator()(int value)
+            -> int
         {
             return -value;
         }