Cleanup includes (#120)

* add support for iwyu on nix * cleanup headers based on iwyu tool * fix a couple of compiler warnings * tidy
krupkat · Feb 10, 2024 · 0048d1d · 0048d1d
1 parent 8f96a54
commit 0048d1d
Show file tree

Hide file tree

Showing 39 changed files with 156 additions and 46 deletions.
diff --git a/misc/build/nix/iwyu.nix b/misc/build/nix/iwyu.nix
@@ -0,0 +1,53 @@
+{ pkgs ? import <nixpkgs> { }
+}:
+let
+  # Workaround taken from https://github.com/NixOS/nixpkgs/issues/189753
+  #
+  # To use the tool extend your cmake settings:
+  #   "cmake.configureSettings": {
+  #     "CMAKE_CXX_INCLUDE_WHAT_YOU_USE": [
+  #         "include-what-you-use",
+  #         "-Xiwyu",
+  #         "--mapping_file=${workspaceFolder}/misc/mappings/iwyu_nix.imp",
+  #         "-Xiwyu",
+  #         "--no_fwd_decls",
+  #     ]
+  # },
+  #
+  include-what-you-use-wrapped =
+    let
+      llvm = pkgs.llvmPackages_15;
+    in
+    pkgs.wrapCCWith rec {
+      cc = pkgs.include-what-you-use.override {
+        llvmPackages = llvm;
+      };
+      extraBuildCommands = ''
+        wrap include-what-you-use $wrapper $ccPath/include-what-you-use
+        substituteInPlace "$out/bin/include-what-you-use" --replace 'dontLink=0' 'dontLink=1'
+        substituteInPlace "$out/bin/include-what-you-use" --replace ' && isCxx=1 || isCxx=0' '&&  true; isCxx=1'
+
+        rsrc="$out/resource-root"
+        mkdir "$rsrc"
+        ln -s "${llvm.clang}/resource-root/include" "$rsrc"
+        echo "-resource-dir=$rsrc" >> $out/nix-support/cc-cflags
+      '';
+      libcxx = llvm.libcxx;
+    };
+in
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    cmake
+    ninja
+    pkg-config
+    opencv
+    SDL2
+    catch2_3
+    spdlog
+    exiv2
+    dbus
+    (python3.withPackages (pkgs: with pkgs; [ pyyaml ]))
+    clang-tools_15
+    include-what-you-use-wrapped
+  ];
+}
diff --git a/misc/mappings/iwyu_nix.imp b/misc/mappings/iwyu_nix.imp
@@ -0,0 +1,29 @@
+[
+  { include: ["@<__algorithm/.*>", "private", "<algorithm>", "public"] },
+  { include: ["@<__functional/.*>", "private", "<functional>", "public"] },
+  { include: ["@<__type_traits/.*>", "private", "<type_traits>", "public"] },
+  { include: ["@<__memory/.*>", "private", "<memory>", "public"] },
+  { include: ["@<__iterator/.*>", "private", "<iterator>", "public"] },
+  { include: ["@<__filesystem/.*>", "private", "<filesystem>", "public"] },
+  { include: ["@<__numeric/.*>", "private", "<numeric>", "public"] },
+  { include: ["@<__utility/.*>", "private", "<utility>", "public"] },
+  { include: ["@<__chrono/.*>", "private", "<chrono>", "public"] },
+  { include: ["@<__concepts/.*>", "private", "<concepts>", "public"] },
+  { include: ["@<opencv2/core/.*>", "private", "<opencv2/core.hpp>", "public"] },
+  { include: ["@<opencv2/stitching/.*>", "private", "<opencv2/stitching.hpp>", "public"] },
+  { symbol: [ "std::string", private, "<string>", public ] },
+  { symbol: [ "std::abs", private, "<cmath>", public ] },
+  { symbol: [ "std::ssize", private, "<vector>", public ] },
+  { include: ["@<fmt/.*>", "private", "<spdlog/fmt/fmt.h>", "public"] },
+  { include: ["<__errc>", "private", "<system_error>", "public"] },
+  { include: ["<__mutex_base>", "private", "<mutex>", "public"] },
+  { include: ["@<alpaca/detail/.*>", "private", "<alpaca/alpaca.h>", "public"] },
+  { include: ["<exiv2/exif.hpp>", "private", "<exiv2/exiv2.hpp>", "public"] },
+  { include: ["<exiv2/image.hpp>", "private", "<exiv2/exiv2.hpp>", "public"] },
+  { include: ["<exiv2/tags.hpp>", "private", "<exiv2/exiv2.hpp>", "public"] },
+  { include: ["<exiv2/types.hpp>", "private", "<exiv2/exiv2.hpp>", "public"] },
+  { include: ["<exiv2/error.hpp>", "private", "<exiv2/exiv2.hpp>", "public"] },
+  { include: ["<__fwd/string_view.h>", "private", "<string_view>", "public"] },
+  { include: ["@<SDL_.*>", "private", "<SDL.h>", "public"] },
+  { include: ["<spdlog/common.h>", "private", "<spdlog/spdlog.h>", "public"] },
+]
diff --git a/misc/scripts/format.sh b/misc/scripts/format.sh
@@ -1,2 +1,2 @@
 clang-format-15 -i `find xpano -name *.cc -or -name *.h`
