Switch MinGW building to CMake

ISSOtm · ISSOtm · commit a9874892ca89 · 2026-03-25T16:56:28.000+01:00
Automatically grabs and compiles libpng, and avoids having hacky lines in our Makefile
(the compiler specification *should* be orthogonal to the build target!)

Also move the MinGW package install to the `install_deps.sh` script,
to move logic off of the YAML.
diff --git a/.github/scripts/install_deps.sh b/.github/scripts/install_deps.sh
@@ -2,10 +2,34 @@
 # This script requires `sh` instead of `bash` because the latter is not always installed on FreeBSD.
 set -eu
 
-case "${1%-*}" in
+USAGE="Usage: $0 <os> [additional toolset]"
+
+OS="${1:?$USAGE}"
+shift
+TOOLSET="${1-}"
+shift 2>/dev/null || : # That argument is optional.
+if [ $# -ne 0 ]; then
+	echo >&2 "$USAGE"
+	exit 1
+fi
+
+case "${OS%-*}" in
 	ubuntu)
+		pkgs=bison
+		case "$TOOLSET" in
+			mingw32)
+				pkgs="$pkgs dpkg-dev mingw-w64-tools libz-mingw-w64-dev g++-mingw-w64-i686-win32"
+				TOOLSET= ;;
+			mingw64)
+				pkgs="$pkgs dpkg-dev mingw-w64-tools libz-mingw-w64-dev g++-mingw-w64-x86-64-win32"
+				TOOLSET= ;;
+			'' | lcov)
+				pkgs="$pkgs libpng-dev $TOOLSET"
+				TOOLSET= ;;
+		esac
 		sudo apt-get -qq update
-		sudo apt-get install -yq bison libpng-dev pkg-config
+		#shellcheck disable=SC2086 # (This word splitting is intentional.)
+		sudo apt-get install -yq $pkgs
 		;;
 	macos)
 		# macOS bundles GNU Make 3.81, which doesn't support synced output.
@@ -30,6 +54,11 @@ case "${1%-*}" in
 		;;
 esac
 
+if [ -n "$TOOLSET" ]; then
+	printf >&2 'Unknown toolset `%s` for OS `%s`\n' "$TOOLSET" "$OS"
+	exit 1
+fi
+
 echo "PATH=($PATH)" | sed 's/:/\n      /g'
 bison --version
 make --version
diff --git a/.github/workflows/analysis.yml b/.github/workflows/analysis.yml
@@ -10,9 +10,9 @@ jobs:
       - name: Checkout repo
         uses: actions/checkout@v4
       - name: Install deps
-        shell: bash
         run: |
-          ./.github/scripts/install_deps.sh ubuntu-latest
+          bash .github/scripts/install_deps.sh ubuntu-latest
       - name: Static analysis
-        run: | # Silence warnings with too many false positives (https://stackoverflow.com/a/73913076)
+        run:
+          | # Silence warnings with too many false positives (https://stackoverflow.com/a/73913076)
           make -kj CXX=g++-14 CXXFLAGS="-fanalyzer -fanalyzer-verbosity=0 -Wno-analyzer-use-of-uninitialized-value -DNDEBUG" Q=
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -5,17 +5,13 @@ on:
 
 jobs:
   coverage:
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
       - name: Install deps
-        shell: bash
-        run: |
-          ./.github/scripts/install_deps.sh ubuntu
-      - name: Install LCOV
         run: |
-          sudo apt-get install lcov
+          bash .github/scripts/install_deps.sh ubuntu-latest lcov
       - name: Install test dependency dependencies
         shell: bash
         run: |
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -35,9 +35,8 @@ jobs:
       - name: Checkout repo
         uses: actions/checkout@v4
       - name: Install deps
-        shell: bash
         run: |
-          ./.github/scripts/install_deps.sh ${{ matrix.os }}
+          bash ./.github/scripts/install_deps.sh ${{ matrix.os }}
       - name: Build & install using Make
         if: matrix.buildsys == 'make'
         run: |
@@ -175,7 +174,7 @@ jobs:
       - name: Build Windows binaries
         shell: bash
         run: | # ASan seems to be broken on Windows, so we disable it.
-          cmake -S . -B build --preset develop-msvc${{ matrix.bits }} -DFETCHCONTENT_BASE_DIR="${{ env.DEPS_ROOT_DIR }}" -DSANITIZERS=OFF
+          cmake -S . -B build --preset develop-msvc${{ matrix.bits }} -DSANITIZERS=OFF -DFETCHCONTENT_BASE_DIR="${{ env.DEPS_ROOT_DIR }}"
           cmake --build build
       - name: Package binaries
         shell: bash
@@ -222,44 +221,29 @@ jobs:
         bits: [32, 64]
         include:
           - bits: 32
-            arch: i686
             triplet: i686-w64-mingw32
           - bits: 64
-            arch: x86-64
             triplet: x86_64-w64-mingw32
       fail-fast: false
