Update dependencies 2024 09 (#137)

* update dependencies

* update nfde, imgui

* auto cleanup of imports

* clang-tidy-18

* tidy fixes

* ignore fmt includes

* workarounds

* pyyaml 6.0.2

* add internal fmt header

* format

* contributing

.clang-tidy

@@ -19,6 +19,8 @@ Checks: >
 HeaderFilterRegex: "xpano.*xpano.*"
 
 CheckOptions:
+  - key:   misc-include-cleaner.IgnoreHeaders
+    value: SDL.*;opencv2.*;exiv2.*;spdlog.*;nfd.*;fmt.*
   - key:   readability-identifier-naming.ClassCase
     value: CamelCase
   - key:   readability-identifier-naming.ClassMemberCase

.github/workflows/clang-tidy-check.yml

@@ -17,12 +17,12 @@ permissions:
 
 env:
   BUILD_TYPE: Release
-  CATCH_VERSION: "v3.6.0"
-  EXIV2_VERSION: "v0.28.2"
+  CATCH_VERSION: "v3.7.1"
+  EXIV2_VERSION: "v0.28.3"
 
 jobs:
   clang-tidy-check:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@v4
       with:
@@ -79,13 +79,15 @@ jobs:
 
     - name: Run clang-tidy
       run: |
-        run-clang-tidy-15 `pwd`/xpano `pwd`/tests \
+        run-clang-tidy-18 `pwd`/xpano `pwd`/tests \
           -p=build \
           -quiet \
           -header-filter=xpano/xpano.*xpano \
           -export-fixes=fixes.yml
 
     - name: Check clang-tidy results
       run: |
-        pip install -r misc/scripts/python/requirements.txt
+        python -m venv venv
+        source venv/bin/activate
+        python -m pip install -r misc/scripts/python/requirements.txt
         python misc/scripts/python/check_fixes.py fixes.yml

.github/workflows/test.yml

@@ -12,11 +12,11 @@ permissions:
 
 env:
   BUILD_TYPE: Release
-  SDL_VERSION: "release-2.30.3"
+  SDL_VERSION: "release-2.30.7"
   OPENCV_VERSION: "4.10.0"
-  CATCH_VERSION: "v3.6.0"
+  CATCH_VERSION: "v3.7.1"
   SPDLOG_VERSION: "v1.14.1"
-  EXIV2_VERSION: "v0.28.2"
+  EXIV2_VERSION: "v0.28.3"
   GENERATOR: "Ninja Multi-Config"
 
 jobs:

CONTRIBUTING.md

@@ -8,21 +8,25 @@ The repository mostly uses the Google C++ [style guide](https://google.github.io
 
 ## clang-format
 
- Formatting is checked upon submission, please format your files with the included `.clang-format` configuration. Use the provided scripts for your convenience:
+ Formatting is checked when you make a PR, please format your files with the included `.clang-format` configuration. Use the provided scripts for your convenience:
 
  ```
  /misc/scripts/format.ps1
  /misc/scripts/format.sh
  ```
 ## clang-tidy
 
-Static analysis is checked upon submission, please make sure there are 0 clang-tidy warnings in your code, using the included `.clang-tidy` configutaion. Use the provided scripts for your convenience:
+Static analysis is checked when you make a PR, please make sure there are 0 clang-tidy warnings in your code, using the included `.clang-tidy` configutaion. Use the provided scripts for your convenience:
 
  ```
  /misc/scripts/tidy.ps1
  /misc/scripts/tidy.sh
  ```
 
+### Clang tools versions
+
+The CI currently works with the clang-18 tools from the [Ubuntu 24.04 runner](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md)
+
 ## Copyright
 
 Feel free to add your copyright to the files you modify by adding this comment:

misc/build/build-bullseye.sh

@@ -1,9 +1,9 @@
 export BUILD_TYPE='Release'
-export SDL_VERSION='release-2.30.3'
+export SDL_VERSION='release-2.30.7'
 # export OPENCV_VERSION='4.10.0'
-export CATCH_VERSION='v3.6.0'
+export CATCH_VERSION='v3.7.1'
 export SPDLOG_VERSION='v1.14.1'
-export EXIV2_VERSION='v0.28.2'
+export EXIV2_VERSION='v0.28.3'
 # export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init

misc/build/build-macos.sh

@@ -1,11 +1,11 @@
 # DO NOT MODIFY: Auto-generated by the gen_installer.py script from the .github/workflows/test.yml Github Action
 
 export BUILD_TYPE='Release'
-export SDL_VERSION='release-2.30.3'
+export SDL_VERSION='release-2.30.7'
 export OPENCV_VERSION='4.10.0'
-export CATCH_VERSION='v3.6.0'
+export CATCH_VERSION='v3.7.1'
 export SPDLOG_VERSION='v1.14.1'
-export EXIV2_VERSION='v0.28.2'
+export EXIV2_VERSION='v0.28.3'
 export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init

misc/build/build-ubuntu-20.sh

@@ -1,11 +1,11 @@
 # DO NOT MODIFY: Auto-generated by the gen_installer.py script from the .github/workflows/test.yml Github Action
 
 export BUILD_TYPE='Release'
-export SDL_VERSION='release-2.30.3'
+export SDL_VERSION='release-2.30.7'
 export OPENCV_VERSION='4.10.0'
-export CATCH_VERSION='v3.6.0'
+export CATCH_VERSION='v3.7.1'
 export SPDLOG_VERSION='v1.14.1'
-export EXIV2_VERSION='v0.28.2'
+export EXIV2_VERSION='v0.28.3'
 export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init

misc/build/build-ubuntu-22.sh

@@ -1,11 +1,11 @@
 # DO NOT MODIFY: Auto-generated by the gen_installer.py script from the .github/workflows/test.yml Github Action
 
 export BUILD_TYPE='Release'
-export SDL_VERSION='release-2.30.3'
+export SDL_VERSION='release-2.30.7'
 export OPENCV_VERSION='4.10.0'
-export CATCH_VERSION='v3.6.0'
+export CATCH_VERSION='v3.7.1'
 export SPDLOG_VERSION='v1.14.1'
-export EXIV2_VERSION='v0.28.2'
+export EXIV2_VERSION='v0.28.3'
 export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init

misc/build/build-universal.sh

@@ -1,9 +1,9 @@
 export BUILD_TYPE='Release'
-export SDL_VERSION='release-2.30.3'
+export SDL_VERSION='release-2.30.7'
 export OPENCV_VERSION='4.10.0'
-export CATCH_VERSION='v3.6.0'
+export CATCH_VERSION='v3.7.1'
 export SPDLOG_VERSION='v1.14.1'
-export EXIV2_VERSION='v0.28.2'
+export EXIV2_VERSION='v0.28.3'
 export GENERATOR='Ninja Multi-Config'
 export C_COMPILER='gcc'
 export CXX_COMPILER='g++'

misc/build/build-windows-latest.ps1

@@ -1,11 +1,11 @@
 # DO NOT MODIFY: Auto-generated by the gen_installer.py script from the .github/workflows/test.yml Github Action
 
 $env:BUILD_TYPE = 'Release'
-$env:SDL_VERSION = 'release-2.30.3'
+$env:SDL_VERSION = 'release-2.30.7'
 $env:OPENCV_VERSION = '4.10.0'
-$env:CATCH_VERSION = 'v3.6.0'
+$env:CATCH_VERSION = 'v3.7.1'
 $env:SPDLOG_VERSION = 'v1.14.1'
-$env:EXIV2_VERSION = 'v0.28.2'
+$env:EXIV2_VERSION = 'v0.28.3'
 $env:GENERATOR = 'Ninja Multi-Config'
 
 git submodule update --init

misc/scripts/clean_includes.ps1

@@ -0,0 +1,4 @@
+$xpano_sources = @(Get-ChildItem -Recurse -Path xpano/ -Include *.cc,*.h).fullname
+$test_sources = @(Get-ChildItem -Recurse -Path tests/ -Include *.cc,*.h).fullname
+
+clang-include-cleaner -p build --edit --insert --remove --ignore-headers="SDL.*,opencv2.*,exiv2.*,spdlog\\fmt\\.*" @($xpano_sources + $test_sources)

misc/scripts/python/requirements.txt

@@ -1 +1 @@
-PyYAML==6.0
+PyYAML==6.0.2

misc/scripts/tidy.ps1

@@ -1,2 +1,2 @@
 $tidy_runner = (Get-Command run-clang-tidy).Path
-python $tidy_runner xpano tests -p .\build -quiet
+python $tidy_runner xpano\\xpano xpano\\tests -p .\build -quiet

misc/scripts/tidy.sh

@@ -1 +1 @@
-run-clang-tidy-15 `pwd`/xpano `pwd`/tests -p=build -quiet
+run-clang-tidy-18 `pwd`/xpano `pwd`/tests -p=build -quiet

tests/stitcher_pipeline_test.cc

@@ -3,18 +3,29 @@
 
 #include "xpano/pipeline/stitcher_pipeline.h"
 
+#include <algorithm>
+#include <array>
 #include <chrono>
 #include <filesystem>
+#include <future>
 #include <iterator>
+#include <optional>
 #include <string>
+#include <thread>
 #include <utility>
+#include <variant>
 #include <vector>
 
 #include <catch2/catch_test_macros.hpp>
+#include <catch2/matchers/catch_matchers.hpp>
 #include <catch2/matchers/catch_matchers_floating_point.hpp>
 #include <catch2/matchers/catch_matchers_string.hpp>
 #include <catch2/matchers/catch_matchers_vector.hpp>
 
+#include "xpano/algorithm/algorithm.h"
+#include "xpano/pipeline/options.h"
+#include "xpano/utils/vec.h"
+
 #ifdef XPANO_WITH_EXIV2
 #include <exiv2/exiv2.hpp>
 #endif

xpano/algorithm/algorithm.cc

@@ -24,6 +24,7 @@
 #include "xpano/algorithm/auto_crop.h"
 #include "xpano/algorithm/blenders.h"
 #include "xpano/algorithm/image.h"
+#include "xpano/algorithm/options.h"
 #include "xpano/algorithm/stitcher.h"
 #include "xpano/algorithm/warpers.h"
 #include "xpano/utils/disjoint_set.h"

xpano/algorithm/blenders.cc

@@ -7,8 +7,10 @@
 #include <cstdint>
 #include <cstring>
 #include <stdexcept>
+#include <vector>
 
 #ifdef XPANO_WITH_MULTIBLEND
+#include <mb/image.h>
 #include <mb/multiblend.h>
 #endif
 

xpano/algorithm/options.h

@@ -4,6 +4,7 @@
 #pragma once
 
 #include <array>
+#include <cstdint>
 
 #include "xpano/constants.h"
 
@@ -12,7 +13,7 @@ namespace xpano::algorithm {
 // Bump kOptionsVersion in xpano/pipeline/options.h when changing the
 // definitions
 
-enum class ProjectionType {
+enum class ProjectionType : std::uint8_t {
   kPerspective,
   kCylindrical,
   kSpherical,
@@ -24,16 +25,21 @@ enum class ProjectionType {
   kTransverseMercator
 };
 
-enum class FeatureType { kSift, kOrb };
+enum class FeatureType : std::uint8_t { kSift, kOrb };
 
-enum class WaveCorrectionType { kOff, kAuto, kHorizontal, kVertical };
+enum class WaveCorrectionType : std::uint8_t {
+  kOff,
+  kAuto,
+  kHorizontal,
+  kVertical
+};
 
-enum class InpaintingMethod {
+enum class InpaintingMethod : std::uint8_t {
   kNavierStokes,
   kTelea,
 };
 
-enum class BlendingMethod { kOpenCV, kMultiblend };
+enum class BlendingMethod : std::uint8_t { kOpenCV, kMultiblend };
 
 const char* Label(ProjectionType projection_type);
 const char* Label(FeatureType feature_type);

xpano/algorithm/progress.h

@@ -4,10 +4,11 @@
 #pragma once
 
 #include <atomic>
+#include <cstdint>
 
 namespace xpano::algorithm {
 
-enum class ProgressType {
+enum class ProgressType : std::uint8_t {
   kNone,
   kLoadingImages,
   kStitchingPano,

xpano/algorithm/stitcher.cc

@@ -54,10 +54,12 @@
 #include <numeric>
 #include <string_view>
 #include <utility>
+#include <vector>
 
+#include <spdlog/common.h>
 #include <spdlog/spdlog.h>
 
-#include "xpano/constants.h"
+#include "xpano/algorithm/progress.h"
 #include "xpano/utils/opencv.h"
 
 namespace xpano::algorithm::stitcher {

xpano/algorithm/stitcher.h

@@ -48,6 +48,7 @@
 
 #pragma once
 
+#include <cstdint>
 #include <vector>
 
 #include <opencv2/core.hpp>
@@ -59,7 +60,7 @@
 
 namespace xpano::algorithm::stitcher {
 
-enum class Status {
+enum class Status : std::uint8_t {
   kSuccess,
   kSuccessResolutionCapped,
   kCancelled,

xpano/cli/args.cc

@@ -5,13 +5,14 @@
 
 #include <exception>
 #include <filesystem>
+#include <optional>
 #include <string>
 #include <vector>
 
-#include <spdlog/fmt/fmt.h>
 #include <spdlog/spdlog.h>
 
 #include "xpano/constants.h"
+#include "xpano/utils/fmt.h"
 #include "xpano/utils/path.h"
 
 namespace xpano::cli {

xpano/cli/pano_cli.cc

@@ -6,6 +6,8 @@
 #include <atomic>
 #include <exception>
 #include <filesystem>
+#include <optional>
+#include <utility>
 
 #include <spdlog/spdlog.h>
 
@@ -20,6 +22,9 @@
 #include "xpano/version_fmt.h"
 
 #ifdef _WIN32
+#include <consoleapi.h>
+#include <minwindef.h>
+
 #include "xpano/cli/windows_console.h"
 #endif
 

xpano/cli/pano_cli.h

@@ -3,14 +3,15 @@
 
 #pragma once
 
+#include <cstdint>
 #include <optional>
 #include <utility>
 
 #include "xpano/cli/args.h"
 
 namespace xpano::cli {
 
-enum class ResultType {
+enum class ResultType : std::uint8_t {
   kSuccess,
   kError,
   kForwardToGui,

xpano/cli/signal.cc

@@ -4,7 +4,8 @@
 #include "xpano/cli/signal.h"
 
 #ifdef _WIN32
-#include <windows.h>
+#include <consoleapi.h>
+#include <minwindef.h>
 
 #include <spdlog/spdlog.h>
 #else