chore: Improve source tree structure

In preparation for adding support for using dependencies from the system
in addition to bundled or downloaded dependencies, restructure the
source tree so that:

- Third party headers are included without a third_party/ prefix, e.g.
  #include <xxhash.h> instead of #include <third_party/xxhash.h>.
- Ccache headers are included with a ccache/ prefix, e.g. #include
  <ccache/util/string.hpp> instead of #include <util/string.hpp>.

This keeps ccache and other headers separated but in another way than
before.

Author: jrosdahl

.clang-format

@@ -24,20 +24,18 @@ ConstructorInitializerIndentWidth: 2
 ContinuationIndentWidth: 2
 IncludeBlocks: Regroup
 IncludeCategories:
-  - Regex: '^"system.hpp"$'
-    Priority: 1
-  - Regex: '^["<]third_party/'
-    Priority: 4
-  # System headers:
-  - Regex: '\.h>$'
-    Priority: 5
-  # C++ headers:
-  - Regex: '^<[^.]+>$'
-    Priority: 6
+  # Relative headers
   - Regex: '^"'
+    Priority: 1
+  # Ccache headers:
+  - Regex: '^<ccache/'
     Priority: 2
-  - Regex: '.*'
+  # System headers:
+  - Regex: '\.h.*>$'
     Priority: 3
+  # C++ headers:
+  - Regex: '^<'
+    Priority: 4
 IndentPPDirectives: AfterHash
 KeepEmptyLinesAtTheStartOfBlocks: false
 PointerAlignment: Left

ARCHITECTURE.md

@@ -17,9 +17,14 @@
 
 ### Subdirectories of `src`
 
+* `ccache`: Ccache source code.
+* `third_party`: Bundled third party code.
+
+### Subdirectories of `src/ccache`
+
 This section describes the directory structure that the project aims to
-transform the `src` directory into in the long run to make the code base easier
-to understand and work with. In other words, this is work in progress.
+transform the `src/ccache` directory into in the long run to make the code base
+easier to understand and work with. In other words, this is work in progress.
 
 * `compiler`: Knowledge about things like compiler options, compiler behavior,
   preprocessor output format, etc. Ideally this code should in the future be
@@ -29,6 +34,5 @@ to understand and work with. In other words, this is work in progress.
 * `storage`: Storage backends.
 * `storage/local`: Code for the local storage backend.
 * `storage/remote`: Code for remote storage backends.
-* `third_party`: Bundled third party code.
 * `util`: Generic utility functionality that does not depend on ccache-specific
   things.

CMakeLists.txt

@@ -121,12 +121,13 @@ include(CodeAnalysis)
 #
 # Source code
 #
-add_subdirectory(src)
+add_subdirectory(src/ccache)
+add_subdirectory(src/third_party)
 
 #
 # ccache executable
 #
-add_executable(ccache src/main.cpp)
+add_executable(ccache src/ccache/main.cpp)
 target_link_libraries(ccache PRIVATE standard_settings standard_warnings ccache_framework)
 
 #

cmake/GenerateVersionFile.cmake

@@ -1,4 +1,4 @@
 configure_file(
   ${CMAKE_SOURCE_DIR}/cmake/version.cpp.in
-  ${CMAKE_BINARY_DIR}/src/version.cpp
+  ${CMAKE_BINARY_DIR}/src/ccache/version.cpp
   @ONLY)

src/.clang-tidy src/ccache/.clang-tidy

@@ -18,10 +18,10 @@
 
 #include "Args.hpp"
 
-#include <core/exceptions.hpp>
-#include <util/file.hpp>
-#include <util/logging.hpp>
-#include <util/string.hpp>
+#include <ccache/core/exceptions.hpp>
+#include <ccache/util/file.hpp>
+#include <ccache/util/logging.hpp>
+#include <ccache/util/string.hpp>
 
 Args::Args(Args&& other) noexcept : m_args(std::move(other.m_args))
 {

src/Args.cpp src/ccache/Args.cpp

@@ -1,4 +1,4 @@
-// Copyright (C) 2020-2023 Joel Rosdahl and other contributors
+// Copyright (C) 2020-2024 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -18,7 +18,7 @@
 
 #pragma once
 
-#include "Args.hpp"
+#include <ccache/Args.hpp>
 
 #include <optional>
 #include <string>

src/Args.hpp src/ccache/Args.hpp

@@ -47,7 +47,8 @@ target_link_libraries(
   PRIVATE standard_settings standard_warnings ZSTD::ZSTD Threads::Threads third_party
 )
 
-target_include_directories(ccache_framework PUBLIC ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR})
+get_filename_component(SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR} DIRECTORY)
+target_include_directories(ccache_framework PUBLIC ${CMAKE_BINARY_DIR} ${SRC_DIR})
 
 if(REDIS_STORAGE_BACKEND)
   target_compile_definitions(ccache_framework PUBLIC -DHAVE_REDIS_STORAGE_BACKEND)
