CMake Refactor

CMakeLists.txt

@@ -31,27 +31,20 @@
 #   make
 #
 
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.14)
 
 ## Project name to use as command prefix.
 
 project(SUPERTUX)
 
-
 ### CMake configuration
 
-if(COMMAND cmake_policy)
-  cmake_policy(SET CMP0003 NEW)
-  cmake_policy(SET CMP0008 NEW)
-  cmake_policy(SET CMP0023 NEW)
-endif()
-
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
+# Stop CMake from whining about 3.5 or future versions that other FindXXXXX.cmake files (seen from vcpkg) use
+set(CMAKE_WARN_DEPRECATED OFF CACHE BOOL "" FORCE)
 
-# This should be set only with windows Visual Studio generator builds
-string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" PLATFORM)
 if(${PLATFORM} MATCHES "arm64")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /D_ARM64_ /DMY_CPU_LE")
   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /D_ARM64_ /DMY_CPU_LE")
@@ -69,16 +62,9 @@ set(APPDATADIR "${CMAKE_INSTALL_PREFIX}/share/games/supertux2")
 set(BUILD_DATA_DIR "${CMAKE_CURRENT_SOURCE_DIR}/data")
 set(BUILD_CONFIG_DATA_DIR "${CMAKE_BINARY_DIR}/data")
 
-## Check endianess
-if(NOT EMSCRIPTEN)
-  # FIXME: Any reason why we need this?
-  include(TestBigEndian)
-  test_big_endian(WORDS_BIGENDIAN)
-endif()
-
 ## Add definitions
 if(CMAKE_BUILD_TYPE MATCHES "Release|RelWithDebInfo")
-  add_definitions(-DRELEASE)
+  add_definitions(-DRELEASE) # FIXME Unnecessary?
 elseif(CMAKE_BUILD_TYPE MATCHES Debug)
   add_definitions(-DDEBUG)
 endif()
@@ -101,22 +87,9 @@ else()
 endif()
 
 if(EMSCRIPTEN)
-  set(CMAKE_EXECUTABLE_SUFFIX .html)
-  set(IS_EMSCRIPTEN_BUILD ON)
-
-  set(EM_USE_FLAGS "-sDISABLE_EXCEPTION_CATCHING=0")
-  set(EM_LINK_FLAGS " -sINITIAL_MEMORY=134217728 -sALLOW_MEMORY_GROWTH=1 -sMAXIMUM_MEMORY=536870912 -sERROR_ON_UNDEFINED_SYMBOLS=0 --preload-file ${BUILD_CONFIG_DATA_DIR} --use-preload-plugins -lidbfs.js")
-  if(CMAKE_BUILD_TYPE MATCHES Debug)
-    set(EM_USE_FLAGS "${EM_USE_FLAGS} -fsanitize=undefined")
-    set(EM_LINK_FLAGS "${EM_LINK_FLAGS} -fsanitize=undefined -sSAFE_HEAP=1 -sASSERTIONS=1 -sDEMANGLE_SUPPORT=1")
-  endif()
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${EM_USE_FLAGS}")
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EM_USE_FLAGS}")
-  set(CMAKE_LINKER_FLAGS "${CMAKE_LINKER_FLAGS} ${EM_USE_FLAGS} ${EM_LINK_FLAGS}")
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_LINKER_FLAGS} ${EM_USE_FLAGS} ${EM_LINK_FLAGS}")
+  include(SuperTux/Emscripten)
 endif()
 
-# TODO: Add " OR ANDROID OR IOS" to this
 if(EMSCRIPTEN OR UBUNTU_TOUCH OR ANDROID)
   option(REMOVE_QUIT_BUTTON "Remove the option to quit the game (useful on mobile devices)" ON)
 else()
@@ -167,21 +140,28 @@ if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
 endif()
 
 ## Add lots of dependencies to compiler switches
