Merge branch 'master' into dsda-custom-skill

Author: andrikpowell

.github/workflows/continuous_integration.yml

@@ -158,6 +158,7 @@ jobs:
           cmake -S prboom2
           -B build
           -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }}
+          -DSTRICT_FIND=ON
           ${{ matrix.config.extra_options }}
 
       - name: Build

prboom2/CMakeLists.txt

@@ -7,15 +7,18 @@ include(DsdaDepsSetup)
 
 project("dsda-doom" VERSION 0.29.3)
 
-# Set a default build type if none was specified
-set(default_build_type "RelWithDebInfo")
-if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-  message(STATUS "Setting build type to '${default_build_type}' as none was specified.")
-  set(CMAKE_BUILD_TYPE "${default_build_type}" CACHE
-      STRING "Choose the type of build." FORCE)
-  # Set the possible values of build type for cmake-gui
-  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
-    "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+set(dsda_is_top_project FALSE)
+if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+    set(dsda_is_top_project TRUE)
+endif()
+
+if(dsda_is_top_project)
+    include(DsdaSanitiser)
+endif()
+
+include(DsdaHelpers)
+if(dsda_is_top_project)
+    dsda_set_default_build_config(RelWithDebInfo)
 endif()
 
 if(VCPKG_TOOLCHAIN)
@@ -28,77 +31,7 @@ set(PROJECT_STRING "${PROJECT_NAME} ${PROJECT_VERSION}")
 
 include(DsdaOptions)
 include(DsdaTargetFeatures)
-
-include(PkgConfigHelper)
-
-set(OpenGL_GL_PREFERENCE LEGACY)
-find_package(OpenGL 2.0 REQUIRED)
-find_package(libzip REQUIRED)
-find_package(SDL2 2.0.7 REQUIRED)
-find_package(SDL2_mixer REQUIRED)
-find_package(ZLIB REQUIRED)
-find_package(SndFile 1.0.29 REQUIRED)
-
-if(NOT TARGET SDL2_mixer::SDL2_mixer)
-    add_library(SDL2_mixer::SDL2_mixer ALIAS SDL2_mixer::SDL2_mixer-static)
-endif()
-
-if(SndFile_VERSION VERSION_GREATER_EQUAL "1.1.0")
-   set(HAVE_SNDFILE_MPEG TRUE)
-endif()
-
-if(WITH_IMAGE)
-    find_package(SDL2_image)
-    if(SDL2_image_FOUND)
-        set(HAVE_LIBSDL2_IMAGE TRUE)
-        if(NOT TARGET SDL2_image::SDL2_image)
-            add_library(SDL2_image::SDL2_image ALIAS SDL2_image::SDL2_image-static)
-        endif()
-    endif()
-endif()
-
-if(WITH_MAD)
-    find_package(LibMad)
-    if(LibMad_FOUND)
-        set(HAVE_LIBMAD TRUE)
-    endif()
-endif()
-
-if(WITH_FLUIDSYNTH)
-    find_package(FluidSynth)
-    if(FluidSynth_FOUND)
-        set(HAVE_LIBFLUIDSYNTH TRUE)
-    endif()
-endif()
-
-if(WITH_XMP)
-    find_package(libxmp)
-    if(libxmp_FOUND)
-        set(HAVE_LIBXMP TRUE)
-        if(NOT TARGET libxmp::xmp)
-            if(TARGET libxmp::xmp_shared)
-                add_library(libxmp::xmp ALIAS libxmp::xmp_shared)
-            else()
-                add_library(libxmp::xmp ALIAS libxmp::xmp_static)
-            endif()
-        endif()
-    endif()
-endif()
-
-if(WITH_VORBISFILE)
-    find_package(Vorbis COMPONENTS File)
-    if(Vorbis_File_FOUND)
-        set(HAVE_LIBVORBISFILE TRUE)
-    endif()
-endif()
-
-if(WITH_PORTMIDI)
-    find_package(PortMidi)
-    if(PortMidi_FOUND)
-        set(HAVE_LIBPORTMIDI TRUE)
-    endif()
-endif()
-
+include(DsdaDependencies)
 include(DsdaConfigHeader)
 
 set(DSDA_OUTPUT_PATH ${CMAKE_BINARY_DIR})
@@ -147,91 +80,6 @@ install(FILES
     DESTINATION "${DSDA_INSTALL_COPYRIGHT_DIR}"
 )
 
