buildsystem - sync with cmake ECM and KDAB upstream

cmake/KDAB/modules/PySide6ModuleBuild.cmake

@@ -6,7 +6,10 @@
 #
 
 if(NOT ${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX)
-    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE FILEPATH "Custom path to install python bindings.")
+    # cmake-lint: disable=C0103
+    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}
+        CACHE FILEPATH "Custom path to install python bindings."
+    )
 endif()
 
 message(STATUS "PYTHON INSTALL PREFIX ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}")
@@ -65,6 +68,7 @@ if(WIN32 OR DEFINED AVOID_PROTECTED_HACK)
     add_definitions(-DAVOID_PROTECTED_HACK)
 endif()
 
+# Replace all semicolons in a string with this platform's path separator
 macro(make_path varname)
     # accepts any number of path variables
     string(REPLACE ";" "${PATH_SEP}" ${varname} "${ARGN}")
@@ -73,35 +77,35 @@ endmacro()
 # Creates a PySide module target based on the arguments
 # This will:
 # 1 - Create a Cmake custom-target that call shiboken-generator passign the correct arguments
-# 2 - Create a Cmake library target called "Py${LIBRARY_NAME}" the output name of this target
+# 2 - Create a Cmake library target called "Py${libraryName}" the output name of this target
 #     will be changed to match PySide template
 # Args:
-#   LIBRARY_NAME - The name of the output module
-#   TYPESYSTEM_PATHS - A list of paths where shiboken should look for typesystem files
-#   INCLUDE_PATHS - Include paths necessary to parse your class. *This is not the same as build*
-#   OUTPUT_SOURCES - The files that will be generated by shiboken
-#   TARGET_INCLUDE_DIRS - This will be passed to target_include_directories
-#   TARGET_LINK_LIBRARIES - This will be passed to target_link_libraries
-#   GLOBAL_INCLUDE - A header-file that contains all classes that will be generated
-#   TYPESYSTEM_XML - The target binding typesystem (that should be the full path)
-#   DEPENDS - This var will be passed to add_custom_command(DEPENDS) so a new generation will be
+#   libraryName - The name of the output module
+#   typesystemPaths - A list of paths where shiboken should look for typesystem files
+#   includePaths - Include paths necessary to parse your class. *This is not the same as build*
+#   outputSource - The files that will be generated by shiboken
+#   targetIncludeDirs - This will be passed to target_include_directories
+#   targetLinkLibraries - This will be passed to targetLinkLibraries
+#   globalInclude - A header-file that contains all classes that will be generated
+#   typesystemXML - The target binding typesystem (that should be the full path)
+#   dependsArg - This var will be passed to add_custom_command(DEPENDS) so a new generation will be
 #             trigger if one of these files changes
-#   MODULE_OUTPUT_DIR - Where the library file should be stored
-macro(CREATE_PYTHON_BINDINGS
-    LIBRARY_NAME
-    TYPESYSTEM_PATHS
-    INCLUDE_PATHS
-    OUTPUT_SOURCES
-    TARGET_INCLUDE_DIRS
-    TARGET_LINK_LIBRARIES
-    GLOBAL_INCLUDE
-    TYPESYSTEM_XML
-    DEPENDS
-    MODULE_OUTPUT_DIR)
+#   moduleOutputDir - Where the library file should be stored
+macro(create_python_bindings
+    libraryName
+    typesystemPaths
+    includePaths
+    outputSource
+    targetIncludeDirs
+    targetLinkLibraries
+    globalInclude
+    typesystemXML
+    dependsArg
+    moduleOutputDir)
 
     # Transform the path separators into something shiboken understands.
-    make_path(shiboken_include_dirs ${INCLUDE_PATHS})
-    make_path(shiboken_typesystem_dirs ${TYPESYSTEM_PATHS})
+    make_path(shiboken_include_dirs ${includePaths})
+    make_path(shiboken_typesystem_dirs ${typesystemPaths})
     get_property(raw_python_dir_include_dirs DIRECTORY PROPERTY INCLUDE_DIRECTORIES)
     make_path(python_dir_include_dirs ${raw_python_dir_include_dirs})
     set(shiboken_include_dirs "${shiboken_include_dirs}${PATH_SEP}${python_dir_include_dirs}")