-include(SuperTux/ProvideGlm)
-include(SuperTux/ProvideFmt)
-include(SuperTux/ProvideSDL2)
-include(SuperTux/ProvideOpenAL)
-include(SuperTux/ProvideOggVorbis)
-include(SuperTux/ProvidePhysfs)
-include(SuperTux/ProvideCurl)
+include(SuperTux/AddPackage)
+
+# Find dependencies
+add_package(TARGET SDL2 PKG SDL2 PKG_USE SDL2::SDL2 CONFIG REQUIRED PKG_CONFIG sdl2)
+add_package(TARGET SDL2_image PKG SDL2_image PKG_USE SDL2_image::SDL2_image CONFIG REQUIRED PKG_CONFIG sdl2_image)
+add_package(TARGET SDL2_ttf PKG SDL2_ttf PKG_USE SDL2_ttf::SDL2_ttf CONFIG REQUIRED PKG_CONFIG sdl2_ttf)
+add_package(TARGET CURL PKG CURL PKG_USE CURL::libcurl PKG_CONFIG libcurl)
+add_package(TARGET OpenAL PKG OpenAL PKG_USE OpenAL::OpenAL CONFIG REQUIRED PKG_CONFIG OpenAL)
+add_package(TARGET Ogg PKG Ogg PKG_USE Ogg::ogg CONFIG REQUIRED PKG_CONFIG ogg)
+add_package(TARGET Vorbis PKG Vorbis PKG_USE Vorbis::vorbis CONFIG REQUIRED PKG_CONFIG vorbis)
+add_package(TARGET VorbisFile PKG Vorbis PKG_USE Vorbis::vorbisfile CONFIG REQUIRED PKG_CONFIG vorbisfile)
+add_package(TARGET glm PKG glm PKG_USE glm::glm CONFIG REQUIRED PKG_CONFIG glm)
+add_package(TARGET fmt PKG fmt PKG_USE fmt::fmt CONFIG REQUIRED PKG_CONFIG fmt)
+add_package(TARGET PhysFS PKG PhysFS PKG_USE PhysFS::PhysFS CONFIG REQUIRED PKG_CONFIG physfs PROVIDES ProvidePhysfs)
+
+include(SuperTux/ProvideSavePNG)
 include(SuperTux/ProvideSimpleSquirrel)
-include(SuperTux/ProvideTinygettext)
-include(SuperTux/ProvideSDL2_ttf)
 include(SuperTux/ProvideDiscord)
 include(SuperTux/ProvideSexpcpp)
-include(SuperTux/ProvideSavePNG)
 include(SuperTux/ProvidePartioZip)
 include(SuperTux/ProvideOpenGL)
+include(SuperTux/ProvideTinygettext)
 
 ## Build stuff
 include(SuperTux/BuildVersion)
@@ -204,89 +184,87 @@ list(SORT SUPERTUX_SOURCES_C)
 list(SORT SUPERTUX_SOURCES_CXX)
 list(SORT SUPERTUX_RESOURCES)
 
-## On Windows, add an icon
-if(WIN32)
-  if(MINGW)
-    add_custom_command(
-      OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/supertux_rc.o
-      COMMAND ${CMAKE_RC_COMPILER} -I${CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons -i${CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons/supertux.rc -o ${CMAKE_CURRENT_BINARY_DIR}/supertux_rc.o)
-    set(SUPERTUX_SOURCES_C ${SUPERTUX_SOURCES_C} ${CMAKE_CURRENT_BINARY_DIR}/supertux_rc.o)
-  endif()
-endif()
-
 include(SuperTux/CompileAmalgation)
 
 ## Generate supertux executable in the right place
-
+# Is this needed? - Swagtoy
 #set(EXECUTABLE_OUTPUT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
-set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR})
+#set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR})
 
 ## Add target for supertux binary
 
-add_library(supertux2_c OBJECT ${SUPERTUX_SOURCES_C})
-add_library(supertux2_lib STATIC ${CMAKE_BINARY_DIR}/version.h ${SUPERTUX_SOURCES_CXX} ${SUPERTUX_RESOURCES} $<TARGET_OBJECTS:supertux2_c>)
-target_include_directories(supertux2_lib PUBLIC ${CMAKE_BINARY_DIR} src/)
+add_executable(supertux2 WIN32 ${CMAKE_BINARY_DIR}/version.h ${SUPERTUX_SOURCES_C} ${SUPERTUX_SOURCES_CXX} ${SUPERTUX_RESOURCES} src/main.cpp)
+# TODO Is this even needed?
+# $<$<BOOL:WIN32>:{CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons/supertux.rc>
+target_include_directories(supertux2 PUBLIC ${CMAKE_BINARY_DIR} src/)
 
