mpo/VVVVVV
1
0
Fork 0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-11-15 23:49:42 +01:00
Code Issues Releases Wiki Activity
VVVVVV/desktop_version/CMakeLists.txt

336 lines
9.6 KiB
Text
Raw Normal View History

Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
# CMake File for VVVVVV
# Written by Ethan "flibitijibibo" Lee
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
cmake_minimum_required(VERSION 2.8.12)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
CMake: Add ENABLE_WARNINGS and ENABLE_WERROR build options ENABLE_WARNINGS is enabled by default, with `-Wall` on GCC/Clang and `/W4` on MSVC. ENABLE_WERROR is disabled by default, treats warnings as errors.
2020-01-11 01:58:33 +01:00
# CMake Options
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
option(ENABLE_WARNINGS "Enable compilation warnings" ON)
option(ENABLE_WERROR "Treat compilation warnings as errors" OFF)
CMake: Add ENABLE_WARNINGS and ENABLE_WERROR build options ENABLE_WARNINGS is enabled by default, with `-Wall` on GCC/Clang and `/W4` on MSVC. ENABLE_WERROR is disabled by default, treats warnings as errors.
2020-01-11 01:58:33 +01:00
Change cache bool variables into options They're the same thing, but using option() better conveys intent. However this can't be done for anything that isn't a bool, which the CUSTOM_LEVEL_SUPPORT option is not (it's a tri-state string).
2021-04-17 01:35:31 +02:00
option(BUNDLE_DEPENDENCIES "Use bundled TinyXML-2, PhysicsFS, and UTF8-CPP (if disabled, TinyXML-2 and PhysicsFS will be dynamically linked, LodePNG and UTF8-CPP will still be statically linked)" ON)
Add option to not use bundled TinyXML-2, PhysFS, and UTF8-CPP If you configure the build with -DBUNDLE_DEPENDENCIES=OFF, then VVVVVV will dynamically link with TinyXML-2 and PhysicsFS instead of using the bundled source code in third_party/ and statically linking with them. Unfortunately, it doesn't seem like distros package LodePNG, and LodePNG isn't intended to be packaged, so we can't dynamically link with it, nor can we use some system LodePNG header files somewhere else because those don't exist. UTF8-CPP is a special case, because no matter what, it's going to be statically linked with the binary (it doesn't come as a shared object file in any way). So with -DBUNDLE_DEPENDENCIES=OFF, we will use the system UTF8-CPP header files instead of the bundled ones, but it will still be statically linked in with the binary. The main motivation for doing this is so if VVVVVV ever gets packaged in distros, distro maintainers would be more likely to accept it if there was an option to compile the game without bundled dependencies. Also, it discourages modifying the third-party dependencies we have, because it's always possible for someone to compile those dependencies without our changes, with this CMake option.
2020-12-21 22:30:01 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
set(CUSTOM_LEVEL_SUPPORT ENABLED CACHE STRING "Optionally disable playing and/or editing of custom levels")
set_property(CACHE CUSTOM_LEVEL_SUPPORT PROPERTY STRINGS ENABLED NO_EDITOR DISABLED)
Add option to allow custom levels when the editor is disabled
2020-02-10 03:21:19 +01:00
Change cache bool variables into options They're the same thing, but using option() better conveys intent. However this can't be done for anything that isn't a bool, which the CUSTOM_LEVEL_SUPPORT option is not (it's a tri-state string).
2021-04-17 01:35:31 +02:00
option(STEAM "Use the Steam API" OFF)
option(GOG "Use the GOG API" OFF)
Allow for conditional building of Steam and GOG APIs I think it's a bit silly to always include the Steam and GOG APIs whenever we build VVVVVV, since the only time they'll ever be used is in a live build and not a dev build. So now Steam and GOG are disabled by default. If you want them, you'll need to add -DSTEAM=ON or -DGOG=ON respectively at CMake time. They're also both automatically enabled for release builds.
2020-06-01 18:23:07 +02:00
Change cache bool variables into options They're the same thing, but using option() better conveys intent. However this can't be done for anything that isn't a bool, which the CUSTOM_LEVEL_SUPPORT option is not (it's a tri-state string).
2021-04-17 01:35:31 +02:00
option(OFFICIAL_BUILD "Compile an official build of the game" OFF)
Replace release mode conditional with OFFICIAL_BUILD There are probably going to be situations where we'll want to compile in release mode, but still want the hash and don't want Steam/GOG enabled. So Ethan can use OFFICIAL_BUILD when tagging major versions of the game.
2020-11-21 03:15:25 +01:00
Change cache bool variables into options They're the same thing, but using option() better conveys intent. However this can't be done for anything that isn't a bool, which the CUSTOM_LEVEL_SUPPORT option is not (it's a tri-state string).
2021-04-17 01:35:31 +02:00
option(MAKEANDPLAY "Compile a version of the game without the main campaign (provided for convenience; consider modifying MakeAndPlay.h instead" OFF)
Add official, M&P, no custom levels, and no editor builds to CI CI builds were added to this repository on the first day it was released, and haven't really been touched since then. And since then, 2.3 has added NO_CUSTOM_LEVELS, NO_EDITOR, and OFFICIAL_BUILD builds to the CMake file. On top of the MAKEANDPLAY define already existing, this means CI coverage is a bit sparse - covering compile failures for changes made to most of the codebase, except for Steam and GOG, and not covering compile failures if certain parts of the code get stripped out. And people do forget to check for those configurations as well. These mess of configurations is kind of a wake-up call to refactor and generalize the code a bit, because we would probably be able to get rid of at least two of these (Make & Play, and no-custom-levels) by making it so custom levels behave indistinguishably from the main game. But, that's something to do in 2.4. At the very least, we should cover these in CI right now. On a small note, I had to add a MAKEANDPLAY configure option to the CMake file to be able to easily configure a Make & Play build from the CI runner. This option shouldn't really be used otherwise, so I added a note to it telling people to consider modifying MakeAndPlay.h instead.
2020-12-27 08:40:28 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(OFFICIAL_BUILD AND NOT MAKEANDPLAY)
set(STEAM ON)
set(GOG ON)
endif()
Allow for conditional building of Steam and GOG APIs I think it's a bit silly to always include the Steam and GOG APIs whenever we build VVVVVV, since the only time they'll ever be used is in a live build and not a dev build. So now Steam and GOG are disabled by default. If you want them, you'll need to add -DSTEAM=ON or -DGOG=ON respectively at CMake time. They're also both automatically enabled for release builds.
2020-06-01 18:23:07 +02:00
Add CMake version guard around setting C++ standard It seems like CMake 3.1.3 introduced the C/C++ standard properties, while the minimum version of this CMake file is 2.8.12. So we do what FAudio does, which is print a warning if the CMake version is too old and otherwise use it if we have the feature.
2021-04-17 01:38:31 +02:00
if(${CMAKE_VERSION} VERSION_LESS "3.1.3")
Set C standard to C90 in CMake file All the C third-party dependencies are C90, and all the C files we have are also C90 (well, almost, but that's easily sorted). So we have basically no reason to not go with C90 here. The only wrinkle is, turning C extensions off for physfs-static results in linker errors because PhysFS implicitly uses alloca() without including it properly (on Linux). I am not the only one who has ran into this - see https://icculus.org/pipermail/physfs/2020-April/001293.html - and it's a bug with PhysFS. The workaround I've gone with is to enable C extensions. (There might also be some funkiness with PhysFS's use of the `inline` keyword, so enabling extensions will paper over that as well.)
2021-04-17 01:40:08 +02:00
message(WARNING "Your CMake version is too old; set -std=c90 -std=c++98 yourself!")
Add CMake version guard around setting C++ standard It seems like CMake 3.1.3 introduced the C/C++ standard properties, while the minimum version of this CMake file is 2.8.12. So we do what FAudio does, which is print a warning if the CMake version is too old and otherwise use it if we have the feature.
2021-04-17 01:38:31 +02:00
else()
Set C standard to C90 in CMake file All the C third-party dependencies are C90, and all the C files we have are also C90 (well, almost, but that's easily sorted). So we have basically no reason to not go with C90 here. The only wrinkle is, turning C extensions off for physfs-static results in linker errors because PhysFS implicitly uses alloca() without including it properly (on Linux). I am not the only one who has ran into this - see https://icculus.org/pipermail/physfs/2020-April/001293.html - and it's a bug with PhysFS. The workaround I've gone with is to enable C extensions. (There might also be some funkiness with PhysFS's use of the `inline` keyword, so enabling extensions will paper over that as well.)
2021-04-17 01:40:08 +02:00
set(CMAKE_C_STANDARD 90)
set(CMAKE_C_EXTENSIONS OFF)
Add CMake version guard around setting C++ standard It seems like CMake 3.1.3 introduced the C/C++ standard properties, while the minimum version of this CMake file is 2.8.12. So we do what FAudio does, which is print a warning if the CMake version is too old and otherwise use it if we have the feature.
2021-04-17 01:38:31 +02:00
set(CMAKE_CXX_STANDARD 98)
set(CMAKE_CXX_EXTENSIONS OFF)
endif()
Add C++98/C++03 standards declaration to CMakeFiles.txt This enforces the C++03 standard for people making pull requests who may not realize their fancy features are too new and shouldn't be used (cough, cough, @leo60228). I did some internet searching and this is what I got from this page: https://crascit.com/2015/03/28/enabling-cxx11-in-cmake/
2020-06-07 21:57:18 +02:00
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
# Architecture Flags
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(APPLE)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
# Wow, Apple is a huge jerk these days huh?
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
set(OSX_10_9_SDK_PATH /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.9.sdk)
if(NOT CMAKE_OSX_SYSROOT)
if(IS_DIRECTORY ${OSX_10_9_SDK_PATH})
set(CMAKE_OSX_SYSROOT ${OSX_10_9_SDK_PATH})
else()
message(WARNING "CMAKE_OSX_SYSROOT not set and macOS 10.9 SDK not found! Using default one.")
endif()
endif()
set(CMAKE_OSX_DEPLOYMENT_TARGET 10.9)
link_directories(/usr/local/lib)
add_compile_options(-Werror=partial-availability)
endif()
project(VVVVVV)
if(APPLE)
message(STATUS "Using macOS SDK at ${CMAKE_OSX_SYSROOT}")
endif()
Do not hardcode default macOS SDK path Doing this is not necessary as CMake already looks up the default one correctly and in fact breaks whenever you have multiple Xcode versions installed so Xcode is not called Xcode.app. (And it does not respect the default Xcode set using xcode-select) The behavior now is to respect CMAKE_OSX_SYSROOT if set by the user on the command line. If it's not set, try to use the hardcoded path to the 10.9 SDK if it's present. If not, warn about the fact that a different SDK is used.
2020-01-11 13:40:07 +01:00
Use RPATH for lib folder, use PHYSFS_getBaseDir on all platforms. The next official VVVVVV build removes 32-bit Linux (like all my other games), and I need to get rid of the shell script on macOS at some point, so this basically brings it up to what my other games are doing. Plus, this probably fixes a bug where someone tries to run their executable away from the root...
2020-01-11 17:23:49 +01:00
# RPATH
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(NOT WIN32)
if(APPLE)
set(BIN_LIBROOT "osx")
set(BIN_RPATH "@executable_path/osx")
elseif(CMAKE_SIZEOF_VOID_P MATCHES "8")
set(BIN_LIBROOT "lib64")
set(BIN_RPATH "\$ORIGIN/lib64")
else()
set(BIN_LIBROOT "lib")
set(BIN_RPATH "\$ORIGIN/lib")
endif()
set(CMAKE_SKIP_BUILD_RPATH TRUE)
set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
set(CMAKE_INSTALL_RPATH ${BIN_RPATH})
set(CMAKE_INSTALL_RPATH_USE_LINK_PATH FALSE)
endif()
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
# Source Lists
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
set(VVV_SRC
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
src/BinaryBlob.cpp
src/BlockV.cpp
src/Ent.cpp
src/Entity.cpp
src/FileSystemUtils.cpp
src/Finalclass.cpp
src/Game.cpp
src/Graphics.cpp
src/GraphicsResources.cpp
src/GraphicsUtil.cpp
src/Input.cpp
src/KeyPoll.cpp
src/Labclass.cpp
src/Logic.cpp
src/Map.cpp
src/Music.cpp
src/Otherlevel.cpp
src/preloader.cpp
Rename titlerender.cpp to Render.cpp This also renames titlerender.h to Render.h, and updates all references to titlerender.cpp accordingly.
2020-04-04 07:53:31 +02:00
src/Render.cpp
Move all fixed-timestep render updates to new file RenderFixed.cpp As part of fixing #464, I'll need to move these pieces of code around easily. In #220 I just kind of shoved them awkwardly in whatever fixed function would be last called in the gamestate loop, which I shouldn't have done as I've now had to make formal fixed-render functions anyway. Because these fixed functions need to be called directly before a render function, and I'm fixing the order to put render functions in their proper place, so I need to be able to move these around easily, and making them function calls instead of inlined makes them easier to manipulate.
2020-11-08 00:47:49 +01:00
src/RenderFixed.cpp
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
src/Screen.cpp
src/Script.cpp
src/Scripts.cpp
src/SoundSystem.cpp
src/Spacestation2.cpp
src/TerminalScripts.cpp
src/Textbox.cpp
src/Tower.cpp
src/UtilityClass.cpp
src/WarpClass.cpp
Add XMLUtils.cpp and XMLUtils.h These XML functions will be useful for de-duplicating copy-pasted XML handling code, while also making it so elements will get updated in place instead of being thrown out and starting from scratch every time a file is saved.
2020-09-25 18:08:20 +02:00
src/XMLUtils.cpp
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
src/main.cpp
Add deferred callbacks to game loop Sometimes, there needs to be code that gets ran at the end of the game loop, otherwise rendering issues might occur. Currently, we do this by special-casing each deferred routine (e.g. shouldreturntoeditor), but it would be better if we could generalize this deference instead. Deferred callbacks can be added using the DEFER_CALLBACK macro. It takes in one argument, which is the name of a function, and that function must be a void function that takes in no arguments. Also, due to annoying C++ quirks, void functions taking no arguments cannot be attributes of objects (because they have an implicit `this` parameter), so it's recommended to create each callback separately before using the DEFER_CALLBACK macro.
2020-12-24 08:24:31 +01:00
src/DeferCallbacks.c
Split glitchrunner mode into multiple versions Previously, turning glitchrunner mode on essentially locked you to emulating 2.0, and turning it off just meant normal 2.3 behavior. But what if you wanted 2.2 behavior instead? Well, that's what I had to ask when a TAS of mine would desync in 2.3 because of the two-frame delay fix (glitchrunner off), but would also desync because of 2.0 warp lines (glitchrunner on). What I've done is made it so there are three states to glitchrunner mode now: 2.0 (previously just the "on" state), 2.2 (previously a state you couldn't use), and "off". Furthermore, I made it an enum, so in case future versions of the game patch out more glitches, we can add them to the enum (and the only other thing we have to update is a lookup table in GlitchrunnerMode.c). Also, 2.2 glitches exist in 2.0, so you'll want to use GlitchrunnerMode_less_than_or_equal() to check glitchrunner version.
2021-08-05 02:09:49 +02:00
src/GlitchrunnerMode.c
Add support for multiple Network backends, stub in GOGNetwork
2020-01-13 17:15:17 +01:00
src/Network.c
Reduce dependency on libc functions During 2.3 development, there's been a gradual shift to using SDL stdlib functions instead of libc functions, but there are still some libc functions (or the same libc function but from the STL) in the code. Well, this patch replaces all the rest of them in one fell swoop. SDL's stdlib can replace most of these, but its SDL_min() and SDL_max() are inadequate - they aren't really functions, they're more like macros with a nasty penchant for double-evaluation. So I just made my own VVV_min() and VVV_max() functions and placed them in Maths.h instead, then replaced all the previous usages of min(), max(), std::min(), std::max(), SDL_min(), and SDL_max() with VVV_min() and VVV_max(). Additionally, there's no SDL_isxdigit(), so I just implemented my own VVV_isxdigit(). SDL has SDL_malloc() and SDL_free(), but they have some refcounting built in to them, so in order to use them with LodePNG, I have to replace the malloc() and free() that LodePNG uses. Which isn't too hard, I did it in a new file called ThirdPartyDeps.c, and LodePNG is now compiled with the LODEPNG_NO_COMPILE_ALLOCATORS definition. Lastly, I also refactored the awful strcpy() and strcat() usages in PLATFORM_migrateSaveData() to use SDL_snprintf() instead. I know save migration is getting axed in 2.4, but it still bothers me to have something like that in the codebase otherwise. Without further ado, here is the full list of functions that the codebase now uses: - SDL_strlcpy() instead of strcpy() - SDL_strlcat() instead of strcat() - SDL_snprintf() instead of sprintf(), strcpy(), or strcat() (see above) - VVV_min() instead of min(), std::min(), or SDL_min() - VVV_max() instead of max(), std::max(), or SDL_max() - VVV_isxdigit() instead of isxdigit() - SDL_strcmp() instead of strcmp() - SDL_strcasecmp() instead of strcasecmp() or Win32 strcmpi() - SDL_strstr() instead of strstr() - SDL_strlen() instead of strlen() - SDL_sscanf() instead of sscanf() - SDL_getenv() instead of getenv() - SDL_malloc() instead of malloc() (replacing in LodePNG as well) - SDL_free() instead of free() (replacing in LodePNG as well)
2021-01-12 01:17:45 +01:00
src/ThirdPartyDeps.c
Replace Gravitron RNG with seeded Xoshiro This is to make it so RNG is deterministic when played back with the same inputs in a libTAS movie even if screen effects or backgrounds are disabled. That way, Gravitron RNG is on its own system (seeded in hardreset()), separate from the constant fRandom() calls that go to visual systems and don't do anything of actual consequence. The seed is based off of SDL_GetTicks(), so RTA runners don't get the same Gravitron RNG every time. This also paves the way for a future in-built input-based recording system, which now only has to save the seed for a given recording in order for it to play back deterministically.
2021-08-22 04:51:19 +02:00
src/Xoshiro.c
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(NOT CUSTOM_LEVEL_SUPPORT STREQUAL "DISABLED")
list(APPEND VVV_SRC src/editor.cpp)
endif()
if(STEAM)
list(APPEND VVV_SRC src/SteamNetwork.c)
endif()
if(GOG)
list(APPEND VVV_SRC src/GOGNetwork.c)
Don't pollute global includes/defines namespace A function like add_definitions() adds definitions to ALL targets, not just VVVVVV. This kind of namespace pollution is messy, and could result in bugs if you pollute with the right kind of pollutant. So instead of using add_definitions(), use target_compile_definitions(). And instead of using include_directories(), use target_include_directories().
2021-04-17 04:09:59 +02:00
endif()
# Executable information
if(WIN32)
Embedded .ico
2021-08-28 17:21:49 +02:00
add_executable(VVVVVV WIN32 ${VVV_SRC} icon.rc)
Don't pollute global includes/defines namespace A function like add_definitions() adds definitions to ALL targets, not just VVVVVV. This kind of namespace pollution is messy, and could result in bugs if you pollute with the right kind of pollutant. So instead of using add_definitions(), use target_compile_definitions(). And instead of using include_directories(), use target_include_directories().
2021-04-17 04:09:59 +02:00
else()
add_executable(VVVVVV ${VVV_SRC})
endif()
# Include Directories
if(BUNDLE_DEPENDENCIES)
target_include_directories(
VVVVVV PRIVATE
src
../third_party/tinyxml2
../third_party/physfs
../third_party/lodepng
../third_party/utfcpp/source
)
else()
target_include_directories(
VVVVVV PRIVATE
src
../third_party/lodepng
)
endif()
if(MAKEANDPLAY)
target_compile_definitions(VVVVVV PRIVATE -DMAKEANDPLAY)
endif()
if(STEAM)
target_compile_definitions(VVVVVV PRIVATE -DSTEAM_NETWORK)
endif()
if(GOG)
target_compile_definitions(VVVVVV PRIVATE -DGOG_NETWORK)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
endif()
set(XML2_SRC
Add TinyXML2 This adds the TinyXML2 files, as well as updates them in CMakeLists.txt so it will be compiled in, too. Temporarily, the old TinyXML is kept for now.
2020-06-03 18:42:42 +02:00
../third_party/tinyxml2/tinyxml2.cpp
)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
set(PFS_SRC
Create third_party folder, note it in the license text
2020-01-12 18:54:34 +01:00
../third_party/physfs/physfs.c
../third_party/physfs/physfs_archiver_dir.c
../third_party/physfs/physfs_archiver_unpacked.c
../third_party/physfs/physfs_archiver_zip.c
../third_party/physfs/physfs_byteorder.c
../third_party/physfs/physfs_unicode.c
../third_party/physfs/physfs_platform_posix.c
../third_party/physfs/physfs_platform_unix.c
../third_party/physfs/physfs_platform_windows.c
Untested Haiku port?
2020-01-14 05:31:14 +01:00
../third_party/physfs/physfs_platform_haiku.cpp
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(APPLE)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
# Are you noticing a pattern with this Apple crap yet?
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
set(PFS_SRC ${PFS_SRC} ../third_party/physfs/physfs_platform_apple.m)
endif()
set(PNG_SRC ../third_party/lodepng/lodepng.c)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(NOT OFFICIAL_BUILD)
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
# Add interim commit hash and its date to the build
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
# find_package sets GIT_FOUND and GIT_EXECUTABLE
find_package(Git)
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(GIT_FOUND)
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
# These filenames have to be qualified, because when we run
# the CMake script, its work dir gets set to the build folder
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
set(VERSION_INPUT_FILE ${CMAKE_CURRENT_SOURCE_DIR}/src/Version.h.in)
set(VERSION_OUTPUT_FILE ${CMAKE_CURRENT_SOURCE_DIR}/src/Version.h.out)
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
add_custom_target(
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
GenerateVersion ALL
# This BYPRODUCTS line is required for this to be ran every time
BYPRODUCTS ${VERSION_OUTPUT_FILE}
COMMAND ${CMAKE_COMMAND}
# These args have to be passed through, otherwise the script can't see them
# Also, these args have to come BEFORE `-P`! (Otherwise it fails with an unclear error)
-DGIT_EXECUTABLE=${GIT_EXECUTABLE}
-DINPUT_FILE=${VERSION_INPUT_FILE}
-DOUTPUT_FILE=${VERSION_OUTPUT_FILE}
-P ${CMAKE_CURRENT_SOURCE_DIR}/version.cmake
)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
add_dependencies(VVVVVV GenerateVersion)
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
# This lets Version.h know that Version.h.out exists
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
add_definitions(-DVERSION_H_OUT_EXISTS)
endif()
endif()
Update commit hash every time it changes, not just when CMake is re-ran The commit hash is now properly updated every time it gets changed, and not just when CMake gets re-ran. For this to work, we need to use a few CMake tricks. We add a custom target with ADD_CUSTOM_TARGET(), which is apparently always considered out-of-date (but I had to add a BYPRODUCTS line to get it to actually work), and we use the target to run a .cmake file every time we build. Also, VVVVVV needs to depend on this custom target, to ensure that the game gets built AFTER the version gets generated - otherwise there'll be an error. So we do an ADD_DEPENDENCIES() after the ADD_EXECUTABLE() for VVVVVV. This file, version.cmake, is just the Version.h.out generation that I added previously, but the important thing about all of this is that if the contents of Version.h.out doesn't change, and thus if the commit hash hasn't changed, then CMake will never recompile and relink anything at all. (At least with the Ninja generator.) On a small note, since the Version.h.out generation is now a separate script that is guaranteed to get ran on every single build, while the Git FIND_PACKAGE() gets ran only at configure time, it is possible for the cached path of the Git executable to get out of date. Fixing this requires a simple re-configure (ideally), but in case it wasn't fixed, the INTERIM_COMMIT and COMMIT_DATE variables would get set to empty strings instead of containing a value. To prevent this from happening, I've removed ERROR_QUIET from the EXECUTE_PROCESS() calls in version.cmake, because it's better to explicitly error if the Git executable wasn't found than implicitly carry on like nothing happened.
2020-12-26 05:24:14 +01:00
CMake: Add ENABLE_WARNINGS and ENABLE_WERROR build options ENABLE_WARNINGS is enabled by default, with `-Wall` on GCC/Clang and `/W4` on MSVC. ENABLE_WERROR is disabled by default, treats warnings as errors.
2020-01-11 01:58:33 +01:00
# Build options
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(ENABLE_WARNINGS)
CMake: Add ENABLE_WARNINGS and ENABLE_WERROR build options ENABLE_WARNINGS is enabled by default, with `-Wall` on GCC/Clang and `/W4` on MSVC. ENABLE_WERROR is disabled by default, treats warnings as errors.
2020-01-11 01:58:33 +01:00
# The weird syntax is due to CMake generator expressions.
# Saves quite a few lines and boilerplate at the price of readability.
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
target_compile_options(VVVVVV PRIVATE
CMake: Add ENABLE_WARNINGS and ENABLE_WERROR build options ENABLE_WARNINGS is enabled by default, with `-Wall` on GCC/Clang and `/W4` on MSVC. ENABLE_WERROR is disabled by default, treats warnings as errors.
2020-01-11 01:58:33 +01:00
$<$<OR:$<CXX_COMPILER_ID:GNU>,$<CXX_COMPILER_ID:Clang>,$<CXX_COMPILER_ID:AppleClang>>:
Add -Wpedantic to GCC/Clang in CMakeLists This adds -Wpedantic so we get warned if our code doesn't strictly conform to ISO C++98. It doesn't seem like MSVC has it.
2021-04-15 06:59:01 +02:00
-Wall -Wpedantic $<$<BOOL:${ENABLE_WERROR}>:-Werror>>
CMake: Add ENABLE_WARNINGS and ENABLE_WERROR build options ENABLE_WARNINGS is enabled by default, with `-Wall` on GCC/Clang and `/W4` on MSVC. ENABLE_WERROR is disabled by default, treats warnings as errors.
2020-01-11 01:58:33 +01:00
$<$<CXX_COMPILER_ID:MSVC>:
Fix Werror always being enabled
2020-01-12 01:28:39 +01:00
/W4 $<$<BOOL:${ENABLE_WERROR}>:/WX>>)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
endif()
if(CUSTOM_LEVEL_SUPPORT STREQUAL "NO_EDITOR")
add_definitions(-DNO_EDITOR)
elseif(CUSTOM_LEVEL_SUPPORT STREQUAL "DISABLED")
add_definitions(-DNO_CUSTOM_LEVELS -DNO_EDITOR)
endif()
if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
Use booleans for SUPPORTS_IMPLICIT_FALLTHROUGH CMake has booleans, so why not use them?
2021-04-17 04:30:27 +02:00
set(SUPPORTS_IMPLICIT_FALLTHROUGH TRUE)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER 7.0)
Use booleans for SUPPORTS_IMPLICIT_FALLTHROUGH CMake has booleans, so why not use them?
2021-04-17 04:30:27 +02:00
set(SUPPORTS_IMPLICIT_FALLTHROUGH TRUE)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
else()
Use booleans for SUPPORTS_IMPLICIT_FALLTHROUGH CMake has booleans, so why not use them?
2021-04-17 04:30:27 +02:00
set(SUPPORTS_IMPLICIT_FALLTHROUGH FALSE)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
endif()
else()
Use booleans for SUPPORTS_IMPLICIT_FALLTHROUGH CMake has booleans, so why not use them?
2021-04-17 04:30:27 +02:00
set(SUPPORTS_IMPLICIT_FALLTHROUGH FALSE)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
endif()
if(SUPPORTS_IMPLICIT_FALLTHROUGH)
target_compile_options(VVVVVV PRIVATE -Werror=implicit-fallthrough)
endif()
if(MSVC)
Disable MSVC warnings about implicit conversion Implicit conversion warnings happen all over the codebase, but there's no reason to warn on all of them, and adding casts everywhere is annoying to read and patently unnecessary. MSVC is the only compiler that has this warning (GCC even on -Wall -Wextra doesn't warn about implicit conversions), so disable it for MSVC.
2021-01-14 04:18:29 +01:00
# Disable MSVC warnings about implicit conversion
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
target_compile_options(VVVVVV PRIVATE /wd4244)
endif()
Disable MSVC warnings about implicit conversion Implicit conversion warnings happen all over the codebase, but there's no reason to warn on all of them, and adding casts everywhere is annoying to read and patently unnecessary. MSVC is the only compiler that has this warning (GCC even on -Wall -Wextra doesn't warn about implicit conversions), so disable it for MSVC.
2021-01-14 04:18:29 +01:00
Disable exceptions and RTTI in CMakeLists These are two C++ features that we don't need, don't use, and will never use in the future. Apparently the best way of doing this in CMake is to fiddle with the CXX_FLAGS using regex. Now this is one less flag I need to supply myself when I invoke CMake...
2021-04-17 04:42:26 +02:00
if(MSVC)
# Disable exceptions
Quote CMAKE_CXX_FLAGS Otherwise this would result in multiple input arguments to the regex instead of just one. Similar to shell scripting.
2021-04-20 20:19:59 +02:00
string(REGEX REPLACE "/EH[a-z]+" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
Disable exceptions and RTTI in CMakeLists These are two C++ features that we don't need, don't use, and will never use in the future. Apparently the best way of doing this in CMake is to fiddle with the CXX_FLAGS using regex. Now this is one less flag I need to supply myself when I invoke CMake...
2021-04-17 04:42:26 +02:00
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /EHsc")
# Disable RTTI
Quote CMAKE_CXX_FLAGS Otherwise this would result in multiple input arguments to the regex instead of just one. Similar to shell scripting.
2021-04-20 20:19:59 +02:00
string(REGEX REPLACE "/GR" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
Disable exceptions and RTTI in CMakeLists These are two C++ features that we don't need, don't use, and will never use in the future. Apparently the best way of doing this in CMake is to fiddle with the CXX_FLAGS using regex. Now this is one less flag I need to supply myself when I invoke CMake...
2021-04-17 04:42:26 +02:00
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /GR-")
else()
# Disable exceptions
Quote CMAKE_CXX_FLAGS Otherwise this would result in multiple input arguments to the regex instead of just one. Similar to shell scripting.
2021-04-20 20:19:59 +02:00
string(REGEX REPLACE "-fexceptions" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
Disable exceptions and RTTI in CMakeLists These are two C++ features that we don't need, don't use, and will never use in the future. Apparently the best way of doing this in CMake is to fiddle with the CXX_FLAGS using regex. Now this is one less flag I need to supply myself when I invoke CMake...
2021-04-17 04:42:26 +02:00
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-exceptions")
# Disable RTTI
Quote CMAKE_CXX_FLAGS Otherwise this would result in multiple input arguments to the regex instead of just one. Similar to shell scripting.
2021-04-20 20:19:59 +02:00
string(REGEX REPLACE "-frtti" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
Disable exceptions and RTTI in CMakeLists These are two C++ features that we don't need, don't use, and will never use in the future. Apparently the best way of doing this in CMake is to fiddle with the CXX_FLAGS using regex. Now this is one less flag I need to supply myself when I invoke CMake...
2021-04-17 04:42:26 +02:00
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-rtti")
endif()
Add option to not use bundled TinyXML-2, PhysFS, and UTF8-CPP If you configure the build with -DBUNDLE_DEPENDENCIES=OFF, then VVVVVV will dynamically link with TinyXML-2 and PhysicsFS instead of using the bundled source code in third_party/ and statically linking with them. Unfortunately, it doesn't seem like distros package LodePNG, and LodePNG isn't intended to be packaged, so we can't dynamically link with it, nor can we use some system LodePNG header files somewhere else because those don't exist. UTF8-CPP is a special case, because no matter what, it's going to be statically linked with the binary (it doesn't come as a shared object file in any way). So with -DBUNDLE_DEPENDENCIES=OFF, we will use the system UTF8-CPP header files instead of the bundled ones, but it will still be statically linked in with the binary. The main motivation for doing this is so if VVVVVV ever gets packaged in distros, distro maintainers would be more likely to accept it if there was an option to compile the game without bundled dependencies. Also, it discourages modifying the third-party dependencies we have, because it's always possible for someone to compile those dependencies without our changes, with this CMake option.
2020-12-21 22:30:01 +01:00
# Unfortunately, it doesn't seem like distros package LodePNG
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
add_library(lodepng-static STATIC ${PNG_SRC})
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
target_compile_definitions(lodepng-static PRIVATE
Disable unneeded LodePNG features The only thing we need LodePNG for is to decode a PNG that we've already loaded into memory. We handle the filesystem part ourselves, so we don't need LodePNG's filesystem functions; we don't encode images, and we don't use the zlib functions. So disable all of those.
2021-01-14 04:12:58 +01:00
-DLODEPNG_NO_COMPILE_ALLOCATORS
-DLODEPNG_NO_COMPILE_DISK
-DLODEPNG_NO_COMPILE_ENCODER
)
Reduce dependency on libc functions During 2.3 development, there's been a gradual shift to using SDL stdlib functions instead of libc functions, but there are still some libc functions (or the same libc function but from the STL) in the code. Well, this patch replaces all the rest of them in one fell swoop. SDL's stdlib can replace most of these, but its SDL_min() and SDL_max() are inadequate - they aren't really functions, they're more like macros with a nasty penchant for double-evaluation. So I just made my own VVV_min() and VVV_max() functions and placed them in Maths.h instead, then replaced all the previous usages of min(), max(), std::min(), std::max(), SDL_min(), and SDL_max() with VVV_min() and VVV_max(). Additionally, there's no SDL_isxdigit(), so I just implemented my own VVV_isxdigit(). SDL has SDL_malloc() and SDL_free(), but they have some refcounting built in to them, so in order to use them with LodePNG, I have to replace the malloc() and free() that LodePNG uses. Which isn't too hard, I did it in a new file called ThirdPartyDeps.c, and LodePNG is now compiled with the LODEPNG_NO_COMPILE_ALLOCATORS definition. Lastly, I also refactored the awful strcpy() and strcat() usages in PLATFORM_migrateSaveData() to use SDL_snprintf() instead. I know save migration is getting axed in 2.4, but it still bothers me to have something like that in the codebase otherwise. Without further ado, here is the full list of functions that the codebase now uses: - SDL_strlcpy() instead of strcpy() - SDL_strlcat() instead of strcat() - SDL_snprintf() instead of sprintf(), strcpy(), or strcat() (see above) - VVV_min() instead of min(), std::min(), or SDL_min() - VVV_max() instead of max(), std::max(), or SDL_max() - VVV_isxdigit() instead of isxdigit() - SDL_strcmp() instead of strcmp() - SDL_strcasecmp() instead of strcasecmp() or Win32 strcmpi() - SDL_strstr() instead of strstr() - SDL_strlen() instead of strlen() - SDL_sscanf() instead of sscanf() - SDL_getenv() instead of getenv() - SDL_malloc() instead of malloc() (replacing in LodePNG as well) - SDL_free() instead of free() (replacing in LodePNG as well)
2021-01-12 01:17:45 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(BUNDLE_DEPENDENCIES)
add_library(tinyxml2-static STATIC ${XML2_SRC})
Remove usage of undefined variable PFSP_SRC This variable is not defined anywhere and never has been since the source code release (which is when this CMake file was first created). To make things clearer, I'm cleaning this variable up.
2021-04-17 04:15:50 +02:00
add_library(physfs-static STATIC ${PFS_SRC})
Don't pollute global includes/defines namespace A function like add_definitions() adds definitions to ALL targets, not just VVVVVV. This kind of namespace pollution is messy, and could result in bugs if you pollute with the right kind of pollutant. So instead of using add_definitions(), use target_compile_definitions(). And instead of using include_directories(), use target_include_directories().
2021-04-17 04:09:59 +02:00
target_compile_definitions(physfs-static PRIVATE
-DPHYSFS_SUPPORTS_DEFAULT=0 -DPHYSFS_SUPPORTS_ZIP=1
)
Add option to not use bundled TinyXML-2, PhysFS, and UTF8-CPP If you configure the build with -DBUNDLE_DEPENDENCIES=OFF, then VVVVVV will dynamically link with TinyXML-2 and PhysicsFS instead of using the bundled source code in third_party/ and statically linking with them. Unfortunately, it doesn't seem like distros package LodePNG, and LodePNG isn't intended to be packaged, so we can't dynamically link with it, nor can we use some system LodePNG header files somewhere else because those don't exist. UTF8-CPP is a special case, because no matter what, it's going to be statically linked with the binary (it doesn't come as a shared object file in any way). So with -DBUNDLE_DEPENDENCIES=OFF, we will use the system UTF8-CPP header files instead of the bundled ones, but it will still be statically linked in with the binary. The main motivation for doing this is so if VVVVVV ever gets packaged in distros, distro maintainers would be more likely to accept it if there was an option to compile the game without bundled dependencies. Also, it discourages modifying the third-party dependencies we have, because it's always possible for someone to compile those dependencies without our changes, with this CMake option.
2020-12-21 22:30:01 +01:00
Set C standard to C90 in CMake file All the C third-party dependencies are C90, and all the C files we have are also C90 (well, almost, but that's easily sorted). So we have basically no reason to not go with C90 here. The only wrinkle is, turning C extensions off for physfs-static results in linker errors because PhysFS implicitly uses alloca() without including it properly (on Linux). I am not the only one who has ran into this - see https://icculus.org/pipermail/physfs/2020-April/001293.html - and it's a bug with PhysFS. The workaround I've gone with is to enable C extensions. (There might also be some funkiness with PhysFS's use of the `inline` keyword, so enabling extensions will paper over that as well.)
2021-04-17 01:40:08 +02:00
# PhysFS needs some extensions...
if(${CMAKE_VERSION} VERSION_GREATER "3.1.3"
OR ${CMAKE_VERSION} VERSION_EQUAL "3.1.3")
set_property(TARGET physfs-static PROPERTY C_EXTENSIONS ON)
endif()
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
target_link_libraries(VVVVVV physfs-static tinyxml2-static lodepng-static)
else()
find_package(utf8cpp CONFIG)
Add option to not use bundled TinyXML-2, PhysFS, and UTF8-CPP If you configure the build with -DBUNDLE_DEPENDENCIES=OFF, then VVVVVV will dynamically link with TinyXML-2 and PhysicsFS instead of using the bundled source code in third_party/ and statically linking with them. Unfortunately, it doesn't seem like distros package LodePNG, and LodePNG isn't intended to be packaged, so we can't dynamically link with it, nor can we use some system LodePNG header files somewhere else because those don't exist. UTF8-CPP is a special case, because no matter what, it's going to be statically linked with the binary (it doesn't come as a shared object file in any way). So with -DBUNDLE_DEPENDENCIES=OFF, we will use the system UTF8-CPP header files instead of the bundled ones, but it will still be statically linked in with the binary. The main motivation for doing this is so if VVVVVV ever gets packaged in distros, distro maintainers would be more likely to accept it if there was an option to compile the game without bundled dependencies. Also, it discourages modifying the third-party dependencies we have, because it's always possible for someone to compile those dependencies without our changes, with this CMake option.
2020-12-21 22:30:01 +01:00
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
target_link_libraries(VVVVVV physfs tinyxml2 utf8cpp lodepng-static)
endif()
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
# SDL2 Dependency (Detection pulled from FAudio)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(DEFINED SDL2_INCLUDE_DIRS AND DEFINED SDL2_LIBRARIES)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
message(STATUS "Using pre-defined SDL2 variables SDL2_INCLUDE_DIRS and SDL2_LIBRARIES")
Switch SDL2 includes to be private There's no reason for these to be public, and putting it public is probably going to cause more harm than not.
2021-04-17 02:27:54 +02:00
target_include_directories(VVVVVV SYSTEM PRIVATE "$<BUILD_INTERFACE:${SDL2_INCLUDE_DIRS}>")
Use RPATH for lib folder, use PHYSFS_getBaseDir on all platforms. The next official VVVVVV build removes 32-bit Linux (like all my other games), and I need to get rid of the shell script on macOS at some point, so this basically brings it up to what my other games are doing. Plus, this probably fixes a bug where someone tries to run their executable away from the root...
2020-01-11 17:23:49 +01:00
target_link_libraries(VVVVVV ${SDL2_LIBRARIES})
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
else()
# Only try to autodetect if both SDL2 variables aren't explicitly set
find_package(SDL2 CONFIG)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(TARGET SDL2::SDL2)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
message(STATUS "Using TARGET SDL2::SDL2")
Use RPATH for lib folder, use PHYSFS_getBaseDir on all platforms. The next official VVVVVV build removes 32-bit Linux (like all my other games), and I need to get rid of the shell script on macOS at some point, so this basically brings it up to what my other games are doing. Plus, this probably fixes a bug where someone tries to run their executable away from the root...
2020-01-11 17:23:49 +01:00
target_link_libraries(VVVVVV SDL2::SDL2 SDL2_mixer)
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
elseif(TARGET SDL2)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
message(STATUS "Using TARGET SDL2")
Use RPATH for lib folder, use PHYSFS_getBaseDir on all platforms. The next official VVVVVV build removes 32-bit Linux (like all my other games), and I need to get rid of the shell script on macOS at some point, so this basically brings it up to what my other games are doing. Plus, this probably fixes a bug where someone tries to run their executable away from the root...
2020-01-11 17:23:49 +01:00
target_link_libraries(VVVVVV SDL2 SDL2_mixer)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
else()
message(STATUS "No TARGET SDL2::SDL2, or SDL2, using variables")
Find SDL_mixer.h instead of assuming it's in the same location as SDL.h
2020-06-07 22:11:12 +02:00
find_path(SDL2_MIXER_INCLUDE_DIRS NAMES SDL_mixer.h PATH_SUFFIXES SDL2)
Switch SDL2 includes to be private There's no reason for these to be public, and putting it public is probably going to cause more harm than not.
2021-04-17 02:27:54 +02:00
target_include_directories(VVVVVV SYSTEM PRIVATE "$<BUILD_INTERFACE:${SDL2_INCLUDE_DIRS}>" ${SDL2_MIXER_INCLUDE_DIRS})
Use RPATH for lib folder, use PHYSFS_getBaseDir on all platforms. The next official VVVVVV build removes 32-bit Linux (like all my other games), and I need to get rid of the shell script on macOS at some point, so this basically brings it up to what my other games are doing. Plus, this probably fixes a bug where someone tries to run their executable away from the root...
2020-01-11 17:23:49 +01:00
target_link_libraries(VVVVVV ${SDL2_LIBRARIES} SDL2_mixer)
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
endif()
endif()
# Yes, more Apple Crap
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(APPLE)
find_library(FOUNDATION NAMES Foundation)
find_library(IOKIT NAMES IOKit)
target_link_libraries(VVVVVV objc ${IOKIT} ${FOUNDATION})
endif()
Untested Haiku port?
2020-01-14 05:31:14 +01:00
# But hey, also some Haiku crap
Lowercase function calls in CMakeLists Lowercase names are easier to type and are more distinguishable from the capital letters that usually go inside the function calls as arguments.
2021-04-17 01:30:51 +02:00
if(HAIKU)
find_library(BE_LIBRARY be)
find_library(ROOT_LIBRARY root)
target_link_libraries(VVVVVV ${BE_LIBRARY} ${ROOT_LIBRARY})
endif()
Reference in a new issue Copy permalink