cmake: fix ctypesgen's generation of GRASS API (#5418)

nilason · web-flow · commit 565e82de51d7 · 2025-03-20T00:34:54.000Z
diff --git a/cmake/ctypesgen.cmake b/cmake/ctypesgen.cmake
@@ -1,11 +1,17 @@
 #[[
 AUTHOR(S):  Rashad Kanavath <rashad km gmail>
-PURPOSE:    Cmake building of lib/python/ctypes (TODO)
-COPYRIGHT:  (C) 2020 by the GRASS Development Team
+PURPOSE:    Generation of Python interface to GRASS API
+COPYRIGHT:  (c) 2020-2025 by the GRASS Development Team
 
 SPDX-License-Identifier: GPL-2.0-or-later
 #]]
 
+foreach(req OUT_FILE HDRS LIBS CTYPESGEN_PY COMPILER)
+  if(NOT DEFINED ${req} OR "${${req}}" STREQUAL "")
+    message(FATAL_ERROR "ctypesgen.cmake: you must set ${req}")
+  endif()
+endforeach()
+
 set(ENV{GISRC}
     "${OUTDIR}/${GRASS_INSTALL_DEMODIR}/.grassrc${GRASS_VERSION_MAJOR}${GRASS_VERSION_MINOR}"
 )
@@ -17,52 +23,51 @@ set(ENV{PYTHONPATH}
     "${OUTDIR}/${GRASS_INSTALL_GUIDIR}/wxpython:${OUTDIR}/${GRASS_INSTALL_PYDIR}:$ENV{PYTHONPATH}"
 )
 if(NOT MSVC)
-  set(ENV{LD_LIBRARY_PATH}
-      "${OUTDIR}/${GRASS_INSTALL_LIBDIR}:$ENV{LD_LIBRARY_PATH}")
+  set(_d
+      "${OUTDIR}/${GRASS_INSTALL_LIBDIR}:${OUTDIR}/${GRASS_INSTALL_BINDIR}:${OUTDIR}/${GRASS_INSTALL_SCRIPTDIR}"
+  )
+  set(ENV{${LD_LIBRARY_PATH_VAR}} "${_d}:$ENV{${LD_LIBRARY_PATH_VAR}}")
+  unset(_d)
 endif()
 set(ENV{LC_ALL} C)
 
+set(CTYPESFLAGS "${COMPILER} -E ${C_FLAGS}")
+
 set(LIBRARIES)
 foreach(LIB ${LIBS})
-  list(APPEND LIBRARIES --library=${LIB})
-endforeach()
-
-set(HEADERS)
-foreach(HDR ${HDRS})
-  list(APPEND HEADERS "${OUTDIR}/${GRASS_INSTALL_INCLUDEDIR}/grass/${HDR}")
+  list(APPEND LIBRARIES "-l${LIB}")
 endforeach()
 
-set(SYSHEADERS)
-foreach(SYSHDR ${SYSHDRS})
-  list(APPEND SYSHEADERS "--includedir=${SYSHDR}")
-endforeach()
-
-foreach(req OUT_FILE HDRS LIBS CTYPESGEN_PY COMPILER)
-  if(NOT DEFINED ${req} OR "${${req}}" STREQUAL "")
-    message(FATAL_ERROR "you must set ${req}")
-  endif()
+set(INC_HEADERS)
+foreach(INCHDR ${INCHDRS})
+  list(APPEND INC_HEADERS "-I${INCHDR}")
 endforeach()
 
+set(DEFINES)
 if(MSVC)
-  set(CTYPESFLAGS "${COMPILER} -E -DPACKAGE=\"grasslibs\"")
+  # ??
+elseif(APPLE)
+  # ??
 else()
-  set(CTYPESFLAGS
-      "${COMPILER} -E -DPACKAGE=\"grasslibs\" -D__GLIBC_HAVE_LONG_LONG")
+  list(APPEND DEFINES "__GLIBC_HAVE_LONG_LONG")
 endif()
