Build support + address sanitizer check (#117)

krupkat · web-flow · commit 72b491721714 · 2023-12-30T18:25:10.000+01:00
* fix building with exiv2 &gt;= 0.28.0

* add nix-shell build environments

* add function to print out available sdl rendering drivers

* add error checking when creating sdl window

* cleanup

* fix memory leak in resource::LoadIcon

* update exiv2 to 0.28.1

* update nfde to 1.1.1

* fix clang tidy

* update catch2 to 3.5.0

* use cmake find_package config mode everywhere for consistency
diff --git a/.github/workflows/clang-tidy-check.yml b/.github/workflows/clang-tidy-check.yml
@@ -17,8 +17,8 @@ permissions:
 
 env:
   BUILD_TYPE: Release
-  CATCH_VERSION: "v3.4.0"
-  EXIV2_VERSION: "v0.28.0"
+  CATCH_VERSION: "v3.5.0"
+  EXIV2_VERSION: "v0.28.1"
 
 jobs:
   clang-tidy-check:
@@ -74,8 +74,8 @@ jobs:
           -DCMAKE_INSTALL_PREFIX=install \
           -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
           -DBUILD_TESTING=ON \
-          -DCatch2_DIR=../catch/install/lib/cmake/Catch2 \
-          -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2
+          -DCatch2_ROOT=`pwd`/catch/install \
+          -Dexiv2_ROOT=`pwd`/exiv2/install
 
     - name: Run clang-tidy
       run: |
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,9 +14,9 @@ env:
   BUILD_TYPE: Release
   SDL_VERSION: "release-2.28.5"
   OPENCV_VERSION: "4.8.1"
-  CATCH_VERSION: "v3.4.0"
+  CATCH_VERSION: "v3.5.0"
   SPDLOG_VERSION: "v1.12.0"
-  EXIV2_VERSION: "v0.28.0"
+  EXIV2_VERSION: "v0.28.1"
   GENERATOR: "Ninja Multi-Config"
 
 jobs:
@@ -150,12 +150,12 @@ jobs:
           -DXPANO_STATIC_VCRT=ON `
           -DCMAKE_INSTALL_PREFIX=install `
           -DCMAKE_EXPORT_COMPILE_COMMANDS=ON `
-          -DSDL2_DIR="${cwd}/sdl/install/cmake" `
+          -DSDL2_ROOT="${cwd}/sdl/install" `
           -DOpenCV_STATIC=ON `
-          -DOpenCV_DIR="${cwd}/opencv/install" `
-          -Dspdlog_DIR="${cwd}/spdlog/build/install/lib/cmake/spdlog" `
-          -DCatch2_DIR="${cwd}/catch/install/lib/cmake/Catch2" `
-          -Dexiv2_DIR="${cwd}/exiv2/install/lib/cmake/exiv2"
+          -DOpenCV_ROOT="${cwd}/opencv/install" `
+          -Dspdlog_ROOT="${cwd}/spdlog/build/install" `
+          -DCatch2_ROOT="${cwd}/catch/install" `
+          -Dexiv2_ROOT="${cwd}/exiv2/install"
 
     - name: Build
       run: cmake --build build --config $env:BUILD_TYPE --target install
@@ -220,8 +220,8 @@ jobs:
           -DCMAKE_INSTALL_PREFIX=install \
           -DBUILD_TESTING=ON \
           -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-          -DCatch2_DIR=../catch/install/lib/cmake/Catch2 \
-          -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2
+          -DCatch2_ROOT=`pwd`/catch/install \
+          -Dexiv2_ROOT=`pwd`/exiv2/install
 
     - name: Build
       run: cmake --build build -j $(nproc) --target install
@@ -361,11 +361,11 @@ jobs:
           -DCMAKE_INSTALL_PREFIX=install \
           -DBUILD_TESTING=ON \
           -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-          -DCatch2_DIR=../catch/install/lib/cmake/Catch2 \
-          -DOpenCV_DIR=opencv/install/lib/cmake/opencv4 \
-          -DSDL2_DIR=SDL/install/lib/cmake/SDL2 \
-          -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2 \
-          -Dspdlog_DIR=`pwd`/spdlog/build/install/lib/cmake/spdlog
+          -DCatch2_ROOT=`pwd`/catch/install \
+          -DOpenCV_ROOT=`pwd`/opencv/install \
+          -DSDL2_ROOT=`pwd`/SDL/install \
+          -Dexiv2_ROOT=`pwd`/exiv2/install \
+          -Dspdlog_ROOT=`pwd`/spdlog/build/install
 
     - name: Build
       run: cmake --build build -j $(nproc) --target install
@@ -433,8 +433,8 @@ jobs:
           -DCMAKE_INSTALL_PREFIX=install \
           -DBUILD_TESTING=ON \
           -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-          -DOpenCV_DIR=opencv/install/lib/cmake/opencv4 \
-          -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2
+          -DOpenCV_ROOT=opencv/install \
+          -Dexiv2_ROOT=exiv2/install
 
     - name: Build
       run: cmake --build build -j $(nproc) --target install
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,4 @@ CMakeSettings.json
 _site
 exiv2/
 Xpano.app
+.cache
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -83,12 +83,20 @@ if (WIN32)
  list(APPEND XPANO_SOURCES "xpano/cli/windows_console.cc")
 endif()
 
-find_package(SDL2 REQUIRED)
-find_package(OpenCV REQUIRED COMPONENTS calib3d core features2d flann imgcodecs imgproc photo stitching)
-find_package(spdlog REQUIRED)
-find_package(exiv2 0.28.0 QUIET)
+find_package(SDL2 REQUIRED CONFIG)
+find_package(OpenCV REQUIRED COMPONENTS calib3d core features2d flann imgcodecs imgproc photo stitching CONFIG)
+find_package(spdlog REQUIRED CONFIG)
+find_package(exiv2 CONFIG)
 
 if (exiv2_FOUND)
+  if (exiv2_VERSION VERSION_GREATER_EQUAL "0.28.1")
+    set(exiv-library Exiv2::exiv2lib)
+  elseif(exiv2_VERSION VERSION_GREATER_EQUAL "0.28.0")
+    set(exiv-library exiv2lib)
+  endif()
+endif()
+
+if (exiv-library)
   message(STATUS "Building with exiv2 version ${exiv2_VERSION}")
 else()
   message(STATUS "Building without exiv2 support")
@@ -136,9 +144,9 @@ target_link_libraries(Xpano
   spdlog::spdlog
 )
 
-if(exiv2_FOUND)
+if (exiv-library)
   target_compile_definitions(Xpano PRIVATE XPANO_WITH_EXIV2)
-  target_link_libraries(Xpano exiv2lib)
+  target_link_libraries(Xpano ${exiv-library})
 endif()
 
 if(XPANO_WITH_MULTIBLEND)
@@ -245,7 +253,7 @@ install(FILES
   RENAME "opencv-license.txt"
   OPTIONAL
 )
-if (exiv2_FOUND)
+if (exiv-library)
   install(FILES
     "misc/build/exiv2-notice.txt"
     DESTINATION "${CMAKE_INSTALL_DATADIR}/licenses"
diff --git a/README.md b/README.md
@@ -53,6 +53,7 @@ The project can be built by running a single script from the `misc/build` direct
 Run the build script from the root of the repository:
 
 ```
+nix-shell misc/build/nix/default.nix
 ./misc/build/build-nixos.sh
 ```
 
diff --git a/external/nativefiledialog-extended b/external/nativefiledialog-extended
@@ -1 +1 @@
-Subproject commit 800f58283fbc1f3950abd881357fb44c22f3f44e
+Subproject commit 5786fabceeaee4d892f3c7a16b243796244cdddc
diff --git a/misc/build/build-bullseye.sh b/misc/build/build-bullseye.sh
@@ -1,9 +1,9 @@
 export BUILD_TYPE='Release'
 export SDL_VERSION='release-2.28.5'
 # export OPENCV_VERSION='4.8.1'
-export CATCH_VERSION='v3.4.0'
+export CATCH_VERSION='v3.5.0'
 export SPDLOG_VERSION='v1.12.0'
-export EXIV2_VERSION='v0.28.0'
+export EXIV2_VERSION='v0.28.1'
 # export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init
@@ -50,10 +50,10 @@ cmake -B build \
   -DCMAKE_INSTALL_PREFIX=install \
   -DBUILD_TESTING=ON \
   -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-  -DCatch2_DIR=../catch/install/lib/cmake/Catch2 \
-  -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2 \
-  -Dspdlog_DIR=`pwd`/spdlog/build/install/lib/cmake/spdlog \
-  -DSDL2_DIR=SDL/install/lib/cmake/SDL2
+  -DCatch2_ROOT=`pwd`/catch/install \
+  -Dexiv2_ROOT=`pwd`/exiv2/install \
+  -Dspdlog_ROOT=`pwd`/spdlog/build/install \
+  -DSDL2_ROOT=`pwd`/SDL/install
 
 cmake --build build -j $(nproc) --target install
 cd build
diff --git a/misc/build/build-macos-12.sh b/misc/build/build-macos-12.sh
@@ -3,9 +3,9 @@
 export BUILD_TYPE='Release'
 export SDL_VERSION='release-2.28.5'
 export OPENCV_VERSION='4.8.1'
-export CATCH_VERSION='v3.4.0'
+export CATCH_VERSION='v3.5.0'
 export SPDLOG_VERSION='v1.12.0'
-export EXIV2_VERSION='v0.28.0'
+export EXIV2_VERSION='v0.28.1'
 export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init
@@ -35,8 +35,8 @@ cmake -B build \
   -DCMAKE_INSTALL_PREFIX=install \
   -DBUILD_TESTING=ON \
   -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-  -DOpenCV_DIR=opencv/install/lib/cmake/opencv4 \
-  -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2
+  -DOpenCV_ROOT=opencv/install \
+  -Dexiv2_ROOT=exiv2/install
 
 cmake --build build -j $(nproc) --target install
 cd build
diff --git a/misc/build/build-nixos.sh b/misc/build/build-nixos.sh
@@ -1,27 +1,15 @@
-#!/usr/bin/env nix-shell 
-#! nix-shell -i bash
-#! nix-shell -p git cmake ninja pkg-config gcc13 opencv SDL2 gtk3 catch2_3 spdlog 
+#!/usr/bin/env bash
 
 git submodule update --init
 
 export BUILD_TYPE='Release'
-export EXIV2_VERSION='v0.28.0'
-
-git clone https://github.com/Exiv2/exiv2.git --depth 1 --branch $EXIV2_VERSION
-cd exiv2
-cmake -B build -G Ninja \
-  -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
-  -DCMAKE_INSTALL_PREFIX=install \
-  `cat ../misc/build/exiv2-minimal-flags.txt`
-cmake --build build --target install
-cd ..
 
 cmake -B build -G Ninja \
   -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
   -DCMAKE_INSTALL_PREFIX=install \
   -DBUILD_TESTING=ON \
   -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-  -Dexiv2_DIR=exiv2/install/lib64/cmake/exiv2
+  -DNFD_PORTAL=ON
 
 cmake --build build --target install
 
diff --git a/misc/build/build-ubuntu-20.sh b/misc/build/build-ubuntu-20.sh
@@ -3,9 +3,9 @@
 export BUILD_TYPE='Release'
 export SDL_VERSION='release-2.28.5'
 export OPENCV_VERSION='4.8.1'
-export CATCH_VERSION='v3.4.0'
+export CATCH_VERSION='v3.5.0'
 export SPDLOG_VERSION='v1.12.0'
-export EXIV2_VERSION='v0.28.0'
+export EXIV2_VERSION='v0.28.1'
 export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init
@@ -76,11 +76,11 @@ cmake -B build \
   -DCMAKE_INSTALL_PREFIX=install \
   -DBUILD_TESTING=ON \
   -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-  -DCatch2_DIR=../catch/install/lib/cmake/Catch2 \
-  -DOpenCV_DIR=opencv/install/lib/cmake/opencv4 \
-  -DSDL2_DIR=SDL/install/lib/cmake/SDL2 \
-  -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2 \
-  -Dspdlog_DIR=`pwd`/spdlog/build/install/lib/cmake/spdlog
+  -DCatch2_ROOT=`pwd`/catch/install \
+  -DOpenCV_ROOT=`pwd`/opencv/install \
+  -DSDL2_ROOT=`pwd`/SDL/install \
+  -Dexiv2_ROOT=`pwd`/exiv2/install \
+  -Dspdlog_ROOT=`pwd`/spdlog/build/install
 
 cmake --build build -j $(nproc) --target install
 cd build
diff --git a/misc/build/build-ubuntu-22.sh b/misc/build/build-ubuntu-22.sh
@@ -3,9 +3,9 @@
 export BUILD_TYPE='Release'
 export SDL_VERSION='release-2.28.5'
 export OPENCV_VERSION='4.8.1'
-export CATCH_VERSION='v3.4.0'
+export CATCH_VERSION='v3.5.0'
 export SPDLOG_VERSION='v1.12.0'
-export EXIV2_VERSION='v0.28.0'
+export EXIV2_VERSION='v0.28.1'
 export GENERATOR='Ninja Multi-Config'
 
 git submodule update --init
@@ -33,8 +33,8 @@ cmake -B build \
   -DCMAKE_INSTALL_PREFIX=install \
   -DBUILD_TESTING=ON \
   -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-  -DCatch2_DIR=../catch/install/lib/cmake/Catch2 \
-  -Dexiv2_DIR=exiv2/install/lib/cmake/exiv2
+  -DCatch2_ROOT=`pwd`/catch/install \
+  -Dexiv2_ROOT=`pwd`/exiv2/install
 
 cmake --build build -j $(nproc) --target install
 cd build
diff --git a/misc/build/build-windows-latest.ps1 b/misc/build/build-windows-latest.ps1
@@ -3,9 +3,9 @@
 $env:BUILD_TYPE = 'Release'
 $env:SDL_VERSION = 'release-2.28.5'
 $env:OPENCV_VERSION = '4.8.1'
-$env:CATCH_VERSION = 'v3.4.0'
+$env:CATCH_VERSION = 'v3.5.0'
 $env:SPDLOG_VERSION = 'v1.12.0'
-$env:EXIV2_VERSION = 'v0.28.0'
+$env:EXIV2_VERSION = 'v0.28.1'
 $env:GENERATOR = 'Ninja Multi-Config'
 
 git submodule update --init
@@ -74,12 +74,12 @@ cmake -B build -G "$env:GENERATOR" `
   -DXPANO_STATIC_VCRT=ON `
   -DCMAKE_INSTALL_PREFIX=install `
   -DCMAKE_EXPORT_COMPILE_COMMANDS=ON `
-  -DSDL2_DIR="${cwd}/sdl/install/cmake" `
+  -DSDL2_ROOT="${cwd}/sdl/install" `
   -DOpenCV_STATIC=ON `
-  -DOpenCV_DIR="${cwd}/opencv/install" `
-  -Dspdlog_DIR="${cwd}/spdlog/build/install/lib/cmake/spdlog" `
-  -DCatch2_DIR="${cwd}/catch/install/lib/cmake/Catch2" `
-  -Dexiv2_DIR="${cwd}/exiv2/install/lib/cmake/exiv2"
+  -DOpenCV_ROOT="${cwd}/opencv/install" `
+  -Dspdlog_ROOT="${cwd}/spdlog/build/install" `
+  -DCatch2_ROOT="${cwd}/catch/install" `
+  -Dexiv2_ROOT="${cwd}/exiv2/install"
 
 cmake --build build --config $env:BUILD_TYPE --target install
 cd build
diff --git a/misc/build/nix/asan.nix b/misc/build/nix/asan.nix
@@ -0,0 +1,37 @@
+{ pkgs ? import
+    (builtins.fetchTarball {
+      name = "nixos-tapir-2023-12-29";
+      url = "https://github.com/nixos/nixpkgs/archive/d02d818f22c777aa4e854efc3242ec451e5d462a.tar.gz";
+      sha256 = "1r6ma7lmi4x5pcxi84fbils1xgnpmmkzi7dd75zhqvg1sds3z47z";
+    })
+    { }
+}:
+
+let
+  asanEnv = pkgs.withCFlags [
+    "-g"
+    "-fsanitize=address"
+    "-fno-omit-frame-pointer"
+    "-Wno-error=maybe-uninitialized"
+  ]
+    pkgs.gcc12Stdenv;
+  addAsanEnv = pkg: pkg.override { stdenv = asanEnv; };
+in
+
+asanEnv.mkDerivation {
+  name = "asan-environment-xpano";
+
+  buildInputs = with pkgs; ([
+    cmake
+    ninja
+    pkg-config
+    (python3.withPackages (pkgs: with pkgs; [ pyyaml ]))
+  ] ++ (map addAsanEnv [
+    opencv
+    SDL2
+    catch2_3
+    spdlog
+    exiv2
+    dbus
+  ]));
+}
diff --git a/misc/build/nix/default.nix b/misc/build/nix/default.nix
@@ -0,0 +1,17 @@
+{ pkgs ? import <nixpkgs> { }
+}:
+
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    cmake
+    ninja
+    pkg-config
+    opencv
+    SDL2
+    catch2_3
+    spdlog
+    exiv2
+    dbus
+    (python3.withPackages (pkgs: with pkgs; [ pyyaml ]))
+  ];
+}
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,6 +1,6 @@
-cmake_minimum_required(VERSION 3.15)
+cmake_minimum_required(VERSION 3.21)
 
-find_package(Catch2 REQUIRED)
+find_package(Catch2 REQUIRED CONFIG)
 include(Catch)
 include("${CMAKE_SOURCE_DIR}/misc/cmake/utils.cmake")
 
@@ -40,9 +40,9 @@ target_link_libraries(StitcherTest
   spdlog::spdlog
 )
 
-if(exiv2_FOUND)
+if (exiv-library)
   target_compile_definitions(StitcherTest PRIVATE XPANO_WITH_EXIV2)
-  target_link_libraries(StitcherTest exiv2lib)
+  target_link_libraries(StitcherTest ${exiv-library})
 endif()
 
 if(XPANO_WITH_MULTIBLEND)
diff --git a/xpano/gui/pano_gui.cc b/xpano/gui/pano_gui.cc
diff --git a/xpano/main.cc b/xpano/main.cc
diff --git a/xpano/utils/resource.cc b/xpano/utils/resource.cc
diff --git a/xpano/utils/sdl_.cc b/xpano/utils/sdl_.cc
diff --git a/xpano/utils/sdl_.h b/xpano/utils/sdl_.h

-Original file line number
+Diff line change
 _site
 exiv2/
 Xpano.app
 +.cache