-    runs-on: ubuntu-22.04
-    env:
-      DIST_DIR: win${{ matrix.bits }}
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
       - name: Install deps
-        shell: bash
         run: |
-          ./.github/scripts/install_deps.sh ubuntu
-      - name: Install MinGW
-        run: | # dpkg-dev is apparently required for pkg-config for cross-building
-          sudo apt-get install g++-mingw-w64-${{ matrix.arch }}-win32 mingw-w64-tools libz-mingw-w64-dev dpkg-dev
-      - name: Install libpng dev headers for MinGW
-        run: |
-          ./.github/scripts/mingw-w64-libpng-dev.sh ${{ matrix.triplet }}
+          bash .github/scripts/install_deps.sh ubuntu mingw${{ matrix.bits }}
       - name: Cross-build Windows binaries
-        run: |
-          make mingw${{ matrix.bits }} -kj Q=
+        run: | # ASan and UBSan are not supported on MinGW.
+          cmake -B build --preset develop -DSANITIZERS=OFF -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain-mingw${{ matrix.bits }}.cmake -DFETCHCONTENT_BASE_DIR="${{ env.DEPS_ROOT_DIR }}"
+          cmake --build build
       - name: Package binaries
-        run: | # DLL dependencies can be figured out using e.g. Dependency Walker or objdump -p
-          mkdir bins
-          mv -v rgb{asm,link,fix,gfx}.exe bins/
-          cp -v /usr/${{ matrix.triplet }}/lib/zlib1.dll bins
-          cp -v /usr/${{ matrix.triplet }}/bin/libpng16-16.dll bins
-          cp -v /usr/lib/gcc/${{ matrix.triplet }}/10-win32/lib{ssp-0,stdc++-6}.dll bins
-          [ "${{ matrix.bits }}" -ne 32 ] || cp -v /usr/lib/gcc/${{ matrix.triplet }}/10-win32/libgcc_s_dw2-1.dll bins
+        run: |
+          cmake --install build --prefix . --component runtime --verbose
       - name: Upload Windows binaries
         uses: actions/upload-artifact@v4
         with:
           name: rgbds-canary-mingw-win${{ matrix.bits }}
-          path: bins
+          path: bin
       - name: Upload Windows test binaries
         uses: actions/upload-artifact@v4
         with:
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,6 @@ CMakeCache.txt
 CMakeFiles/
 cmake_install.cmake
 CMakeUserPresets.json
-build/
+build*/
 *.dSYM/
 callgrind.out.*
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -182,6 +182,7 @@ endforeach()
 # We only specify here the package-agnostic options;
 # the rest is rather convention from our side,
 # and thus more appropriate for presets or CLI flags.
+include(CPackComponent)
 ## CPACK_PACKAGE_NAME: copied from `project()`
 set(CPACK_PACKAGE_VENDOR "GBDev")
 set(CPACK_PACKAGE_VERSION "${CMAKE_PROJECT_VERSION}") # The individual components are defined implicitly.
@@ -198,4 +199,11 @@ set(CPACK_THREADS 0) # Use all available CPU cores.
 # Convert our gitignore into regex ignores, for source tarballs.
 # TODO
 set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY OFF) # TODO: source packages don't want this, what about binary ones?
+
+set(CPACK_INSTALL_CMAKE_PROJECTS "${CMAKE_BINARY_DIR};${CMAKE_PROJECT_NAME};runtime;/")
+#set(CPACK_ZIP_COMPONENT_INSTALL ON)
+#cpack_add_component(runtime)
+#cpack_add_component(man)
+#set(CPACK_COMPONENTS_ALL "runtime;man")
+
 include(CPack)
diff --git a/Makefile b/Makefile
@@ -256,22 +256,6 @@ iwyu:
 		CXX="include-what-you-use" \
 		REALCXXFLAGS="-std=c++20 -I include"
 
-# Targets for the project maintainer to easily create Windows exes.
-# This is not for Windows users!
-# If you're building on Windows with Cygwin or MinGW, just follow the Unix
-# install instructions instead.
-
-mingw32:
-	$Q${MAKE} all test/gfx/randtilegen test/gfx/rgbgfx_test \
-		CXX=i686-w64-mingw32-g++ \
-		CXXFLAGS="-O3 -flto -DNDEBUG -static-libgcc -static-libstdc++" \
-		PKG_CONFIG="PKG_CONFIG_SYSROOT_DIR=/usr/i686-w64-mingw32 pkg-config"
-
-mingw64:
-	$Q${MAKE} all test/gfx/randtilegen test/gfx/rgbgfx_test \
-		CXX=x86_64-w64-mingw32-g++ \
-		PKG_CONFIG="PKG_CONFIG_SYSROOT_DIR=/usr/x86_64-w64-mingw32 pkg-config"
-
 wine-shim:
 	$Qecho '#!/usr/bin/env bash' > rgbshim.sh
 	$Qecho 'WINEDEBUG=-all wine $$0.exe "$${@:1}"' >> rgbshim.sh