-clang-format-15 -i `find tests -name *.cc -or -name *.h`
+clang-format-15 -i `find tests -name *.cc -or -name *.h`
diff --git a/tests/serialize_test.cc b/tests/serialize_test.cc
@@ -8,6 +8,7 @@
 #include <catch2/catch_test_macros.hpp>
 
 #include "tests/utils.h"
+#include "xpano/algorithm/options.h"
 #include "xpano/pipeline/options.h"
 
 struct Bar {

diff --git a/tests/stitcher_pipeline_test.cc b/tests/stitcher_pipeline_test.cc
@@ -3,12 +3,14 @@
 
 #include "xpano/pipeline/stitcher_pipeline.h"
 
+#include <chrono>
 #include <filesystem>
+#include <iterator>
 #include <string>
+#include <utility>
 #include <vector>
 
 #include <catch2/catch_test_macros.hpp>
-#include <catch2/generators/catch_generators.hpp>
 #include <catch2/matchers/catch_matchers_floating_point.hpp>
 #include <catch2/matchers/catch_matchers_string.hpp>
 #include <catch2/matchers/catch_matchers_vector.hpp>
@@ -20,6 +22,8 @@
 #include <opencv2/imgproc.hpp>
 
 #include "tests/utils.h"
+#include "xpano/algorithm/options.h"
+#include "xpano/constants.h"
 
 using Catch::Matchers::Equals;
 using Catch::Matchers::WithinAbs;

diff --git a/xpano/algorithm/algorithm.cc b/xpano/algorithm/algorithm.cc
@@ -20,9 +20,6 @@
 #include <opencv2/features2d.hpp>
 #include <opencv2/photo.hpp>
 #include <opencv2/stitching.hpp>
-#include <opencv2/stitching/detail/matchers.hpp>
-#include <opencv2/stitching/detail/warpers.hpp>
-#include <opencv2/stitching/warpers.hpp>
 
 #include "xpano/algorithm/auto_crop.h"
 #include "xpano/algorithm/blenders.h"

diff --git a/xpano/algorithm/algorithm.h b/xpano/algorithm/algorithm.h
@@ -4,8 +4,6 @@
 
 #pragma once
 
-#include <array>
-#include <atomic>
 #include <optional>
 #include <string>
 #include <vector>
@@ -17,7 +15,6 @@
 #include "xpano/algorithm/options.h"
 #include "xpano/algorithm/progress.h"
 #include "xpano/algorithm/stitcher.h"
-#include "xpano/constants.h"
 #include "xpano/utils/rect.h"
 #include "xpano/utils/threadpool.h"
 

diff --git a/xpano/algorithm/blenders.cc b/xpano/algorithm/blenders.cc
@@ -3,15 +3,14 @@
 
 #include "xpano/algorithm/blenders.h"
 
+#include <array>
+#include <cstdint>
 #include <cstring>
 #include <stdexcept>
 
 #ifdef XPANO_WITH_MULTIBLEND
-#include <mb/flex.h>
 #include <mb/multiblend.h>
-#include <mb/threadpool.h>
 #endif
-#include <spdlog/fmt/fmt.h>
 
 namespace xpano::algorithm::blenders {
 

diff --git a/xpano/algorithm/blenders.h b/xpano/algorithm/blenders.h
@@ -6,7 +6,9 @@
 #ifdef XPANO_WITH_MULTIBLEND
 #include <mb/image.h>
 #endif
-#include <opencv2/stitching/detail/blenders.hpp>
+
+#include <opencv2/core.hpp>
+#include <opencv2/stitching.hpp>
 
 #include "xpano/utils/threadpool.h"
 

diff --git a/xpano/algorithm/stitcher.cc b/xpano/algorithm/stitcher.cc
@@ -49,11 +49,16 @@
 #include "xpano/algorithm/stitcher.h"
 
 #include <algorithm>
+#include <cmath>
+#include <cstddef>
 #include <numeric>
 #include <string_view>
+#include <utility>
 
 #include <spdlog/spdlog.h>
 
+#include "xpano/utils/opencv.h"
+
 namespace xpano::algorithm::stitcher {
 
 namespace {
@@ -91,7 +96,7 @@ class Timer {
     return kTickFrequency;
   }
 
-  int64 start_count_;
+  int64 start_count_ = 0;
 };
 
 double ComputeWarpScale(const std::vector<cv::detail::CameraParams> &cameras) {

diff --git a/xpano/algorithm/stitcher.h b/xpano/algorithm/stitcher.h
@@ -48,14 +48,14 @@
 
 #pragma once
 
-#include <atomic>
+#include <vector>
 
 #include <opencv2/core.hpp>
 #include <opencv2/features2d.hpp>
+#include <opencv2/imgproc.hpp>
 #include <opencv2/stitching.hpp>
 
 #include "xpano/algorithm/progress.h"
-#include "xpano/utils/opencv.h"
 
 namespace xpano::algorithm::stitcher {
 

diff --git a/xpano/cli/args.cc b/xpano/cli/args.cc
@@ -3,7 +3,9 @@
 
 #include "xpano/cli/args.h"
 
+#include <exception>
 #include <filesystem>
+#include <string>
 #include <vector>
 
 #include <spdlog/fmt/fmt.h>

diff --git a/xpano/cli/pano_cli.cc b/xpano/cli/pano_cli.cc
@@ -4,6 +4,7 @@
 #include "xpano/cli/pano_cli.h"
 
 #include <atomic>
+#include <exception>
 #include <filesystem>
 
 #include <spdlog/spdlog.h>
@@ -13,6 +14,7 @@
 #include "xpano/cli/signal.h"
 #include "xpano/constants.h"
 #include "xpano/log/logger.h"
+#include "xpano/pipeline/options.h"
 #include "xpano/pipeline/stitcher_pipeline.h"
 #include "xpano/utils/future.h"
 #include "xpano/version_fmt.h"

diff --git a/xpano/cli/signal.cc b/xpano/cli/signal.cc
@@ -3,10 +3,10 @@
 
 #include "xpano/cli/signal.h"
 
-#include <spdlog/spdlog.h>
-
 #ifdef _WIN32
 #include <windows.h>
+
+#include <spdlog/spdlog.h>
 #else
 #include <signal.h>  // NOLINT(modernize-deprecated-headers)
 #endif

diff --git a/xpano/constants.h b/xpano/constants.h
@@ -100,4 +100,7 @@ constexpr int kExifDefaultOrientation = 1;
 
 constexpr int kCancelAnimationFrameDuration = 128;
 
+const std::string kGithubIssuesLink = "https://github.com/krupkat/xpano/issues";
+const std::string kAuthorEmail = "tomas@krupkat.cz";
+
 }  // namespace xpano
diff --git a/xpano/gui/file_dialog.cc b/xpano/gui/file_dialog.cc
@@ -9,9 +9,9 @@
 #include <filesystem>
 #include <iterator>
 #include <string>
+#include <utility>
 #include <vector>
 
-#include <nfd.h>
 #include <nfd.hpp>
 #include <spdlog/fmt/fmt.h>
 #include <spdlog/spdlog.h>

diff --git a/xpano/gui/file_dialog.h b/xpano/gui/file_dialog.h
@@ -4,7 +4,6 @@
 #pragma once
 
 #include <filesystem>
-#include <optional>
 #include <string>
 #include <vector>
 

diff --git a/xpano/gui/panels/about.h b/xpano/gui/panels/about.h
@@ -6,6 +6,7 @@
 
 #include <future>
 #include <optional>
+#include <string>
 
 #include "xpano/utils/text.h"
 

diff --git a/xpano/gui/panels/bugreport_pane.cc b/xpano/gui/panels/bugreport_pane.cc
@@ -12,15 +12,6 @@
 
 namespace xpano::gui {
 
-namespace {
-
-const std::string kGithubIssuesLink =
-    R"(https://github.com/krupkat/xpano/issues)";
-
-const std::string kAuthorEmail = R"(tomas@krupkat.cz)";
-
-}  // namespace
-
 BugReportPane::BugReportPane(logger::Logger *logger) : logger_(logger) {}
 
 void BugReportPane::Show() { show_ = true; }

diff --git a/xpano/gui/panels/preview_pane.cc b/xpano/gui/panels/preview_pane.cc
@@ -12,14 +12,12 @@
 #include <imgui.h>
 #include <opencv2/core.hpp>
 #include <opencv2/imgproc.hpp>
-#include <opencv2/stitching/detail/camera.hpp>
 #include <spdlog/spdlog.h>
 
 #include "xpano/constants.h"
 #include "xpano/gui/action.h"
 #include "xpano/gui/backends/base.h"
 #include "xpano/gui/widgets/widgets.h"
-#include "xpano/utils/opencv.h"
 #include "xpano/utils/rect.h"
 #include "xpano/utils/vec.h"
 #include "xpano/utils/vec_converters.h"

diff --git a/xpano/gui/panels/sidebar.cc b/xpano/gui/panels/sidebar.cc
@@ -16,6 +16,7 @@
 #include "xpano/algorithm/algorithm.h"
 #include "xpano/algorithm/blenders.h"
 #include "xpano/algorithm/image.h"
+#include "xpano/algorithm/progress.h"
 #include "xpano/constants.h"
 #include "xpano/gui/action.h"
 #include "xpano/gui/panels/preview_pane.h"

diff --git a/xpano/gui/panels/sidebar.h b/xpano/gui/panels/sidebar.h
@@ -9,6 +9,7 @@
 
 #include "xpano/algorithm/algorithm.h"
 #include "xpano/algorithm/image.h"
+#include "xpano/algorithm/options.h"
 #include "xpano/gui/action.h"
 #include "xpano/gui/panels/preview_pane.h"
 #include "xpano/gui/panels/thumbnail_pane.h"

diff --git a/xpano/gui/panels/warning_pane.cc b/xpano/gui/panels/warning_pane.cc
@@ -3,6 +3,8 @@
 
 #include "xpano/gui/panels/warning_pane.h"
 
+#include <utility>
+
 #include <imgui.h>
 #include <spdlog/fmt/fmt.h>
 #include <spdlog/spdlog.h>

diff --git a/xpano/gui/pano_gui.cc b/xpano/gui/pano_gui.cc
@@ -6,6 +6,8 @@
 #include "xpano/gui/pano_gui.h"
 
 #include <algorithm>
+#include <exception>
+#include <filesystem>
 #include <future>
 #include <optional>
 #include <string>
@@ -19,6 +21,7 @@
 
 #include "xpano/algorithm/algorithm.h"
 #include "xpano/algorithm/image.h"
+#include "xpano/algorithm/options.h"
 #include "xpano/cli/args.h"
 #include "xpano/constants.h"
 #include "xpano/gui/action.h"
@@ -198,7 +201,7 @@ auto ResolveStitchingResultFuture(
     spdlog::info(*status_message);
   }
 
-  return std::move(result);
+  return result;
 }
 
 auto ResolveExportFuture(std::future<pipeline::ExportResult> export_future,
@@ -625,7 +628,7 @@ MultiAction PanoGui::ResolveFutures() {
       };
 
   auto handle_pano =
-      [this, &actions](std::future<pipeline::StitchingResult> pano_future) {
+      [this](std::future<pipeline::StitchingResult> pano_future) {
         auto result = ResolveStitchingResultFuture(
             std::move(pano_future), &plot_pane_, &status_message_);
         auto& pano = stitcher_data_->panos[result.pano_id];