Merge pull request godotengine#1598 from enetheru/modernise

Modernise existing cmake options

Merge pull request godotengine#1647 from enetheru/fix#1459

CMake: Align MSVC runtime (MD[d], MT) options to engine
Merge pull request godotengine#1649 from enetheru/fix-backward-break

CMake: fix break for build prior to modernisation PR
CMake: Fix selection of MSVC Runtime compile flags

My last attempt at solving this was not correct. I have left lots of comments in the source detailing the issue as it will effect consumers.

Replace empty EXCLUDE variable with EXCLUDE_FROM_ALL

This was a mistake left over from the modernise PR

CMake: Handle GODOT_DEV_BUILD flag correctly

.dev is added to output artifacts
Warn users for specifying dev_build and Release build config
Update documentation with deviations to SCons
Update debug_symbols handling, its rolled into build config
Cleanup helper variables and comments

 CMake: Enable using clang-cl on windows

detect clang with MSVC frontend using CMAKE_CXX_COMPILER_FRONTEND_VARIANT

Alleviate CMake target name clashes, visibility, and grouping.

Simplify <platform>_generate cmake function signature, as TARGET_ALIAS and TARGET_NAME are still in scope and do not need to be passed.

Add USE_FOLDERS, and FOLDER properties to group targets in VS and XCode

Guard test target with GODOT_ENABLE_TESTING

Tidy Small Issues

remove RPATH_USE_ORIGIN from static libs
add INTERFACE_POSITION_INDEPENDENT_CODE ON
reset GODOT_ARCH property to SYSTEM_ARCH for macos because universal
add MACOSX_RPATH to test target
remove redundant properties from test target
remove redundant and PUBLIC cxx_std_17 compile feature

Privatise compiler options.

CMake: Support using build_profile.json

Python:
- Redirect stdout for get_file_list to prevent stdout pollution
CMake:
- add GODOT_BUILD_PROFILE cache option
- Split file list generation into its own function
- add status and debug messages
Python Snippets in CMake:
- re-format for better readability
Build Profile:
- Add missing VisualInstance3D class to build_profile.json

Add CMake support for XML documentation

Implement generate_doc_source for cmake

Implement generate_doc_source for cmake

CMake: add lto options

add a fake target to expose results of generator expressions

move location of genex debug target so that it picks up the target details properly and allows us to generate for each type.

first attempt

Simplify Code Generation Variables
- use generator expressions
- use math for bits
- simplify if statements

Simplify SYSTEM_NAME generator expression.
previous version created a list, which is semicolon delimited and then string REPLACED the semicolon to create a single string.
New version uses string APPEND to create the string the first time.

Update Target Properties
- Using rpath for a static library is irrelevant, needs to be seet in consumers.
- Add INTERFACE_POSITION_INDEPENDENT_CODE to propogate flag to consumers.

Update macos
- Add TODO for missing options
- Fix formatting
- Set GODOT_ARCH in case of arch being 'universal'
- Simplify the test project when SYSTEM_NAME is Darwin

Refactor common_compiler_flags.cmake
- remove incorrectly propagated target_compile_features
- remove GNU_ prefix on generic compiler version genex's
- remove line breaks for simple genex's
- make most flags private
- comments

Update Comments
- Add TODO items for missing options
- Add missing toolchain managed options commented out
- Homogenise Headings and block comments

replace ad-hock name construction with new GODOT_SUFFIX
- This replicates how SCons does it.
- Modify test project to use GODOT_SUFFIX
- Add GODOT_SUFFIX to libgodot-cpp properties

set web shared lib suffix to bring web builds into line with SCons

Author: enetheru

.github/workflows/ci.yml

@@ -204,30 +204,6 @@ jobs:
           path: ${{ matrix.artifact-path }}
           if-no-files-found: error
 