+list(TRANSFORM DEFINES PREPEND "-D")
 
-message(
-  STATUS "Running ${PYTHON_EXECUTABLE} ${CTYPESGEN_PY} --cpp=${CTYPESFLAGS} \
-    --no-embed-preamble --strip-build-path ${RUNTIME_GISBASE} ${SYSHEADERS} \
-    ${C_FLAGS} ${LIBRARIES} ${HEADERS} --output=${OUT_FILE}")
+set(HEADERS)
+foreach(HDR ${HDRS})
+  list(APPEND HEADERS "${OUTDIR}/${GRASS_INSTALL_INCLUDEDIR}/grass/${HDR}")
+endforeach()
+
+message(STATUS "Generating ${OUT_FILE}")
 execute_process(
   COMMAND
-    ${PYTHON_EXECUTABLE} ${CTYPESGEN_PY} --cpp=${CTYPESFLAGS}
-    --no-embed-preamble --strip-build-path ${RUNTIME_GISBASE} ${SYSHEADERS}
-    --includedir="${OUTDIR}/${GRASS_INSTALL_INCLUDEDIR}" ${C_FLAGS} ${LIBRARIES}
-    ${HEADERS} --output=${OUT_FILE}
+    ${PYTHON_EXECUTABLE} ${CTYPESGEN_PY} --cpp "${CTYPESFLAGS}"
+    --no-embed-preamble --strip-build-path ${RUNTIME_GISBASE} ${INC_HEADERS}
+    ${LIBRARIES} ${DEFINES} -o ${OUT_FILE} ${HEADERS}
   OUTPUT_VARIABLE ctypesgen_OV
   ERROR_VARIABLE ctypesgen_EV
-  RESULT_VARIABLE ctypesgen_RV)
+  RESULT_VARIABLE ctypesgen_RV COMMAND_ECHO STDOUT)
+
 if(ctypesgen_RV)
-  message(FATAL_ERROR "ctypesgen.py: ${ctypesgen_EV} \n ${ctypesgen_OV}")
+  message(FATAL_ERROR "${CTYPESGEN_PY}: ${ctypesgen_EV} \n ${ctypesgen_OV}")
 endif()
diff --git a/lib/init/CMakeLists.txt b/lib/init/CMakeLists.txt
@@ -76,15 +76,6 @@ set(DLL_PATH_LIST)
 list(APPEND DLL_PATH_LIST ${grass_dll_dir})
 separate_arguments(DLL_PATH_LIST)
 
-set(LD_LIBRARY_PATH_VAR)
-if(UNIX OR MINGW)
-  if(DEFINED ENV{LD_LIBRARY_PATH})
-    set(LD_LIBRARY_PATH_VAR
-        "${OUTDIR}/${GRASS_INSTALL_LIBDIR}:$ENV{LD_LIBRARY_PATH}")
-  else()
-    set(LD_LIBRARY_PATH_VAR "${OUTDIR}/${GRASS_INSTALL_LIBDIR}")
-  endif()
-endif()
 message(STATUS "GISBASE (build) : ${GISBASE_DIR}")
 message(STATUS "grass config directory (build): ${grass_config_dir}")
 
