clang-tidy checks + fixes for them

Author: Dmitry Malakhov

.clang-format

@@ -1,6 +1,5 @@
-
-
 BasedOnStyle: LLVM
 ColumnLimit: 100
 BreakTemplateDeclarations: Yes
 AllowShortFunctionsOnASingleLine: None
+IncludeBlocks: Regroup

.clang-tidy

@@ -0,0 +1,33 @@
+Checks: >
+    performance-*,
+    -performance-enum-size,
+    bugprone-*,
+    -bugprone-easily-swappable-parameters,
+    modernize-*,
+    -modernize-use-trailing-return-type,
+    portability-*,
+    readability-*,
+    -readability-identifier-length,
+    -readability-static-accessed-through-instance,
+    -readability-make-member-function-const,
+    -readability-avoid-return-with-void-value,
+    -readability-named-parameter,
+
+
+# Turn all the warnings from the checks above into errors.
+WarningsAsErrors: "*"
+
+CheckOptions:
+  - { key: readability-identifier-naming.GlobalConstantCase,       value: UPPER_CASE }
+  - { key: readability-identifier-naming.ConstexprVariableCase,    value: UPPER_CASE }
+  - { key: readability-identifier-naming.LocalConstantCase,        value: lower_case }
+  - { key: readability-identifier-naming.NamespaceCase,            value: lower_case }
+  - { key: readability-identifier-naming.ClassCase,                value: CamelCase  }
+  - { key: readability-identifier-naming.StructCase,               value: CamelCase  }
+  - { key: readability-identifier-naming.TemplateParameterCase,    value: UPPER_CASE }
+  - { key: readability-identifier-naming.FunctionCase,             value: lower_case }
+  - { key: readability-identifier-naming.VariableCase,             value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberPrefix,      value: m_         }
+  - { key: readability-identifier-naming.ProtectedMemberPrefix,    value: m_         }
+  - { key: readability-identifier-naming.MacroDefinitionCase,      value: UPPER_CASE }
+  - { key: readability-identifier-naming.LocalVariableCase,        value: lower_case }

.github/workflows/Codestyle.yaml

@@ -0,0 +1,30 @@
+name: "Codestyle"
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  check-codestyle:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v26
+      - uses: cachix/cachix-action@v14
+        with:
+          name: devenv
+
+      - name: devenv.sh install
+        run: nix profile install nixpkgs#devenv
+
+      - name: devenv.sh evaluation
+        run: devenv shell echo
+
+      - name: clang-format checks
+        run: devenv shell "find . -type f \( -name \*.cpp -o -name \*.hpp \) -print0 | xargs -0 -n1 -P$(nproc) clang-format --Werror -n"
+
+      - name: generate compile-commands
+        run: devenv shell "xmake project -k compile_commands -y"
+
+      - name: clang-tidy checks
+        run: devenv shell "find include src -type f \( -name \*.cpp -o -name \*.hpp \) -print0 | xargs -0 -n1 -P$(nproc) clang-tidy -p build"

.github/workflows/Ubuntu.yaml .github/workflows/TestUbuntu.yaml.github/workflows/Ubuntu.yaml renamed to .github/workflows/TestUbuntu.yaml

@@ -1,11 +1,11 @@
-name: "Test"
+name: "TestUbuntu"
 
 on:
   pull_request:
   push:
 
 jobs:
-  linux-build-and-test:
+  ubuntu-build-and-test:
     runs-on: ubuntu-latest
     strategy:
       matrix:

.gitignore

@@ -4,6 +4,7 @@ build
 .devenv*
 devenv.local.nix
 .direnv
+.clangd
 compile_commands.json
 
 .zed

devenv.nix