-  linux-cmake:
-    name: 🐧 Build (Linux, GCC, CMake)
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -qqq build-essential pkg-config cmake
-
-      - name: Build godot-cpp
-        run: |
-          cmake -DCMAKE_BUILD_TYPE=Release .
-          make -j $(nproc) VERBOSE=1
-
-      - name: Build test GDExtension library
-        run: |
-          cd test && cmake -DCMAKE_BUILD_TYPE=Release -DGODOT_HEADERS_PATH="../godot-headers" -DCPP_BINDINGS_PATH=".." .
-          make -j $(nproc) VERBOSE=1
-
   linux-cmake-ninja:
     name: 🐧 Build (Linux, GCC, CMake Ninja)
     runs-on: ubuntu-20.04
@@ -242,15 +218,12 @@ jobs:
           sudo apt-get update -qq
           sudo apt-get install -qqq build-essential pkg-config cmake ninja-build
 
-      - name: Build godot-cpp
-        run: |
-          cmake -DCMAKE_BUILD_TYPE=Release -GNinja .
-          cmake --build . -j $(nproc) --verbose
-
       - name: Build test GDExtension library
         run: |
-          cd test && cmake -DCMAKE_BUILD_TYPE=Release -DGODOT_HEADERS_PATH="../godot-headers" -DCPP_BINDINGS_PATH=".." -GNinja .
-          cmake --build . -j $(nproc) --verbose
+          mkdir cmake-build
+          cd cmake-build
+          cmake ../ -DGODOT_ENABLE_TESTING=YES -DTEST_TARGET=template_release
+          cmake --build . --verbose -j $(nproc) -t godot-cpp-test --config Release
 
   windows-msvc-cmake:
     name: 🏁 Build (Windows, MSVC, CMake)
@@ -261,12 +234,9 @@ jobs:
         with:
           submodules: recursive
 
-      - name: Build godot-cpp
-        run: |
-          cmake -DCMAKE_BUILD_TYPE=Release -G"Visual Studio 16 2019" .
-          cmake --build . --verbose --config Release
-
       - name: Build test GDExtension library
         run: |
-          cd test && cmake -DCMAKE_BUILD_TYPE=Release -DGODOT_HEADERS_PATH="../godot-headers" -DCPP_BINDINGS_PATH=".." -G"Visual Studio 16 2019" .
-          cmake --build . --verbose --config Release
+          mkdir cmake-build
+          cd cmake-build
+          cmake ../ -DGODOT_ENABLE_TESTING=YES -DTEST_TARGET=template_release
+          cmake --build . --verbose -t godot-cpp-test --config Release

.gitignore

@@ -198,4 +198,7 @@ venv
 
 # Clion Configuration
 .idea/
-cmake-build-*
+cmake-build*/
+
+# CMake related
+CMakeUserPresets.json

CMakeLists.txt

@@ -1,24 +1,64 @@
-cmake_minimum_required(VERSION 3.13)
-project(godot-cpp LANGUAGES CXX)
+cmake_minimum_required(VERSION 3.17)
 
-# Configure CMake
-# https://discourse.cmake.org/t/how-do-i-remove-compile-options-from-target/5965
-# https://stackoverflow.com/questions/74426638/how-to-remove-rtc1-from-specific-target-or-file-in-cmake
-if(${CMAKE_CXX_COMPILER_ID} STREQUAL MSVC)
-    if(NOT CMAKE_BUILD_TYPE MATCHES Debug)
-        STRING(REGEX REPLACE "/RTC(su|[1su])" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
-        string(REPLACE "/RTC1" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG})
-    endif ()
-endif ()
+#[=======================================================================[.rst:
 
-include( ${PROJECT_SOURCE_DIR}/cmake/godotcpp.cmake )
+CMake Version requirements
+--------------------------
 
-# I know this doesn't look like a typical CMakeLists.txt, but as we are
-# attempting mostly feature parity with SCons, and easy maintenance, the closer
-# the two build systems look the easier they will be to keep in lockstep.
+To enable use of the emscripten emsdk hack for pseudo shared library support
+without polluting options for consumers we need to use the
+CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE which was introduced in version 3.17
 
-# The typical target definitions are in ${PROJECT_SOURCE_DIR}/cmake/godotcpp.cmake
+Scons Compatibility
+-------------------
 
