CI-CD:use debug config for CI

Author: jere8184

.github/workflows/windows-server-2019.yml

@@ -51,7 +51,7 @@ jobs:
         mkdir build
         cd build
         cmake -DCMAKE_TOOLCHAIN_FILE="$TOOLCHAIN_FILE" -DCMAKE_BUILD_TYPE=Release -DCMAKE_TRY_COMPILE_CONFIGURATION=Release -DCMAKE_CXX_FLAGS='/Zc:__cplusplus /permissive- /EHsc' -DCMAKE_EXE_LINKER_FLAGS='' -DCMAKE_MODULE_LINKER_FLAGS='' -DCMAKE_SHARED_LINKER_FLAGS='' -DDOWNLOAD_NYAN=YES -DCXX_OPTIMIZATION_LEVEL=auto -DCXX_SANITIZE_FATAL=False -DCXX_SANITIZE_MODE=none -DWANT_BACKTRACE=if_available -DWANT_GPERFTOOLS_PROFILER=if_available -DWANT_GPERFTOOLS_TCMALLOC=False -DWANT_INOTIFY=if_available -DWANT_NCURSES=if_available -DWANT_OPENGL=if_available -DWANT_VULKAN=if_available -DFLEX_EXECUTABLE="$FLEX_PATH" -G "Visual Studio 16 2019" -A x64 ../source
-        cmake --build . --config RelWithDebInfo -- -nologo -maxCpuCount
+        cmake --build . --config Debug -- -nologo -maxCpuCount
       shell: pwsh
     - name: Package
       run: |

.github/workflows/windows-server-2022.yml

@@ -51,7 +51,7 @@ jobs:
         mkdir build
         cd build
         cmake -DCMAKE_TOOLCHAIN_FILE="$TOOLCHAIN_FILE" -DCMAKE_BUILD_TYPE=Release -DCMAKE_TRY_COMPILE_CONFIGURATION=Release -DCMAKE_CXX_FLAGS='/Zc:__cplusplus /permissive- /EHsc' -DCMAKE_EXE_LINKER_FLAGS='' -DCMAKE_MODULE_LINKER_FLAGS='' -DCMAKE_SHARED_LINKER_FLAGS='' -DDOWNLOAD_NYAN=YES -DCXX_OPTIMIZATION_LEVEL=auto -DCXX_SANITIZE_FATAL=False -DCXX_SANITIZE_MODE=none -DWANT_BACKTRACE=if_available -DWANT_GPERFTOOLS_PROFILER=if_available -DWANT_GPERFTOOLS_TCMALLOC=False -DWANT_INOTIFY=if_available -DWANT_NCURSES=if_available -DWANT_OPENGL=if_available -DWANT_VULKAN=if_available -DFLEX_EXECUTABLE="$FLEX_PATH" -G "Visual Studio 17 2022" -A x64 ../source
-        cmake --build . --config RelWithDebInfo -- -nologo -maxCpuCount
+        cmake --build . --config Debug -- -nologo -maxCpuCount
       shell: pwsh
     - name: Package
       run: |

buildsystem/HandlePythonOptions.cmake

@@ -47,6 +47,7 @@ if(WIN32 AND "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
 	if (${_index} GREATER -1)
 		MATH(EXPR _index "${_index}+1")
 		list(GET PYEXT_LIBRARY ${_index} PYEXT_LIBRARY)
+		set(force_optimized_lib_flag "--force_optimized_lib")
 	endif()
 endif()
 

buildsystem/cythonize.py

@@ -89,24 +89,26 @@ def cythonize_wrapper(modules, force_optimized_lib = False, **kwargs):
             if src_modules:
                 cythonize(src_modules, **kwargs)
                 if sys.platform == 'win32' and force_optimized_lib:
-                    windows_use_optimized_lib_python(src_modules, bin_dir)
+                    win_use_optimized_lib_python(src_modules, bin_dir)
 
             if bin_modules:
                 os.chdir(bin_dir)
                 cythonize(bin_modules, **kwargs)
                 if sys.platform == 'win32' and force_optimized_lib:
-                    windows_use_optimized_lib_python(bin_modules, bin_dir)
+                    win_use_optimized_lib_python(bin_modules, bin_dir)
                 os.chdir(src_dir)
 
 
-def windows_use_optimized_lib_python(modules, path):
+def win_use_optimized_lib_python(modules, path):
     """
     Add an #ifdef statement in cythonized .cpp files to temporarily undefine _DEBUG before
     #include "Python.h"
 
     This function modifies the generated C++ files from Cython to prevent linking to
     the debug version of the Python library on Windows. The debug version of the
     Python library cannot import Python libraries that contain extension modules.
+    see: https://github.com/python/cpython/issues/127619 (To unserstand the problem)
+    see: https://stackoverflow.com/a/59566420 (To understand the soloution)
     """
 
     for module in modules:
@@ -117,10 +119,24 @@ def windows_use_optimized_lib_python(modules, path):
         module = module + ".cpp"
         with open(module, "r", encoding='utf8') as file:
             text = file.read()
-            text = text.replace("#include \"Python.h\"",
-                                "#ifdef _DEBUG\n#define _DEBUG_WAS_DEFINED\n#undef _DEBUG\n#endif\n\
-                                #include \"Python.h\"\n#ifdef _DEBUG_WAS_DEFINED\n#define _DEBUG\n\
-                                #undef _DEBUG_WAS_DEFINED\n#endif", 1)
+            if not text.count("OPENAGE: UNDEF_DEBUG_INSERTED"):
+                text = text.replace(
+                    '#include "Python.h"',
+                    (
+                        "\n\n// OPENAGE: UNDEF_DEBUG_INSERTED\n"
+                        "// Avoid linking to the debug version of the Python library on Windows\n\n"
+                        "#ifdef _DEBUG\n"
+                        "#define _DEBUG_WAS_DEFINED\n"
+                        "#undef _DEBUG\n#endif\n"
+                        "#include \"Python.h\"\n"
+                        "#ifdef _DEBUG_WAS_DEFINED\n"
+                        "#define _DEBUG\n"
+                        "#undef _DEBUG_WAS_DEFINED\n"
+                        "#endif\n\n"
+                        "// OPENAGE: UNDEF_DEBUG_INSERTED\n\n"
+                    ),
+                    1
+                )
         with open(module, "w", encoding='utf8') as file:
             file.write(text)
 

buildsystem/python.cmake

@@ -375,9 +375,6 @@ function(python_finalize)
 
 
 	# cythonize (.pyx -> .cpp)
-	if(WIN32 AND "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
-		set(force_optimized_lib "--force_optimized_lib")
-	endif()
 
 	get_property(cython_modules GLOBAL PROPERTY SFT_CYTHON_MODULES)
 	write_on_change("${CMAKE_BINARY_DIR}/py/cython_modules" "${cython_modules}")
@@ -396,7 +393,7 @@ function(python_finalize)
 		"${CMAKE_BINARY_DIR}/py/cython_modules"
 		"${CMAKE_BINARY_DIR}/py/cython_modules_embed"
 		"${CMAKE_BINARY_DIR}/py/pxd_list"
-		${force_optimized_lib}
+		${force_optimized_lib_flag}
 		"--build-dir" "${CMAKE_BINARY_DIR}"
 		COMMAND "${CMAKE_COMMAND}" -E touch "${CYTHONIZE_TIMEFILE}"
 		DEPENDS