-if(WIN32)
-  add_executable(supertux2 WIN32 src/main.cpp ${CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons/supertux.rc)
-  target_link_libraries(supertux2 LibSDL2main)
-else()
-  add_executable(supertux2 src/main.cpp)
-endif()
-target_link_libraries(supertux2 supertux2_lib)
-
-set_target_properties(supertux2_lib PROPERTIES OUTPUT_NAME supertux2_lib)
-set_target_properties(supertux2_lib PROPERTIES COMPILE_FLAGS "${SUPERTUX2_EXTRA_WARNING_FLAGS}")
-if(EMSCRIPTEN)
-  target_link_options(supertux2 PUBLIC -sEXPORTED_FUNCTIONS=['_main','_set_resolution','_save_config','_onDownloadProgress','_onDownloadFinished','_onDownloadError','_onDownloadAborted','_getExceptionMessage'] PUBLIC -sEXPORTED_RUNTIME_METHODS=['ccall','cwrap'])
-endif()
+set_target_properties(supertux2 PROPERTIES OUTPUT_NAME "supertux2")
+set_target_properties(supertux2 PROPERTIES COMPILE_FLAGS "${SUPERTUX2_EXTRA_WARNING_FLAGS}")
 
-if(WIN32 AND NOT VCPKG_BUILD)
-if(NOT MINGW)
+#if(WIN32 AND NOT VCPKG_BUILD)
+#if(NOT MINGW)
   ## Copy dlls on windows
-  add_custom_command(TARGET supertux2_lib POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E copy_directory
-    "${DEPENDENCY_FOLDER}/dll"
-    $<TARGET_FILE_DIR:supertux2_lib>)
-endif()
-endif()
+#  add_custom_command(TARGET supertux2_lib POST_BUILD
+#    COMMAND ${CMAKE_COMMAND} -E copy_directory
+#    "${DEPENDENCY_FOLDER}/dll"
+#    $<TARGET_FILE_DIR:supertux2_lib>)
+#endif()
+#endif()
 
 ## Some additional include paths
-target_include_directories(supertux2_lib SYSTEM PUBLIC
+target_include_directories(supertux2 SYSTEM PUBLIC
   external/findlocale/
   external/obstack/
   )
 
+
 # Include altivec wrapper on ppc
 if(CMAKE_SYSTEM_PROCESSOR MATCHES "^ppc.*")
-  target_include_directories(supertux2_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src/ppc)
+  target_include_directories(supertux2 PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src/ppc)
 endif()
 
+# Linking fixes
+set_source_files_properties(external/findlocale/findlocale.c PROPERTIES COMPILE_FLAGS -fPIE)
+set_source_files_properties(external/obstack/obstack.c PROPERTIES COMPILE_FLAGS -fPIE)
+set_target_properties(LibSavePNG PROPERTIES POSITION_INDEPENDENT_CODE ON)
+
 ## Link supertux binary with squirrel and other libraries
 
-target_link_libraries(supertux2_lib PUBLIC LibSimpleSquirrel)
-target_link_libraries(supertux2_lib PUBLIC LibTinygettext)
-target_link_libraries(supertux2_lib PUBLIC LibSexp)
-target_link_libraries(supertux2_lib PUBLIC LibSavePNG)
-target_link_libraries(supertux2_lib PUBLIC LibPartioZip)
-target_link_libraries(supertux2_lib PUBLIC LibOpenAL)
-target_link_libraries(supertux2_lib PUBLIC LibGlm)
-target_link_libraries(supertux2_lib PUBLIC LibFmt)
-target_link_libraries(supertux2_lib PUBLIC LibPhysfs)
+target_link_libraries(supertux2 PUBLIC LibSimpleSquirrel)
+target_link_libraries(supertux2 PUBLIC LibTinygettext)
+target_link_libraries(supertux2 PUBLIC LibSexp)
+target_link_libraries(supertux2 PUBLIC LibSavePNG)
+target_link_libraries(supertux2 PUBLIC LibPartioZip)
+target_link_libraries(supertux2 PUBLIC OpenAL)
+target_link_libraries(supertux2 PUBLIC glm)
+target_compile_definitions(supertux2 PUBLIC GLM_ENABLE_EXPERIMENTAL)
+target_link_libraries(supertux2 PUBLIC fmt)
+target_link_libraries(supertux2 PUBLIC PhysFS)
 
 if(NOT EMSCRIPTEN)
-  target_link_libraries(supertux2_lib PUBLIC LibSDL2_ttf)
-  target_link_libraries(supertux2_lib PUBLIC LibSDL2 LibSDL2_image)
-  target_link_libraries(supertux2_lib PUBLIC LibOggVorbis)
-  target_link_libraries(supertux2_lib PUBLIC LibCurl)
+  target_link_libraries(supertux2 PUBLIC
+      # SDL2_image
+      SDL2_image
+	  # SDL2_ttf
+	  SDL2_ttf
+	  # SDL2 main (windows?)
+	  $<TARGET_NAME_IF_EXISTS:SDL2::SDL2main>
+	  # SDL2
+      SDL2)
+  target_link_libraries(supertux2 PUBLIC
+  	Ogg
+	Vorbis
+	VorbisFile
+  )
+  target_link_libraries(supertux2 PUBLIC CURL::libcurl)
 endif()
 
 if(HAVE_OPENGL)
-  target_link_libraries(supertux2_lib PUBLIC LibOpenGL)
+  target_link_libraries(supertux2 PUBLIC LibOpenGL)
 endif()
 
 if(ENABLE_DISCORD)
-  target_link_libraries(supertux2_lib PUBLIC LibDiscord)
+  target_link_libraries(supertux2 PUBLIC LibDiscord)
 endif()
 
 ## Install stuff
@@ -296,7 +274,12 @@ include(SuperTux/BuildInstall)
 configure_file(config.h.cmake ${CMAKE_BINARY_DIR}/config.h )
 
 ## Build tests
-include(SuperTux/BuildTests)
+# TODO Move to CMake Tests
+#include(SuperTux/BuildTests)
+option(BUILD_TESTS "Build tests" OFF)
+if(BUILD_TESTS)
+	add_subdirectory(tests)
+endif()
 
 ## CPack/Installation-specific stuff
 include(SuperTux/BuildCPack)

INSTALL.md

@@ -106,12 +106,12 @@ For ease of use, here are some installation lines for some Linux distributions:
 
 - Ubuntu 18.04/20.04:
   ```
-  sudo apt-get update && sudo apt-get install -y cmake build-essential libogg-dev libvorbis-dev libopenal-dev libsdl2-dev libsdl2-image-dev libfreetype6-dev libraqm-dev libcurl4-openssl-dev libglew-dev libharfbuzz-dev libfribidi-dev libglm-dev zlib1g-dev
+  sudo apt-get update && sudo apt-get install -y cmake build-essential libogg-dev libvorbis-dev libopenal-dev libsdl2-dev libsdl2-image-dev libfreetype6-dev libraqm-dev libcurl4-openssl-dev libglew-dev libharfbuzz-dev libfribidi-dev libglm-dev zlib1g-dev libfmt-dev libsdl2-ttf-dev libphysfs-dev
   ```
 
 - ArchLinux (using sudo, as of August 28th 2024)
   ```
-  sudo pacman -S cmake base-devel libogg libvorbis openal sdl2 sdl2_image freetype2 libraqm curl openssl glew harfbuzz fribidi glm zlib
+  sudo pacman -S cmake base-devel libogg libvorbis openal sdl2 sdl2_image sdl2_ttf freetype2 libraqm curl openssl glew harfbuzz fribidi glm zlib fmt physfs
   ```
 
 ### Linux/UNIX using CMake

mk/cmake/Emscripten.cmake

@@ -0,0 +1,15 @@
+set(CMAKE_EXECUTABLE_SUFFIX .html)
+set(IS_EMSCRIPTEN_BUILD ON)
+
+set(EM_USE_FLAGS "-sDISABLE_EXCEPTION_CATCHING=0")
+set(EM_LINK_FLAGS " -sINITIAL_MEMORY=134217728 -sALLOW_MEMORY_GROWTH=1 -sMAXIMUM_MEMORY=536870912 -sERROR_ON_UNDEFINED_SYMBOLS=0 --preload-file ${BUILD_CONFIG_DATA_DIR} --use-preload-plugins -lidbfs.js")
+if(CMAKE_BUILD_TYPE MATCHES Debug)
+  set(EM_USE_FLAGS "${EM_USE_FLAGS} -fsanitize=undefined")
+  set(EM_LINK_FLAGS "${EM_LINK_FLAGS} -fsanitize=undefined -sSAFE_HEAP=1 -sASSERTIONS=1 -sDEMANGLE_SUPPORT=1")
+endif()
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${EM_USE_FLAGS}")
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EM_USE_FLAGS}")
+set(CMAKE_LINKER_FLAGS "${CMAKE_LINKER_FLAGS} ${EM_USE_FLAGS} ${EM_LINK_FLAGS}")
+set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_LINKER_FLAGS} ${EM_USE_FLAGS} ${EM_LINK_FLAGS}")
+
+target_link_options(supertux2 PUBLIC -sEXPORTED_FUNCTIONS=['_main','_set_resolution','_save_config','_onDownloadProgress','_onDownloadFinished','_onDownloadError','_onDownloadAborted','_getExceptionMessage'] PUBLIC -sEXPORTED_RUNTIME_METHODS=['ccall','cwrap'])