+There is an understandable conflict between build systems as they define
+similar concepts in different ways. When there isn't a 1:1 relationship,
+compromises need to be made to resolve those differences.
+
+As we are attempting to maintain feature parity, and ease of maintenance, these
+CMake scripts are built to resemble the SCons build system wherever possible.
+
+The file structure and file content are made to match, if not in content then
+in spirit. The closer the two build systems look the easier they will be to
+maintain.
+
+Where the SCons additional scripts in the tools directory, The CMake scripts
+are in the cmake directory.
+
+For example, the tools/godotcpp.py is sourced into SCons, and the 'options'
+function is run.
+
+.. highlight:: python
+
+    cpp_tool = Tool("godotcpp", toolpath=["tools"])
+    cpp_tool.options(opts, env)
+
+The CMake equivalent is below.
+]=======================================================================]
+
+include( cmake/godotcpp.cmake )
 godotcpp_options()
 
+#[[ Python is required for code generation ]]
+find_package(Python3 3.4 REQUIRED) # pathlib should be present
+
+# Define our project.
+project( godot-cpp
+        VERSION 4.4
+        DESCRIPTION "C++ bindings for the Godot Engine's GDExtensions API."
+        HOMEPAGE_URL "https://github.com/godotengine/godot-cpp"
+        LANGUAGES CXX)
+
+compiler_detection()
 godotcpp_generate()
+
+# optionally add the godot-cpp-test integration testing target
+if( GODOT_ENABLE_TESTING )
+    add_subdirectory( test )
+endif()
+
+#[[ If this is the top level CMakeLists.txt, Generators which honor the
+USE_FOLDERS flag will organize godot-cpp targets under the subfolder
+'godot-cpp'. This is enable by default from CMake version 3.26 ]]
+set_property(GLOBAL PROPERTY USE_FOLDERS ON)

binding_generator.py

@@ -268,7 +268,14 @@ def get_file_list(api_filepath, output_dir, headers=False, sources=False, profil
 
 
 def print_file_list(api_filepath, output_dir, headers=False, sources=False, profile_filepath=""):
-    print(*get_file_list(api_filepath, output_dir, headers, sources, profile_filepath), sep=";", end=None)
+    import io
+    from contextlib import redirect_stdout
+
+    # suppress stdout messages from get_file_list
+    with redirect_stdout(io.StringIO()):
+        file_list = get_file_list(api_filepath, output_dir, headers, sources, profile_filepath)
+
+    print(*file_list, sep=";", end=None)
 
 
 def parse_build_profile(profile_filepath, api):

cmake/android.cmake

@@ -0,0 +1,51 @@
+#[=======================================================================[.rst:
+Android
+-------
+
+This file contains functions for options and configuration for targeting the
+Android platform
+
+Configuration of the Android toolchain is done using toolchain files,
+CMakePresets, or variables on the command line.
+
+The `Android SDK`_ provides toolchain files to help with configuration.
+
+CMake has its own `built-in support`_ for cross compiling to the
+Android platforms.
+
+.. warning::
+
+    Android does not support or test the CMake built-in workflow, recommend
+    using their toolchain file.
+
+.. _Android SDK:https://developer.android.com/ndk/guides/cmake
+
+.. _built-in support:https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html#cross-compiling-for-android
+
+There is further information and examples in the doc/cmake.rst file.
+
+]=======================================================================]
+
+#[============================[ Android Options ]============================]
+function( android_options )
+    #[[ The options present in the SCons build shown below are managed by
+    toolchain files, further information can be found in doc/cmake.rst
+
+    android_api_level : Target Android API level.
+        Default = 21
+
+    ANDROID_HOME : Path to your Android SDK installation.
+        Default = os.environ.get("ANDROID_HOME", os.environ.get("ANDROID_SDK_ROOT")
+    ]]
+endfunction()
+
+#[===========================[ Target Generation ]===========================]
+function( android_generate )
+    target_compile_definitions(${TARGET_NAME}
+            PUBLIC
+            ANDROID_ENABLED
+            UNIX_ENABLED
+    )
+
+    common_compiler_flags()
+endfunction()