diff --git a/cmake/toolchain-mingw32.cmake b/cmake/toolchain-mingw32.cmake
@@ -0,0 +1,25 @@
+# From https://www.mingw-w64.org/build-systems/cmake/
+
+set(CMAKE_SYSTEM_NAME Windows)
+set(CMAKE_SYSTEM_PROCESSOR i686)
+
+# specify the cross compiler
+set(CMAKE_C_COMPILER i686-w64-mingw32-gcc)
+set(CMAKE_CXX_COMPILER i686-w64-mingw32-g++)
+set(CMAKE_RC_COMPILER i686-w64-mingw32-windres)
+
+# where is the target environment
+set(CMAKE_FIND_ROOT_PATH /usr/i686-w64-mingw32)
+
+# search for programs in the build host directories
+set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+# for libraries and headers in the target directories
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+
+# TODO: are those *required*?
+#  -static-libgcc -static-libstdc++
+
+# CMake determines how to examine dependencies based on the *host* system, leading to
+# a `file unknown error` unless the target platform is explicitly specified.
+set(CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM "windows+pe")
diff --git a/cmake/toolchain-mingw64.cmake b/cmake/toolchain-mingw64.cmake
@@ -0,0 +1,22 @@
+# From https://www.mingw-w64.org/build-systems/cmake/
+
+set(CMAKE_SYSTEM_NAME Windows)
+set(CMAKE_SYSTEM_PROCESSOR x86_64)
+
+# specify the cross compiler
+set(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc)
+set(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++)
+set(CMAKE_RC_COMPILER x86_64-w64-mingw32-windres)
+
+# where is the target environment
+set(CMAKE_FIND_ROOT_PATH /usr/x86_64-w64-mingw32)
+
+# search for programs in the build host directories
+set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+# for libraries and headers in the target directories
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+
+# CMake determines how to examine dependencies based on the *host* system, leading to
+# a `file unknown error` unless the target platform is explicitly specified.
+set(CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM "windows+pe")
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -109,7 +109,31 @@ set_target_properties(rgbasm rgblink rgbfix rgbgfx PROPERTIES
                       RUNTIME_OUTPUT_DIRECTORY $<1:${CMAKE_SOURCE_DIR}>)
 target_link_libraries(rgbgfx PRIVATE PNG::PNG)
 
-# TARGET_RUNTIME_DLLS was introduced in CMake 3.21.
-if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.21")
-  install(FILES "$<TARGET_RUNTIME_DLLS:rgbgfx>" DESTINATION bin COMPONENT runtime)
+# This is a modified version of the install code generated by
+# `install(TARGETS rgbgfx RUNTIME_DEPENDENCIES)`.
+# Unfortunately, that `install()` is outright not supported when cross-compiling,
+# and working around that has CMake fail to resolve the DLL locations with MinGW,
+# due to not specifying any `DIRECTORIES` and the system search path being ineffective.
+get_target_property(rgbgfx_NAME rgbgfx OUTPUT_NAME)
+if(rgbgfx_NAME STREQUAL "rgbgfx_NAME-NOTFOUND")
+  set(rgbgfx_NAME rgbgfx)
 endif()
+get_target_property(rgbgfx_OUTDIR rgbgfx RUNTIME_OUTPUT_DIRECTORY)
+# TODO: we've only tested this with minGW, but it may not work with other uses of the variable.
+#       Anyonw who knows how to handle this better, feel free to submit a patch!
+set(extra_search_dir "")
+if(DEFINED CMAKE_FIND_ROOT_PATH)
+  set(extra_search_dir "\"${CMAKE_FIND_ROOT_PATH}/bin\"")
+endif()
+install(CODE "\
+file(GET_RUNTIME_DEPENDENCIES
+    RESOLVED_DEPENDENCIES_VAR rgbgfx_deps
+    EXECUTABLES \"${rgbgfx_OUTDIR}/${rgbgfx_NAME}${CMAKE_EXECUTABLE_SUFFIX}\"
+    DIRECTORIES ${extra_search_dir} \"$<TARGET_FILE_DIR:ZLIB::ZLIB>\" \"$<TARGET_FILE_DIR:PNG::PNG>\"
+    PRE_EXCLUDE_REGEXES \"^kernel32\\\\.dll$\" \"^msvcrt\\\\.dll\" \"^api-ms-win-.*\\\\.dll$\"
+  )
+  foreach(rgbgfx_dep IN LISTS rgbgfx_deps)
+    file(INSTALL DESTINATION \"$<INSTALL_PREFIX>/${CMAKE_INSTALL_BINDIR}\" TYPE SHARED_LIBRARY FILES \${rgbgfx_dep}
+      FOLLOW_SYMLINK_CHAIN)
+  endforeach()"
+        COMPONENT runtime)