diff --git a/python/libgrass_interface_generator/CMakeLists.txt b/python/libgrass_interface_generator/CMakeLists.txt
@@ -1,3 +1,8 @@
+#[[
+COPYRIGHT: (c) 2020-2025 by the GRASS Development Team
+SPDX-License-Identifier: GPL-2.0-or-later
+]]
+
 set(MODULES
     date
     gis
@@ -49,9 +54,15 @@ set(stats_HDRS stats.h defs/stats.h)
 set(raster3d_HDRS raster3d.h defs/raster3d.h)
 set(cluster_HDRS cluster.h defs/cluster.h)
 
-set(proj_SYSHDRS ${PROJ_INCLUDE_DIR} ${GDAL_INCLUDE_DIR})
-set(vector_SYSHDRS ${PostgreSQL_INCLUDE_DIR} ${GDAL_INCLUDE_DIR})
-set(vedit_SYSHDRS ${PostgreSQL_INCLUDE_DIR} ${GDAL_INCLUDE_DIR})
+set(proj_INCHDRS ${PROJ_INCLUDE_DIRS} ${GDAL_INCLUDE_DIRS})
+set(vector_INCHDRS ${PostgreSQL_INCLUDE_DIRS} ${GDAL_INCLUDE_DIRS})
+set(vedit_INCHDRS ${PostgreSQL_INCLUDE_DIRS} ${GDAL_INCLUDE_DIRS})
+
+set(_c_flags ${CMAKE_C_FLAGS})
+if(APPLE AND CMAKE_OSX_SYSROOT)
+  string(APPEND _c_flags " --sysroot ${CMAKE_OSX_SYSROOT}")
+  message("_c_flags")
+endif()
 
 foreach(module ${MODULES})
   if(NOT ${module}_LIBS)
@@ -62,19 +73,18 @@ foreach(module ${MODULES})
     message(FATAL_ERROR "${module}_HDRS is not set")
   endif()
 
-  if(NOT ${module}_SYSHDRS)
-    set(${module}_SYSHDRS})
+  if(NOT ${module}_INCHDRS)
+    set(${module}_INCHDRS})
   endif()
-  list(INSERT ${module}_SYSHDRS 0 ${CMAKE_INSTALL_PREFIX})
-  list(REMOVE_DUPLICATES ${module}_SYSHDRS)
-
-  #[[
-  foreach(${module}_LIB ${${module}_LIBS})
-    if(NOT TARGET ${${module}_LIB})
-      message(FATAL_ERROR "${${module}_LIB} is not a target")
-    endif()
-  endforeach()
-]]
+  list(INSERT ${module}_INCHDRS 0 ${OUTDIR}/${GRASS_INSTALL_INCLUDEDIR})
+  if(CMAKE_INSTALL_INCLUDEDIR)
+    list(INSERT ${module}_INCHDRS 0
+         ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR})
+  endif()
+  if(CMAKE_PREFIX_PATH)
+    list(INSERT ${module}_INCHDRS 0 ${CMAKE_PREFIX_PATH})
+  endif()
+  list(REMOVE_DUPLICATES ${module}_INCHDRS)
 
   if(NOT ${module}_TARGET_NAME)
     list(GET ${module}_LIBS 0 first_lib)
@@ -93,7 +103,7 @@ foreach(module ${MODULES})
       ${CMAKE_COMMAND} -DCTYPESGEN_PY=${CMAKE_CURRENT_SOURCE_DIR}/run.py
       -DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE} -DCOMPILER=${CMAKE_C_COMPILER}
       "-DHDRS=${${module}_HDRS}" "-DLIBS=${${module}_LIBS}" -DOUTDIR=${OUTDIR}
-      "-DSYSHDRS=${${module}_SYSHDRS}" -DC_FLAGS=${CMAKE_C_FLAGS}
+      "-DINCHDRS=${${module}_INCHDRS}" -DC_FLAGS=${_c_flags}
       -DGRASS_INSTALL_INCLUDEDIR=${GRASS_INSTALL_INCLUDEDIR}
       -DGRASS_INSTALL_SCRIPTDIR=${GRASS_INSTALL_SCRIPTDIR}
       -DGRASS_INSTALL_DEMODIR=${GRASS_INSTALL_DEMODIR}
@@ -111,3 +121,10 @@ foreach(module ${MODULES})
   install(FILES ${output_file} DESTINATION ${GRASS_INSTALL_PYDIR}/grass/lib)
 
 endforeach()
+
+file(COPY_FILE libgrass__init__.py
+     ${OUTDIR}/${GRASS_INSTALL_PYDIR}/grass/lib/__init__.py)
+install(FILES ${OUTDIR}/${GRASS_INSTALL_PYDIR}/grass/lib/__init__.py
+        DESTINATION ${GRASS_INSTALL_PYDIR}/grass/lib)
+
+unset(_c_flags)