mk/cmake/SuperTux/AddPackage.cmake

@@ -0,0 +1,83 @@
+# AddPackage.cmake - Portable find_package approach
+#
+# Copyright (C) 2024 Hyland B. <[email protected]>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+
+# This monstrosity essentially adds a complex package wrapping
+# function, but it's honestly impressive. It essentially tries to
+# default to find_package, however, this may not always work,
+# especially on *NIX machines or anything weird like that. So, being
+# clever, it then tries to go to PkgConfig, which (generally speaking)
+# tends to produce more accurate results on *NIX
+# machines. Unfortunately, this may not always work (and sometimes by
+# design), so then it finally falls back to Supertux's old, weird
+# Provide files. And if that fails, then that means the package
+# doesn't exist or wasn't installed.
+
+# Usage:
+#
+#   add_package(TARGET SDL2  <-- The output target, a "target alias" (sometimes)
+#      PKG SDL2              <-- The find_package package, in this case it gets SDL2
+#                                 (might look similar to the output target)
+#      PKG_USE SDL2::SDL2    <-- Specific target from the package we want to alias
+#      CONFIG                <-- (optional) Passed to find_package if its a CONFIG
+#      REQUIRED              <-- (optional) NOT passed to find_package, just a check to
+#                                  throw an error if we've exhausted all options.
+#      PKG_CONFIG sdl2 sdl2_ttf   <-- (optional, recommended) List of packages for PkgConfig
+#      PROVIDES ProvideSDL2       <-- (optional) Fallback to just look at the provided file. 
+#   )                                  Undecided if I should fall back to a FindXXXX.cmake yet
+
+find_package(PkgConfig)
+macro(add_package)
+  cmake_parse_arguments(addpackage_args
+	  "CONFIG;REQUIRED" "TARGET;PROVIDES;PKG;PKG_USE" "PKG_CONFIG"
+	  ${ARGN}
+	)
+
+  # Note: We don't pass "REQUIRED" here because we choose to fallback if it doesn't exist.
+  #       Later, however, we do choose to throw an error based on this flag.
+  set(addpackage_fp_args "")
+  if (${addpackage_args_CONFIG})
+	string(APPEND addpackage_fp_args "CONFIG")
+  endif()
+
+  find_package(${addpackage_args_PKG} ${addpackage_fp_args})
+
+  if(${addpackage_args_PKG}_FOUND)
+  	# See if its an alias (Is this needed?)
+	get_target_property(addpackage_pkg_alias_check ${addpackage_args_PKG_USE} ALIASED_TARGET)
+	if (addpackage_pkg_alias_check STREQUAL "addpackage_pkg_alias_check-NOTFOUND")
+		add_library(${addpackage_args_TARGET} ALIAS ${addpackage_args_PKG_USE})
+	else()
+		message(STATUS "Package \"${addpackage_args_PKG}\" is an alias. Realiasing it.")
+		# "unalias" it, aka just export the "alias" as the new target, so a re-alias, really...
+		get_target_property(${addpackage_args_TARGET} ${addpackage_args_PKG_USE} ALIASED_TARGET)
+	endif()
+  else()
+	#message(STATUS "CMake Package \"${addpackage_args_PKG}\" doesn't exist, so falling back to PkgConfig")
+
+	if (PkgConfig_FOUND)
+	  if (${addpackage_args_REQUIRED})
+		list(APPEND addpackage_args_pkg_config_args REQUIRED)
+	  endif()
+	  pkg_check_modules(${addpackage_args_TARGET} ${addpackage_args_pkg_config_args} ${addpackage_args_PKG_CONFIG})
+	elseif(addpackage_args_REQUIRED)
+	  # TODO look in Provides
+	  message(FATAL_ERROR "Package \"${addpackage_args_TARGET}\" couldn't be found, but it's required.\nI don't know what to do. Is it installed?")
+	endif()
+  endif()
+endmacro(add_package)

mk/cmake/SuperTux/BuildInstall.cmake

@@ -1,7 +1,7 @@
 if(WIN32 AND NOT UNIX)
-  install(DIRECTORY $<TARGET_FILE_DIR:supertux2_lib>/
-          DESTINATION ${INSTALL_SUBDIR_BIN}
-          FILES_MATCHING PATTERN "*.dll")
+  #install(DIRECTORY $<TARGET_FILE_DIR:supertux2>/
+  #        DESTINATION ${INSTALL_SUBDIR_BIN}
+  #        FILES_MATCHING PATTERN "*.dll")
 
   install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons/supertux.png
                 ${CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons/supertux.ico