@@ -62,5 +63,4 @@ target_link_libraries(test-lockfile PRIVATE standard_settings standard_warnings
 
 add_subdirectory(core)
 add_subdirectory(storage)
-add_subdirectory(third_party)
 add_subdirectory(util)

src/ArgsInfo.hpp src/ccache/ArgsInfo.hpp

@@ -18,23 +18,22 @@
 
 #include "Config.hpp"
 
-#include "Util.hpp"
-
-#include <core/AtomicFile.hpp>
-#include <core/common.hpp>
-#include <core/exceptions.hpp>
-#include <core/types.hpp>
-#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>
-#include <util/filesystem.hpp>
-#include <util/format.hpp>
-#include <util/string.hpp>
-#include <util/wincompat.hpp>
+#include <ccache/Util.hpp>
+#include <ccache/core/AtomicFile.hpp>
+#include <ccache/core/common.hpp>
+#include <ccache/core/exceptions.hpp>
+#include <ccache/core/types.hpp>
+#include <ccache/util/DirEntry.hpp>
+#include <ccache/util/Tokenizer.hpp>
+#include <ccache/util/UmaskScope.hpp>
+#include <ccache/util/assertions.hpp>
+#include <ccache/util/environment.hpp>
+#include <ccache/util/expected.hpp>
+#include <ccache/util/file.hpp>
+#include <ccache/util/filesystem.hpp>
+#include <ccache/util/format.hpp>
+#include <ccache/util/string.hpp>
+#include <ccache/util/wincompat.hpp>
 
 #ifdef HAVE_PWD_H
 #  include <pwd.h>

src/CMakeLists.txt src/ccache/CMakeLists.txt

@@ -18,9 +18,9 @@
 
 #pragma once
 
-#include <core/Sloppiness.hpp>
-#include <util/NonCopyable.hpp>
-#include <util/string.hpp>
+#include <ccache/core/Sloppiness.hpp>
+#include <ccache/util/NonCopyable.hpp>
+#include <ccache/util/string.hpp>
 
 #include <sys/types.h>
 

src/Config.cpp src/ccache/Config.cpp

@@ -18,17 +18,16 @@
 
 #include "Context.hpp"
 
-#include "SignalHandler.hpp"
-#include "Util.hpp"
-#include "hashutil.hpp"
-
-#include <util/TimePoint.hpp>
-#include <util/file.hpp>
-#include <util/logging.hpp>
-#include <util/path.hpp>
-#include <util/process.hpp>
-#include <util/string.hpp>
-#include <util/wincompat.hpp>
+#include <ccache/SignalHandler.hpp>
+#include <ccache/Util.hpp>
+#include <ccache/hashutil.hpp>
+#include <ccache/util/TimePoint.hpp>
+#include <ccache/util/file.hpp>
+#include <ccache/util/logging.hpp>
+#include <ccache/util/path.hpp>
+#include <ccache/util/process.hpp>
+#include <ccache/util/string.hpp>
+#include <ccache/util/wincompat.hpp>
 
 #ifdef HAVE_UNISTD_H
 #  include <unistd.h>

src/Config.hpp src/ccache/Config.hpp

@@ -18,23 +18,21 @@
 
 #pragma once
 
-#include "Args.hpp"
-#include "ArgsInfo.hpp"
-#include "Config.hpp"
-
-#include <util/FileStream.hpp>
-#include <util/NonCopyable.hpp>
+#include <ccache/Args.hpp>
+#include <ccache/ArgsInfo.hpp>
+#include <ccache/Config.hpp>
+#include <ccache/Hash.hpp>
+#include <ccache/core/Manifest.hpp>
+#include <ccache/storage/Storage.hpp>
+#include <ccache/util/Bytes.hpp>
+#include <ccache/util/FileStream.hpp>
+#include <ccache/util/NonCopyable.hpp>
+#include <ccache/util/TimePoint.hpp>
 
 #ifdef INODE_CACHE_SUPPORTED
-#  include "InodeCache.hpp"
+#  include <ccache/InodeCache.hpp>
 #endif
 
-#include <Hash.hpp>
-#include <core/Manifest.hpp>
-#include <storage/Storage.hpp>
-#include <util/Bytes.hpp>
-#include <util/TimePoint.hpp>
-
 #include <sys/types.h>
 
 #include <ctime>

src/Context.cpp src/ccache/Context.cpp

@@ -1,4 +1,4 @@
-// Copyright (C) 2020-2023 Joel Rosdahl and other contributors
+// Copyright (C) 2020-2024 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -18,18 +18,17 @@
 
 #include "Depfile.hpp"
 
-#include "Context.hpp"
-#include "Hash.hpp"
-
-#include <Util.hpp>
-#include <core/exceptions.hpp>
-#include <util/Tokenizer.hpp>
-#include <util/assertions.hpp>
-#include <util/file.hpp>
-#include <util/filesystem.hpp>
-#include <util/logging.hpp>
-#include <util/path.hpp>
-#include <util/string.hpp>
+#include <ccache/Context.hpp>
+#include <ccache/Hash.hpp>
+#include <ccache/Util.hpp>
+#include <ccache/core/exceptions.hpp>
+#include <ccache/util/Tokenizer.hpp>
+#include <ccache/util/assertions.hpp>
+#include <ccache/util/file.hpp>
+#include <ccache/util/filesystem.hpp>
+#include <ccache/util/logging.hpp>
+#include <ccache/util/path.hpp>
+#include <ccache/util/string.hpp>
 
 #include <algorithm>
 

src/Context.hpp src/ccache/Context.hpp

@@ -1,4 +1,4 @@
-// Copyright (C) 2020-2023 Joel Rosdahl and other contributors
+// Copyright (C) 2020-2024 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -18,12 +18,12 @@
 
 #include "Hash.hpp"
 
-#include <util/Fd.hpp>
-#include <util/file.hpp>
-#include <util/format.hpp>
-#include <util/logging.hpp>
-#include <util/string.hpp>
-#include <util/wincompat.hpp>
+#include <ccache/util/Fd.hpp>
+#include <ccache/util/file.hpp>
+#include <ccache/util/format.hpp>
+#include <ccache/util/logging.hpp>
+#include <ccache/util/string.hpp>
+#include <ccache/util/wincompat.hpp>
 
 #include <fcntl.h>
 #include <sys/stat.h>

src/Depfile.cpp src/ccache/Depfile.cpp

@@ -18,9 +18,9 @@
 
 #pragma once
 
-#include "third_party/blake3/blake3.h"
-#include <third_party/nonstd/span.hpp>
-#include <third_party/tl/expected.hpp>
+#include <blake3/blake3.h>
+#include <nonstd/span.hpp>
+#include <tl/expected.hpp>
 
 #include <array>
 #include <cstdint>

src/Depfile.hpp src/ccache/Depfile.hpp

@@ -18,19 +18,18 @@
 
 #include "InodeCache.hpp"
 
-#include "Config.hpp"
-#include "Hash.hpp"
-#include "Util.hpp"
-
-#include <util/DirEntry.hpp>
-#include <util/Fd.hpp>
-#include <util/Finalizer.hpp>
-#include <util/PathString.hpp>
-#include <util/TemporaryFile.hpp>
-#include <util/conversion.hpp>
-#include <util/file.hpp>
-#include <util/format.hpp>
-#include <util/logging.hpp>
+#include <ccache/Config.hpp>
+#include <ccache/Hash.hpp>
+#include <ccache/Util.hpp>
+#include <ccache/util/DirEntry.hpp>
+#include <ccache/util/Fd.hpp>
+#include <ccache/util/Finalizer.hpp>
+#include <ccache/util/PathString.hpp>
+#include <ccache/util/TemporaryFile.hpp>
+#include <ccache/util/conversion.hpp>
+#include <ccache/util/file.hpp>
+#include <ccache/util/format.hpp>
+#include <ccache/util/logging.hpp>
 
 #include <fcntl.h>
 

src/Hash.cpp src/ccache/Hash.cpp

@@ -18,12 +18,12 @@
 
 #pragma once
 
-#include <Hash.hpp>
-#include <hashutil.hpp>
-#include <util/Duration.hpp>
-#include <util/Fd.hpp>
-#include <util/MemoryMap.hpp>
-#include <util/TimePoint.hpp>
+#include <ccache/Hash.hpp>
+#include <ccache/hashutil.hpp>
+#include <ccache/util/Duration.hpp>
+#include <ccache/util/Fd.hpp>
+#include <ccache/util/MemoryMap.hpp>
+#include <ccache/util/TimePoint.hpp>
 
 #include <sys/types.h>
 

src/Hash.hpp src/ccache/Hash.hpp

@@ -1,4 +1,4 @@
-// Copyright (C) 2019-2023 Joel Rosdahl and other contributors
+// Copyright (C) 2019-2024 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -18,9 +18,9 @@
 
 #include "ProgressBar.hpp"
 
-#include <util/assertions.hpp>
-#include <util/format.hpp>
-#include <util/wincompat.hpp>
+#include <ccache/util/assertions.hpp>
+#include <ccache/util/format.hpp>
+#include <ccache/util/wincompat.hpp>
 
 #ifdef _WIN32
 #else

src/InodeCache.cpp src/ccache/InodeCache.cpp

@@ -1,4 +1,4 @@
-// Copyright (C) 2020-2023 Joel Rosdahl and other contributors
+// Copyright (C) 2020-2024 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -18,9 +18,8 @@
 
 #include "SignalHandler.hpp"
 
-#include "Context.hpp"
-
-#include <util/assertions.hpp>
+#include <ccache/Context.hpp>
+#include <ccache/util/assertions.hpp>
 
 #include <signal.h> // NOLINT: sigaddset et al are defined in signal.h
 #include <sys/types.h>