@@ -112,54 +116,55 @@ macro(CREATE_PYTHON_BINDINGS
         make_path(shiboken_framework_include_dirs ${shiboken_framework_include_dirs})
         set(shiboken_framework_include_dirs_option "--framework-include-paths=${shiboken_framework_include_dirs}")
     endif()
-    set_property(SOURCE ${OUTPUT_SOURCES} PROPERTY SKIP_AUTOGEN ON)
-    add_custom_command(OUTPUT ${OUTPUT_SOURCES}
+    set_property(SOURCE ${outputSource} PROPERTY SKIP_AUTOGEN ON)
+    add_custom_command(
+        OUTPUT ${outputSource}
         COMMAND $<TARGET_PROPERTY:Shiboken6::shiboken,LOCATION> ${GENERATOR_EXTRA_FLAGS}
-                ${GLOBAL_INCLUDE}
+                ${globalInclude}
                 --include-paths=${shiboken_include_dirs}
                 --typesystem-paths=${shiboken_typesystem_dirs}
                 ${shiboken_framework_include_dirs_option}
                 --output-directory=${CMAKE_CURRENT_BINARY_DIR}
-                ${TYPESYSTEM_XML}
-        DEPENDS ${TYPESYSTEM_XML} ${DEPENDS}
+                ${typesystemXML}
+        DEPENDS ${typesystemXML} ${dependsArg}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        COMMENT "Running generator for ${LIBRARY_NAME} binding...")
+        COMMENT "Running generator for ${libraryName} binding..."
+    )
 
-        set(TARGET_NAME "Py${LIBRARY_NAME}")
-        set(MODULE_NAME "${LIBRARY_NAME}")
-        add_library(${TARGET_NAME} MODULE ${OUTPUT_SOURCES})
+    set(TARGET_NAME "Py${libraryName}")
+    set(MODULE_NAME "${libraryName}")
+    add_library(${TARGET_NAME} MODULE ${outputSource})
 
-        set_target_properties(${TARGET_NAME} PROPERTIES
-            PREFIX ""
-            OUTPUT_NAME ${MODULE_NAME}
-            LIBRARY_OUTPUT_DIRECTORY ${MODULE_OUTPUT_DIR}
-        )
-        if(APPLE)
-            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
-        elseif(NOT WIN32) #ie. linux
-            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
-        endif()
+    set_target_properties(
+        ${TARGET_NAME} PROPERTIES
+        PREFIX ""
+        OUTPUT_NAME ${MODULE_NAME}
+        LIBRARY_OUTPUT_DIRECTORY ${moduleOutputDir}
+    )
+    if(APPLE)
+        set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
+    elseif(NOT WIN32) #ie. linux
+        set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+    endif()
 
-        if(WIN32)
-            set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")
-        endif()
+    if(WIN32)
+        set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")
+    endif()
 
-        target_include_directories(${TARGET_NAME} PUBLIC
-            ${TARGET_INCLUDE_DIRS}
-        )
+    target_include_directories(${TARGET_NAME} PUBLIC ${targetIncludeDirs})
 
-        target_link_libraries(${TARGET_NAME}
-            ${TARGET_LINK_LIBRARIES}
-            PySide6::pyside6
-            Shiboken6::libshiboken
-        )
-        target_compile_definitions(${TARGET_NAME}
-            PRIVATE Py_LIMITED_API=0x03050000
-        )
-        if(APPLE)
-            set_property(TARGET ${TARGET_NAME} APPEND PROPERTY
-                LINK_FLAGS "-undefined dynamic_lookup")
-        endif()
-        install(TARGETS ${TARGET_NAME}
-            LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX})
+    target_link_libraries(
+        ${TARGET_NAME}
+        ${targetLinkLibraries}
+        PySide6::pyside6
+        Shiboken6::libshiboken
+    )
+    target_compile_definitions(${TARGET_NAME} PRIVATE Py_LIMITED_API=0x03050000)
+    if(APPLE)
+        set_property(TARGET ${TARGET_NAME} APPEND PROPERTY LINK_FLAGS "-undefined dynamic_lookup")
+    endif()
+    install(
+        TARGETS ${TARGET_NAME}
+        LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
+    )
 endmacro()