@@ -1,10 +1,6 @@
 # https://devenv.sh/
 { pkgs, ... }: {
-  packages = with pkgs; [
-    llvmPackages_latest.clang-tools
-    xmake
-    gdb
-  ];
+  packages = with pkgs; [ llvmPackages_latest.clang-tools xmake gdb ];
 
   languages.cplusplus.enable = true;
   languages.nix.enable = true;

include/corosig/Alloc.hpp

@@ -1,12 +1,8 @@
 #pragma once
 
-#include <algorithm>
 #include <array>
-#include <bit>
 #include <cassert>
 #include <cstddef>
-#include <limits>
-#include <span>
 
 namespace corosig {
 
@@ -30,7 +26,7 @@ struct Alloc {
 
   struct AllocationHeader {
     size_t block_size = 0;
-    char padding;
+    size_t padding = 0;
   };
 
   using Node = typename FreeList::Node;
@@ -53,10 +49,10 @@ struct Alloc {
 
   template <size_t SIZE>
   Alloc(Memory<SIZE> &mem) noexcept : m_mem{mem.begin()}, m_mem_size{mem.size()} {
-    Node *firstNode = new (m_mem) Node{};
-    firstNode->data.block_size = SIZE - sizeof(Node);
-    firstNode->next = nullptr;
-    m_free_list.insert(nullptr, firstNode);
+    Node *first_node = new (m_mem) Node{};
+    first_node->data.block_size = SIZE - sizeof(Node);
+    first_node->next = nullptr;
+    m_free_list.insert(nullptr, first_node);
   }
 
   Alloc(const Alloc &) = delete;
@@ -65,21 +61,21 @@ struct Alloc {
   Alloc &operator=(Alloc &&) noexcept;
   ~Alloc();
 
-  size_t peak_memory() noexcept {
+  [[nodiscard]] size_t peak_memory() const noexcept {
     return m_peak;
   }
 
-  size_t current_memory() noexcept {
+  [[nodiscard]] size_t current_memory() const noexcept {
     return m_peak;
   }
 
-  void *allocate(size_t size, size_t alignment = MIN_ALIGNMENT) noexcept;
+  [[nodiscard]] void *allocate(size_t size, size_t alignment = MIN_ALIGNMENT) noexcept;
   void free(void *ptr) noexcept;
 
 private:
   void coalescence(Node *prevNode, Node *freeNode) noexcept;
   void find(size_t size, size_t alignment, size_t &padding, Node *&previousNode,
-            Node *&foundNode) noexcept;
+            Node *&foundNode) const noexcept;
 };
 
 } // namespace corosig

include/corosig/Coro.hpp

@@ -77,6 +77,7 @@ struct CoroutinePromiseType : CoroListNode {
 
   template <std::convertible_to<Result<T, E>> U>
   void return_value(U &&value) noexcept {
+    [[clang::suppress]] // false positives about m_out being uninitialized
     assert(m_out);
     m_out->m_value.emplace(std::forward<U>(value));
     m_waiting_coro.resume();
@@ -91,7 +92,6 @@ struct CoroutinePromiseType : CoroListNode {
       } else {
         m_out->m_value.emplace(success(std::move(result.assume_value())));
       }
-
     } else {
       m_out->m_value.emplace(std::move(result.assume_error()));
     }
@@ -106,7 +106,7 @@ struct CoroutinePromiseType : CoroListNode {
   friend struct Fut<T, E, REACTOR>;
 
   std::coroutine_handle<> m_waiting_coro = std::noop_coroutine();
-  Fut<T, E, REACTOR> *m_out{nullptr};
+  Fut<T, E, REACTOR> *m_out = nullptr;
 };
 
 } // namespace detail
@@ -131,7 +131,7 @@ struct [[nodiscard("forgot to await?")]] Fut {
     return *this;
   };
 
-  bool has_value() const noexcept {
+  [[nodiscard]] bool has_value() const noexcept {
     return m_value.has_value();
   }
 
@@ -159,7 +159,7 @@ struct [[nodiscard("forgot to await?")]] Fut {
     Awaiter &operator=(const Awaiter &) = delete;
     Awaiter &operator=(Awaiter &&) = delete;
 
-    bool await_ready() const noexcept {
+    [[nodiscard]] bool await_ready() const noexcept {
       return m_future.has_value();
     }
 

include/corosig/ErrorTypes.hpp

@@ -1,10 +1,9 @@
 #pragma once
 
-#include "boost/mp11/algorithm.hpp"
-#include "boost/mp11/detail/mp_list.hpp"
-#include "boost/mp11/detail/mp_rename.hpp"
 #include "corosig/util/Overloaded.hpp"
+
 #include <boost/mp11.hpp>
+#include <boost/mp11/algorithm.hpp>
 #include <concepts>
 #include <cstring>
 #include <type_traits>
@@ -36,36 +35,36 @@ struct Error : std::variant<TYPES...> {
 public:
   using Base::Base;
 
-  char const *description() const noexcept {
+  [[nodiscard]] char const *description() const noexcept {
     return visit(Overloaded{
         [](detail::WithDescription auto const &e) { return e.description(); },
         [](auto const &e) { return typeid(std::decay_t<decltype(e)>).name(); },
     });
   }
 
   template <typename T>
-  bool holds() const noexcept {
+  [[nodiscard]] bool holds() const noexcept {
     return std::holds_alternative<T>(*this);
   }
 
   template <typename F>
-  decltype(auto) visit(F &&f) noexcept {
+  [[nodiscard]] decltype(auto) visit(F &&f) noexcept {
     return std::visit(std::forward<F>(f), *this);
   }
 
   template <typename F>
-  decltype(auto) visit(F &&f) const noexcept {
+  [[nodiscard]] decltype(auto) visit(F &&f) const noexcept {
     return std::visit(std::forward<F>(f), *this);
   }
 };
 
 namespace detail {
 
 template <template <class...> class, class>
-struct is_instance_of : std::false_type {};
+struct IsInstanceOf : std::false_type {};
 
-template <template <class...> class TMPL, class... Args>
-struct is_instance_of<TMPL, TMPL<Args...>> : std::true_type {};
+template <template <class...> class TMPL, class... ARGS>
+struct IsInstanceOf<TMPL, TMPL<ARGS...>> : std::true_type {};
 
 template <template <typename...> typename TMPL, typename... TS>
 using apply_unique =
@@ -81,8 +80,8 @@ struct extend_error_impl<Error<E1...>, Error<E2...>> {
 
 template <typename E1, typename E2>
 using extend_error =
-    extend_error_impl<std::conditional_t<is_instance_of<Error, E1>::value, E1, Error<E1>>,
-                      std::conditional_t<is_instance_of<Error, E2>::value, E2, Error<E2>>>::type;
+    extend_error_impl<std::conditional_t<IsInstanceOf<Error, E1>::value, E1, Error<E1>>,
+                      std::conditional_t<IsInstanceOf<Error, E2>::value, E2, Error<E2>>>::type;
 
 } // namespace detail
 
@@ -99,7 +98,7 @@ struct SyscallError {
 
   static SyscallError current() noexcept;
 
-  char const *description() const noexcept;
+  [[nodiscard]] char const *description() const noexcept;
 
   int value;
 };

include/corosig/Parallel.hpp

@@ -1,6 +1,7 @@
 #include "corosig/Coro.hpp"
 #include "corosig/ErrorTypes.hpp"
 #include "corosig/Result.hpp"
+
 #include <boost/mp11/algorithm.hpp>
 #include <optional>