-if(WIN32)
-    set(CPACK_GENERATOR ZIP)
-elseif(LINUX)
-    set(CPACK_GENERATOR External)
-    set(CPACK_EXTERNAL_ENABLE_STAGING YES)
-    set(CPACK_PACKAGING_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
-    set(CPACK_EXTERNAL_PACKAGE_SCRIPT "${PROJECT_BINARY_DIR}/appimage-generate.cmake")
-
-    file(GENERATE
-        OUTPUT "${PROJECT_BINARY_DIR}/appimage-generate.cmake"
-        CONTENT [[
-            find_program(LINUXDEPLOY_EXECUTABLE
-                NAMES linuxdeploy linuxdeploy-x86_64.AppImage
-                PATHS ${CPACK_PACKAGE_DIRECTORY}/linuxdeploy)
-
-            if(NOT LINUXDEPLOY_EXECUTABLE)
-                message(STATUS "Downloading linuxdeploy")
-                set(LINUXDEPLOY_EXECUTABLE ${CPACK_PACKAGE_DIRECTORY}/linuxdeploy/linuxdeploy)
-                file(DOWNLOAD
-                    https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage
-                    ${LINUXDEPLOY_EXECUTABLE}
-                    INACTIVITY_TIMEOUT 10)
-                execute_process(COMMAND
-                    chmod +x ${LINUXDEPLOY_EXECUTABLE} COMMAND_ECHO STDOUT)
-            endif()
-
-            execute_process(COMMAND
-                ${CMAKE_COMMAND} -E env
-                OUTPUT=${CPACK_PACKAGE_FILE_NAME}.appimage
-                VERSION=$<IF:$<BOOL:${CPACK_PACKAGE_VERSION}>,${CPACK_PACKAGE_VERSION},0.1.0>
-                ${LINUXDEPLOY_EXECUTABLE}
-                --appimage-extract-and-run
-                --appdir=${CPACK_TEMPORARY_DIRECTORY}
-                --executable=$<TARGET_FILE:dsda-doom>
-                --desktop-file=${CPACK_TEMPORARY_DIRECTORY}/${CPACK_PACKAGING_INSTALL_PREFIX}/share/applications/dsda-doom.desktop
-                --icon-file=${CPACK_TEMPORARY_DIRECTORY}/${CPACK_PACKAGING_INSTALL_PREFIX}/share/icons/hicolor/scalable/apps/dsda-doom.svg
-                --output=appimage)
-            ]])
-elseif(APPLE)
-    set(CPACK_GENERATOR External)
-    set(CPACK_EXTERNAL_ENABLE_STAGING YES)
-    set(CPACK_PACKAGING_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
-    set(CPACK_EXTERNAL_PACKAGE_SCRIPT "${PROJECT_BINARY_DIR}/macbundle-generate.cmake")
-    set(CPACK_SYSTEM_NAME "mac-${CMAKE_SYSTEM_PROCESSOR}")
-    set(CPACK_SYSTEM_PROCESSOR "${CMAKE_SYSTEM_PROCESSOR}")
-    set(CPACK_BUILD_DIR "${PROJECT_BINARY_DIR}")
-
-    file(GENERATE
-        OUTPUT "${PROJECT_BINARY_DIR}/macbundle-generate.cmake"
-        CONTENT [[
-            set(CPACK_OUTPUT_DIR "${CPACK_BUILD_DIR}/${CPACK_PACKAGE_FILE_NAME}")
-            file(MAKE_DIRECTORY ${CPACK_OUTPUT_DIR})
-
-            find_program(DYLIBBUNDLER_EXECUTABLE NAMES dylibbundler)
-            if(NOT DYLIBBUNDLER_EXECUTABLE)
-                message(FATAL_ERROR "Missing dylibbundler (brew install dylibbundler)")
-            endif()
-
-            file(COPY_FILE
-                $<TARGET_FILE:dsda-doom>
-                ${CPACK_OUTPUT_DIR}/dsda-doom)
-
-            execute_process(COMMAND
-                ${CMAKE_COMMAND} -E env
-                OUTPUT=${CPACK_PACKAGE_FILE_NAME}.zip
-                VERSION=$<IF:$<BOOL:${CPACK_PACKAGE_VERSION}>,${CPACK_PACKAGE_VERSION},0.1.0>
-                ${DYLIBBUNDLER_EXECUTABLE}
-                --bundle-deps
-                --create-dir
-                --fix-file ${CPACK_OUTPUT_DIR}/dsda-doom
-                --install-path @executable_path/libs_${CPACK_SYSTEM_PROCESSOR}
-                --dest-dir ${CPACK_OUTPUT_DIR}/libs_${CPACK_SYSTEM_PROCESSOR})
-
-            file(COPY_FILE
-                ${CPACK_TEMPORARY_DIRECTORY}/${CPACK_PACKAGING_INSTALL_PREFIX}/share/games/doom/dsda-doom.wad
-                ${CPACK_OUTPUT_DIR}/dsda-doom.wad)
-            file(COPY_FILE
-                ${CPACK_TEMPORARY_DIRECTORY}/${CPACK_PACKAGING_INSTALL_PREFIX}/share/doc/dsda-doom/COPYING
-                ${CPACK_OUTPUT_DIR}/COPYING.txt)
-
-            file(CONFIGURE
-                OUTPUT ${CPACK_OUTPUT_DIR}/Troubleshooting.txt
-                CONTENT "If you are getting errors like 'libzip.5.5.dylib cant be opened because Apple cannot check it for malicious software.' Run the following command in the dsda-doom folder:\n\nxattr -dr com.apple.quarantine path/to/folder")
-
-            execute_process(COMMAND zip -r ${CPACK_PACKAGE_FILE_NAME}.zip ${CPACK_PACKAGE_FILE_NAME})
-            ]])
+if(ENABLE_PACKAGING)
+    add_subdirectory(packaging)
 endif()
-include(CPack)

prboom2/cmake/DsdaDependencies.cmake

@@ -0,0 +1,151 @@
+include_guard()
+
+if(STRICT_FIND)
+  set(dsda_strict_keyword)
+  if(CMAKE_VERSION VERSION_GREATER_EQUAL 4.1)
+    set(CMAKE_FIND_REQUIRED ON)
+  else()
+    set(dsda_strict_keyword REQUIRED)
+  endif()
+endif()
+
+# TODO: Move away from including this module this way
+include(PkgConfigHelper)
+
+add_library(dsda_dependencies INTERFACE IMPORTED)
+add_library(dsda::dependencies ALIAS dsda_dependencies)
+
+# Make sure OpenGL.framework is found, XQuartz may show up first and only supports GL 1.4
+if(APPLE)
+  set(find_framework_backup ${CMAKE_FIND_FRAMEWORK})
+  set(CMAKE_FIND_FRAMEWORK ONLY)
+endif()
+
+set(OpenGL_GL_PREFERENCE LEGACY)
+find_package(OpenGL 2.0 REQUIRED)
+
+if(APPLE)
+  set(CMAKE_FIND_FRAMEWORK ${find_framework_backup})
+endif()
+
+find_package(SDL2 2.0.12 CONFIG REQUIRED)
+find_package(SDL2_mixer REQUIRED)
+find_package(SndFile 1.0.29 REQUIRED)
+find_package(ZLIB REQUIRED)
+find_package(libzip REQUIRED)
+
+if(SndFile_VERSION VERSION_GREATER_EQUAL "1.1.0")
+   set(HAVE_SNDFILE_MPEG TRUE)
+endif()
+
+if(WITH_IMAGE)
+  find_package(SDL2_image ${dsda_strict_keyword})
+  if(SDL2_image_FOUND)
+    set(HAVE_LIBSDL2_IMAGE TRUE)
+  endif()
+endif()
+
+if(WITH_MAD)
+  find_package(mad ${dsda_strict_keyword})
+  if(mad_FOUND)
+    set(HAVE_LIBMAD TRUE)
+  endif()
+endif()
+
+if(WITH_FLUIDSYNTH)
+  find_package(FluidSynth ${dsda_strict_keyword})
+  if(FluidSynth_FOUND)
+    set(HAVE_LIBFLUIDSYNTH TRUE)
+  endif()
+endif()
+
+if(WITH_XMP)
+  find_package(libxmp ${dsda_strict_keyword})
+  if(libxmp_FOUND)
+    set(HAVE_LIBXMP TRUE)
+  endif()
+endif()
+
+if(WITH_VORBISFILE)
+  find_package(Vorbis COMPONENTS File ${dsda_strict_keyword})
+  if(Vorbis_File_FOUND)
+    set(HAVE_LIBVORBISFILE TRUE)
+  endif()
+endif()
+
+if(WITH_PORTMIDI)
+  find_package(PortMidi ${dsda_strict_keyword})
+  if(PortMidi_FOUND)
+    set(HAVE_LIBPORTMIDI TRUE)
+  endif()
+endif()
+
+# Before SDL 2.24.x, all SDL2::* targets were created in autotools builds, even if the underlying library wasn't built.
+# So wrap all this in our interface library
+add_library(dsda_SDL2 INTERFACE IMPORTED)
+add_library(dsda::SDL2 ALIAS dsda_SDL2)
+
+if(TARGET SDL2::SDL2main)
+  get_target_property(sdl2_main_library SDL2::SDL2main LOCATION)
+  if(EXISTS ${sdl2_main_library})
+    target_link_libraries(dsda_SDL2 INTERFACE SDL2::SDL2main)
+  endif()
+endif()
+
+if(TARGET SDL2::SDL2)
+  get_target_property(sdl2_library SDL2::SDL2 LOCATION)
+endif()
+if(TARGET SDL2::SDL2-static)
+  get_target_property(sdl2_static_library SDL2::SDL2-static LOCATION)
+endif()
+
+if(EXISTS ${sdl2_library})
+  target_link_libraries(dsda_SDL2 INTERFACE SDL2::SDL2)
+elseif(EXISTS ${sdl2_static_library})
+  target_link_libraries(dsda_SDL2 INTERFACE SDL2::SDL2-static)
+else()
+  message(FATAL_ERROR "Neither '${sdl2_library}' or '${sdl2_static_library}' exist, your SDL installation may be broken.")
+endif()
+
+# TODO: Rework libxmp's find module to avoid this workaround
+add_library(dsda_xmp INTERFACE IMPORTED)
+add_library(dsda::xmp ALIAS dsda_xmp)
+
+if(HAVE_LIBXMP)
+  if(TARGET libxmp::xmp)
+    target_link_libraries(dsda_xmp INTERFACE libxmp::xmp)
+  else()
+    target_link_libraries(dsda_xmp
+      INTERFACE
+      $<IF:$<TARGET_EXISTS:libxmp::xmp_shared>,libxmp::xmp_shared,libxmp::xmp_static>
+    )
+  endif()
+endif()
+
+target_link_libraries(dsda_dependencies
+  INTERFACE
+  OpenGL::GL
+  OpenGL::GLU
+  SndFile::sndfile
+  libzip::zip
+  ZLIB::ZLIB
+
+  dsda::xmp
+  $<$<BOOL:${HAVE_LIBMAD}>:mad::mad>
+  $<$<BOOL:${HAVE_LIBFLUIDSYNTH}>:FluidSynth::libfluidsynth>
+  $<$<BOOL:${HAVE_LIBVORBISFILE}>:Vorbis::vorbisfile>
+  $<$<BOOL:${HAVE_LIBPORTMIDI}>:PortMidi::portmidi>
+
+  $<$<BOOL:${HAVE_LIBSDL2_IMAGE}>:$<IF:$<TARGET_EXISTS:SDL2_image::SDL2_image>,SDL2_image::SDL2_image,SDL2_image::SDL2_image-static>>
+  $<IF:$<TARGET_EXISTS:SDL2_mixer::SDL2_mixer>,SDL2_mixer::SDL2_mixer,SDL2_mixer::SDL2_mixer-static>
+
+  dsda::SDL2
+)
+
+if(WIN32)
+  target_link_libraries(dsda_dependencies
+    INTERFACE
+    winmm
+    comctl32
+  )
+endif()

prboom2/cmake/DsdaHelpers.cmake

@@ -5,3 +5,24 @@ function(dsda_fail_if_invalid_target tgt)
     message(FATAL_ERROR "${tgt} is not a valid CMake target.")
   endif()
 endfunction()
+
+function(dsda_set_default_build_config build_config)
+  get_cmake_property(is_multi_config GENERATOR_IS_MULTI_CONFIG)
+  if(NOT is_multi_config AND NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE "${build_config}"
+      CACHE STRING "Build configuration"
+      FORCE
+    )
+    set_property(
+      CACHE CMAKE_BUILD_TYPE
+      PROPERTY STRINGS
+      "Debug" "Release" "MinSizeRel" "RelWithDebInfo"
+    )
+  elseif(CMAKE_GENERATOR STREQUAL "Ninja Multi-Config")
+    if(build_config IN_LIST CMAKE_CONFIGURATION_TYPES)
+      set(CMAKE_DEFAULT_BUILD_TYPE ${build_config})
+    else()
+      message(AUTHOR_WARNING "${build_config} is not a known config type.")
+    endif()
+  endif()
+endfunction()

prboom2/cmake/DsdaOptions.cmake

@@ -16,6 +16,8 @@ set(DOOMWADDIR "${CMAKE_INSTALL_PREFIX}/${default_wad_dir}" CACHE PATH "Path to
 set(DSDA_INSTALL_COPYRIGHT_DIR "${default_copyright_dir}" CACHE STRING "Destination of the copyright file")
 set(DSDA_INSTALL_BINDIR "${default_bin_dir}" CACHE STRING "Destination of the dsda-doom binary")
 
+option(ENABLE_PACKAGING "Enable creating CPack packages" ${dsda_is_top_project})
+option(STRICT_FIND "Fail configuration if an optional dependency is not found" OFF)
 option(SIMPLECHECKS "Enable checks which only impose significant overhead if a posible error is detected" ON)
 option(RANGECHECK "Enable internal range checking" OFF)