From: Joel Rosdahl <joel@rosdahl.net>
Date: Thu, 28 Sep 2023 18:32:10 +0000 (+0200)
Subject: refactor: Move assertions to util
X-Git-Tag: v4.9~47
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e4d64b4b9e76807cce2138edddbfb0c8d7bd290b;p=thirdparty%2Fccache.git

refactor: Move assertions to util
---

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 2bf8e36eb..5c6dc1178 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -9,7 +9,6 @@ set(
   ProgressBar.cpp
   Util.cpp
   argprocessing.cpp
-  assertions.cpp
   ccache.cpp
   compopt.cpp
   execute.cpp
diff --git a/src/Config.cpp b/src/Config.cpp
index 410677534..ca27da956 100644
--- a/src/Config.cpp
+++ b/src/Config.cpp
@@ -20,7 +20,6 @@
 
 #include "MiniTrace.hpp"
 #include "Util.hpp"
-#include "assertions.hpp"
 
 #include <core/AtomicFile.hpp>
 #include <core/common.hpp>
@@ -30,6 +29,7 @@
 #include <util/DirEntry.hpp>
 #include <util/Tokenizer.hpp>
 #include <util/UmaskScope.hpp>
+#include <util/assertions.hpp>
 #include <util/environment.hpp>
 #include <util/expected.hpp>
 #include <util/file.hpp>
diff --git a/src/Depfile.cpp b/src/Depfile.cpp
index 064e2124f..d120425d8 100644
--- a/src/Depfile.cpp
+++ b/src/Depfile.cpp
@@ -21,11 +21,11 @@
 #include "Context.hpp"
 #include "Hash.hpp"
 #include "Logging.hpp"
-#include "assertions.hpp"
 
 #include <Util.hpp>
 #include <core/exceptions.hpp>
 #include <util/Tokenizer.hpp>
+#include <util/assertions.hpp>
 #include <util/file.hpp>
 #include <util/path.hpp>
 #include <util/string.hpp>
diff --git a/src/ProgressBar.cpp b/src/ProgressBar.cpp
index f42fa3506..e7ca1b4e1 100644
--- a/src/ProgressBar.cpp
+++ b/src/ProgressBar.cpp
@@ -20,7 +20,7 @@
 
 #include "fmtmacros.hpp"
 
-#include <assertions.hpp>
+#include <util/assertions.hpp>
 #include <util/wincompat.hpp>
 
 #include "third_party/fmt/core.h"
diff --git a/src/SignalHandler.cpp b/src/SignalHandler.cpp
index acfa2e3f6..50d3760a0 100644
--- a/src/SignalHandler.cpp
+++ b/src/SignalHandler.cpp
@@ -19,7 +19,8 @@
 #include "SignalHandler.hpp"
 
 #include "Context.hpp"
-#include "assertions.hpp"
+
+#include <util/assertions.hpp>
 
 #include <signal.h> // NOLINT: sigaddset et al are defined in signal.h
 #include <sys/types.h>
diff --git a/src/argprocessing.cpp b/src/argprocessing.cpp
index 279e084e5..0144e28d6 100644
--- a/src/argprocessing.cpp
+++ b/src/argprocessing.cpp
@@ -20,13 +20,13 @@
 
 #include "Context.hpp"
 #include "Logging.hpp"
-#include "assertions.hpp"
 #include "compopt.hpp"
 #include "fmtmacros.hpp"
 #include "language.hpp"
 
 #include <Depfile.hpp>
 #include <Util.hpp>
+#include <util/assertions.hpp>
 #include <util/path.hpp>
 #include <util/string.hpp>
 #include <util/wincompat.hpp>
diff --git a/src/core/AtomicFile.cpp b/src/core/AtomicFile.cpp
index b95c6685d..c827993b2 100644
--- a/src/core/AtomicFile.cpp
+++ b/src/core/AtomicFile.cpp
@@ -16,11 +16,11 @@
 // this program; if not, write to the Free Software Foundation, Inc., 51
 // Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-#include <assertions.hpp>
 #include <core/AtomicFile.hpp>
 #include <core/exceptions.hpp>
 #include <fmtmacros.hpp>
 #include <util/TemporaryFile.hpp>
+#include <util/assertions.hpp>
 #include <util/expected.hpp>
 #include <util/file.hpp>
 #include <util/filesystem.hpp>
diff --git a/src/core/StatisticsCounters.cpp b/src/core/StatisticsCounters.cpp
index f0361719c..3c08a2714 100644
--- a/src/core/StatisticsCounters.cpp
+++ b/src/core/StatisticsCounters.cpp
@@ -18,7 +18,7 @@
 
 #include "StatisticsCounters.hpp"
 
-#include <assertions.hpp>
+#include <util/assertions.hpp>
 
 #include <algorithm>
 
diff --git a/src/core/mainoptions.cpp b/src/core/mainoptions.cpp
index 1460246e0..d8134e6d1 100644
--- a/src/core/mainoptions.cpp
+++ b/src/core/mainoptions.cpp
@@ -25,7 +25,6 @@
 #include <Logging.hpp>
 #include <ProgressBar.hpp>
 #include <Util.hpp>
-#include <assertions.hpp>
 #include <ccache.hpp>
 #include <core/CacheEntry.hpp>
 #include <core/FileRecompressor.hpp>
@@ -45,6 +44,7 @@
 #include <util/ThreadPool.hpp>
 #include <util/UmaskScope.hpp>
 #include <util/XXH3_128.hpp>
+#include <util/assertions.hpp>
 #include <util/environment.hpp>
 #include <util/expected.hpp>
 #include <util/file.hpp>
diff --git a/src/core/types.cpp b/src/core/types.cpp
index ecd05e520..2793a188a 100644
--- a/src/core/types.cpp
+++ b/src/core/types.cpp
@@ -19,9 +19,9 @@
 #include "types.hpp"
 
 #include <Config.hpp>
-#include <assertions.hpp>
 #include <core/exceptions.hpp>
 #include <fmtmacros.hpp>
+#include <util/assertions.hpp>
 
 namespace core {
 
diff --git a/src/storage/Storage.cpp b/src/storage/Storage.cpp
index 65ce3a70f..889ca98e2 100644
--- a/src/storage/Storage.cpp
+++ b/src/storage/Storage.cpp
@@ -22,13 +22,13 @@
 #include <Logging.hpp>
 #include <MiniTrace.hpp>
 #include <Util.hpp>
-#include <assertions.hpp>
 #include <core/CacheEntry.hpp>
 #include <core/Statistic.hpp>
 #include <core/exceptions.hpp>
 #include <fmtmacros.hpp>
 #include <storage/remote/FileStorage.hpp>
 #include <storage/remote/HttpStorage.hpp>
+#include <util/assertions.hpp>
 #ifdef HAVE_REDIS_STORAGE_BACKEND
 #  include <storage/remote/RedisStorage.hpp>
 #endif
diff --git a/src/storage/local/LocalStorage.cpp b/src/storage/local/LocalStorage.cpp
index 3a4701abe..b87cf6fff 100644
--- a/src/storage/local/LocalStorage.cpp
+++ b/src/storage/local/LocalStorage.cpp
@@ -24,7 +24,6 @@
 #include <Logging.hpp>
 #include <MiniTrace.hpp>
 #include <Util.hpp>
-#include <assertions.hpp>
 #include <core/AtomicFile.hpp>
 #include <core/CacheEntry.hpp>
 #include <core/FileRecompressor.hpp>
@@ -37,6 +36,7 @@
 #include <util/TemporaryFile.hpp>
 #include <util/TextTable.hpp>
 #include <util/ThreadPool.hpp>
+#include <util/assertions.hpp>
 #include <util/expected.hpp>
 #include <util/file.hpp>
 #include <util/filesystem.hpp>
diff --git a/src/storage/remote/FileStorage.cpp b/src/storage/remote/FileStorage.cpp
index 3866fed6a..221dcdc68 100644
--- a/src/storage/remote/FileStorage.cpp
+++ b/src/storage/remote/FileStorage.cpp
@@ -20,13 +20,13 @@
 
 #include <Logging.hpp>
 #include <Util.hpp>
-#include <assertions.hpp>
 #include <core/AtomicFile.hpp>
 #include <core/exceptions.hpp>
 #include <fmtmacros.hpp>
 #include <util/Bytes.hpp>
 #include <util/DirEntry.hpp>
 #include <util/UmaskScope.hpp>
+#include <util/assertions.hpp>
 #include <util/expected.hpp>
 #include <util/file.hpp>
 #include <util/filesystem.hpp>
diff --git a/src/storage/remote/HttpStorage.cpp b/src/storage/remote/HttpStorage.cpp
index a92500799..89d649c35 100644
--- a/src/storage/remote/HttpStorage.cpp
+++ b/src/storage/remote/HttpStorage.cpp
@@ -20,10 +20,10 @@
 
 #include <Hash.hpp>
 #include <Logging.hpp>
-#include <assertions.hpp>
 #include <ccache.hpp>
 #include <core/exceptions.hpp>
 #include <fmtmacros.hpp>
+#include <util/assertions.hpp>
 #include <util/expected.hpp>
 #include <util/string.hpp>
 #include <util/types.hpp>
diff --git a/src/storage/remote/RedisStorage.cpp b/src/storage/remote/RedisStorage.cpp
index 2e244da18..1121f8a97 100644
--- a/src/storage/remote/RedisStorage.cpp
+++ b/src/storage/remote/RedisStorage.cpp
@@ -20,9 +20,9 @@
 
 #include <Hash.hpp>
 #include <Logging.hpp>
-#include <assertions.hpp>
 #include <core/exceptions.hpp>
 #include <fmtmacros.hpp>
+#include <util/assertions.hpp>
 #include <util/expected.hpp>
 #include <util/string.hpp>
 #include <util/wincompat.hpp> // for timeval
diff --git a/src/util/Bytes.cpp b/src/util/Bytes.cpp
index 1cde9739e..1b4007e52 100644
--- a/src/util/Bytes.cpp
+++ b/src/util/Bytes.cpp
@@ -18,7 +18,7 @@
 
 #include "Bytes.hpp"
 
-#include <assertions.hpp>
+#include <util/assertions.hpp>
 
 namespace util {
 
diff --git a/src/util/CMakeLists.txt b/src/util/CMakeLists.txt
index deb2cad65..c22a0eec5 100644
--- a/src/util/CMakeLists.txt
+++ b/src/util/CMakeLists.txt
@@ -10,6 +10,7 @@ set(
   TimePoint.cpp
   Tokenizer.cpp
   UmaskScope.cpp
+  assertions.cpp
   environment.cpp
   file.cpp
   filesystem.cpp
diff --git a/src/util/Fd.hpp b/src/util/Fd.hpp
index 14d5aa27f..87d04a65c 100644
--- a/src/util/Fd.hpp
+++ b/src/util/Fd.hpp
@@ -19,7 +19,7 @@
 #pragma once
 
 #include <NonCopyable.hpp>
-#include <assertions.hpp>
+#include <util/assertions.hpp>
 #include <util/wincompat.hpp>
 
 #ifdef HAVE_UNISTD_H
diff --git a/src/util/LockFile.cpp b/src/util/LockFile.cpp
index eb1fd9eae..188f337d1 100644
--- a/src/util/LockFile.cpp
+++ b/src/util/LockFile.cpp
@@ -23,8 +23,8 @@
 #include "Win32Util.hpp"
 #include "fmtmacros.hpp"
 
-#include <assertions.hpp>
 #include <util/DirEntry.hpp>
+#include <util/assertions.hpp>
 #include <util/file.hpp>
 #include <util/filesystem.hpp>
 #include <util/process.hpp>
diff --git a/src/util/TextTable.cpp b/src/util/TextTable.cpp
index c7fd17f22..e2e24f70c 100644
--- a/src/util/TextTable.cpp
+++ b/src/util/TextTable.cpp
@@ -18,7 +18,7 @@
 
 #include "TextTable.hpp"
 
-#include <assertions.hpp>
+#include <util/assertions.hpp>
 
 #include <third_party/fmt/core.h>
 
diff --git a/src/util/Tokenizer.hpp b/src/util/Tokenizer.hpp
index 624a8057f..3cf1748d3 100644
--- a/src/util/Tokenizer.hpp
+++ b/src/util/Tokenizer.hpp
@@ -18,7 +18,7 @@
 
 #pragma once
 
-#include <assertions.hpp>
+#include <util/assertions.hpp>
 
 #include <third_party/fmt/core.h>
 
diff --git a/src/assertions.cpp b/src/util/assertions.cpp
similarity index 90%
rename from src/assertions.cpp
rename to src/util/assertions.cpp
index 2229d4f04..f5486a035 100644
--- a/src/assertions.cpp
+++ b/src/util/assertions.cpp
@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Joel Rosdahl and other contributors
+// Copyright (C) 2020-2023 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -16,13 +16,15 @@
 // this program; if not, write to the Free Software Foundation, Inc., 51
 // Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-#include "assertions.hpp"
-
 #include "Util.hpp"
 #include "fmtmacros.hpp"
 
+#include <util/assertions.hpp>
+
 #include "third_party/fmt/core.h"
 
+namespace util {
+
 void
 handle_failed_assertion(const char* file,
                         size_t line,
@@ -37,3 +39,4 @@ handle_failed_assertion(const char* file,
         condition);
   abort();
 }
+} // namespace util
diff --git a/src/assertions.hpp b/src/util/assertions.hpp
similarity index 92%
rename from src/assertions.hpp
rename to src/util/assertions.hpp
index d88cb10f5..cf8988315 100644
--- a/src/assertions.hpp
+++ b/src/util/assertions.hpp
@@ -1,4 +1,4 @@
-// Copyright (C) 2020-2021 Joel Rosdahl and other contributors
+// Copyright (C) 2020-2023 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -31,7 +31,7 @@
 #define ASSERT(condition)                                                      \
   do {                                                                         \
     if (!(condition)) {                                                        \
-      handle_failed_assertion(                                                 \
+      util::handle_failed_assertion(                                           \
         __FILE__, __LINE__, CCACHE_FUNCTION, #condition);                      \
     }                                                                          \
   } while (false)
@@ -44,7 +44,11 @@
 #  define DEBUG_ASSERT(condition) ASSERT(condition)
 #endif
 
+namespace util {
+
 [[noreturn]] void handle_failed_assertion(const char* file,
                                           size_t line,
                                           const char* function,
                                           const char* condition);
+
+}
diff --git a/src/util/string.cpp b/src/util/string.cpp
index cf621e83d..21139ab96 100644
--- a/src/util/string.cpp
+++ b/src/util/string.cpp
@@ -18,8 +18,8 @@
 
 #include "string.hpp"
 
-#include <assertions.hpp>
 #include <fmtmacros.hpp>
+#include <util/assertions.hpp>
 
 #include <algorithm>
 #include <cctype>