Merge branch 'PHP-8.3'

petk · petk · commit 235d2a69d778 · 2024-09-17T00:10:46.000+02:00
diff --git a/cmake/cmake/modules/PHP/PkgConfigGenerator.cmake b/cmake/cmake/modules/PHP/PkgConfigGenerator.cmake
@@ -9,23 +9,26 @@ Also there is a common issue with installation prefix not being applied when
 using --prefix command line option at the installation phase:
   cmake --install <build-dir> --prefix <prefix>
 
-TODO: This module will be refactored and changed further in the future.
-
 The following function is exposed:
 
 pkgconfig_generate_pc(
   <pc-template-file>
   <pc-file-output>
   TARGET <target>
+  [INSTALL_DESTINATION <path>]
   [VARIABLES [<variable> <value>] [<variable_2>:BOOL <value_2>...] ...]
-  SKIP_BOOL_NORMALIZATION
+  [SKIP_BOOL_NORMALIZATION]
 )
 
   Generate pkgconfig <pc-file-output> from the given pc <pc-template-file>
   template.
 
   TARGET
     Name of the target for getting libraries.
+  INSTALL_DESTINATION
+    Path to the pkgconfig directory where generated .pc file will be installed
+    to. Usually it is '${CMAKE_INSTALL_LIBDIR}/pkgconfig'. If not provided, .pc
+    file will not be installed.
   VARIABLES
     Pairs of variable names and values. To pass booleans, add ':BOOL' to the
     variable name. For example:
@@ -35,6 +38,11 @@ pkgconfig_generate_pc(
           variable_name:BOOL "${variable_name}"
       )
 
+    The $<INSTALL_PREFIX> generator expression can be used in variable values,
+    which is replaced with installation prefix either set via the
+    CMAKE_INSTALL_PREFIX variable at the configuration phase, or the
+    'cmake --install --prefix' option at the installation phase.
+
   SKIP_BOOL_NORMALIZATION
     CMake booleans have values yes, no, true, false, on, off, 1, 0, they can
     even be case insensitive and so on. By default, all booleans (var:BOOL see
@@ -52,14 +60,79 @@ find_program(
 )
 mark_as_advanced(PKGCONFIG_OBJDUMP_EXECUTABLE)
 
+# Parse given variables and create a list of options or variables for passing to
+# add_custom_command and configure_file().
+function(_pkgconfig_parse_variables variables)
+  # Check for even number of keyword values.
+  list(LENGTH variables length)
+  math(EXPR modulus "${length} % 2")
+  if(NOT modulus EQUAL 0)
+    message(
+      FATAL_ERROR
+      "The keyword VARIABLES must be a list of pairs - variable-name and "
+      "value (it must contain an even number of items)."
+    )
+  endif()
+
+  set(is_value FALSE)
+  set(variables_options "")
+  set(result_variables "")
+  set(result_values "")
+  foreach(variable IN LISTS variables)
+    if(is_value)
+      set(is_value FALSE)
+      continue()
+    endif()
+    list(POP_FRONT variables var value)
+
+    # Normalize boolean values to either "yes" or "no".
+    if(var MATCHES ".*:BOOL$" AND NOT parsed_SKIP_BOOL_NORMALIZATION)
+      if(value)
+        set(value "yes")
+      else()
+        set(value "no")
+      endif()
+    endif()
+
+    # Remove possible :<TYPE> part from the variable name.
+    if(var MATCHES "(.*):BOOL$")
+      set(var ${CMAKE_MATCH_1})
+    endif()
+
+    list(APPEND result_variables ${var})
+    list(APPEND result_values "${value}")
+
+    # Replace possible INSTALL_PREFIX in value for usage in add_custom_command,
+    # in the result_values above the intact genex is left for enabling the
+    # possible 'cmake --install --prefix ...' override.
+    if(value MATCHES [[.*\$<INSTALL_PREFIX>.*]])
+      string(
+        REPLACE
+        "$<INSTALL_PREFIX>"
+        "${CMAKE_INSTALL_PREFIX}"
+        value
+        "${value}"
+      )
+    endif()
+
+    list(APPEND variables_options -D ${var}="${value}")
+
+    set(is_value TRUE)
+  endforeach()
+
+  set(variables_options "${variables_options}" PARENT_SCOPE)
+  set(result_variables "${result_variables}" PARENT_SCOPE)
+  set(result_values "${result_values}" PARENT_SCOPE)
+endfunction()
+
 function(pkgconfig_generate_pc)
   cmake_parse_arguments(
     PARSE_ARGV
     2
-    parsed                    # prefix
-    "SKIP_BOOL_NORMALIZATION" # options
-    "TARGET"                  # one-value keywords
-    "VARIABLES"               # multi-value keywords
+    parsed                       # prefix
+    "SKIP_BOOL_NORMALIZATION"    # options
+    "TARGET;INSTALL_DESTINATION" # one-value keywords
+    "VARIABLES"                  # multi-value keywords
   )
 
   if(parsed_UNPARSED_ARGUMENTS)
@@ -106,7 +179,6 @@ function(pkgconfig_generate_pc)
           endif()
         endforeach()
         list(REMOVE_DUPLICATES libs)
-        message(STATUS "Libs from link.txt: ${libs}")
       endif()
 
       if(PKGCONFIG_OBJDUMP_EXECUTABLE)
@@ -127,8 +199,6 @@ function(pkgconfig_generate_pc)
             endif()
           endif()
         endforeach()
-
-        message(STATUS "Libraries from objdump: ${libraries}")
       endif()
 
       list(JOIN libraries " " PHP_LIBS_PRIVATE)
@@ -141,45 +211,7 @@ function(pkgconfig_generate_pc)
   endif()
 
   if(parsed_VARIABLES)
-    set(variables "${parsed_VARIABLES}")
-
-    # Check for even number of keyword values.
-    list(LENGTH variables length)
-    math(EXPR modulus "${length} % 2")
-    if(NOT modulus EQUAL 0)
-      message(
-        FATAL_ERROR
-        "The keyword VARIABLES must be a list of pairs - variable-name and "
-        "value (it must contain an even number of items)."
-      )
-    endif()
-
-    set(is_value FALSE)
-    set(variables_options "")
-    foreach(variable IN LISTS variables)
-      if(is_value)
-        set(is_value FALSE)
-        continue()
-      endif()
-      list(POP_FRONT variables var value)
-
-      # Normalize boolean values to either "yes" or "no".
-      if(var MATCHES ".*:BOOL$" AND NOT parsed_SKIP_BOOL_NORMALIZATION)
-        if(value)
-          set(value "yes")
-        else()
-          set(value "no")
-        endif()
-      endif()
-
-      # Remove possible :<TYPE> part from the variable name.
-      if(var MATCHES "(.*):BOOL$")
-        set(var ${CMAKE_MATCH_1})
-      endif()
-
-      list(APPEND variables_options -D ${var}="${value}")
-      set(is_value TRUE)
-    endforeach()
+    _pkgconfig_parse_variables("${parsed_VARIABLES}")
   endif()
 
   cmake_path(GET template FILENAME filename)
@@ -198,4 +230,29 @@ function(pkgconfig_generate_pc)
       -P CMakeFiles/PkgConfigGeneratePc.cmake
     COMMENT "[PkgConfig] Generating pkg-config ${filename} file"
   )
+
+  if(parsed_INSTALL_DESTINATION)
+    cmake_path(GET output FILENAME output_file)
+
+    install(CODE "
+      set(result_variables ${result_variables})
+      set(result_values \"${result_values}\")
+
+      foreach(var value IN ZIP_LISTS result_variables result_values)
+        set(\${var} \"\${value}\")
+      endforeach()
+
+      configure_file(
+        ${template}
+        ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${output_file}
+        @ONLY
+      )
+    ")
+
+    install(
+      FILES
+        ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${output_file}
+      DESTINATION ${parsed_INSTALL_DESTINATION}
+    )
+  endif()
 endfunction()
diff --git a/cmake/sapi/embed/CMakeLists.txt b/cmake/sapi/embed/CMakeLists.txt
@@ -42,27 +42,25 @@ set_target_properties(
 )
 
 # Configure pkgconf php-embed.pc metadata file.
-block()
-  include(PHP/PkgConfigGenerator)
-
-  pkgconfig_generate_pc(
-    php-embed.pc.in
-    php-embed.pc
-    TARGET php_embed
-    VARIABLES
-      prefix "${CMAKE_INSTALL_PREFIX}"
-      exec_prefix "${CMAKE_INSTALL_PREFIX}"
-      includedir "${CMAKE_INSTALL_FULL_INCLUDEDIR}"
-      libdir "${CMAKE_INSTALL_FULL_LIBDIR}"
-      PHP_VERSION "${PHP_VERSION}"
-      PHP_VERSION_ID "${PHP_VERSION_ID}"
-      PHP_EXTENSION_DIR "${PHP_EXTENSION_DIR}"
-      PHP_CONFIG_FILE_SCAN_DIR "${PHP_CONFIG_FILE_SCAN_DIR}"
-      PHP_CONFIG_FILE_PATH "${PHP_CONFIG_FILE_PATH}"
-      PHP_DEBUG:BOOL "${PHP_DEBUG}"
-      PHP_THREAD_SAFETY:BOOL "${PHP_THREAD_SAFETY}"
-  )
-endblock()
+include(PHP/PkgConfigGenerator)
+pkgconfig_generate_pc(
+  php-embed.pc.in
+  php-embed.pc
+  TARGET php_embed
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig
+  VARIABLES
+    prefix "$<INSTALL_PREFIX>"
+    exec_prefix "$<INSTALL_PREFIX>"
+    includedir "$<INSTALL_PREFIX>/${CMAKE_INSTALL_INCLUDEDIR}"
+    libdir "$<INSTALL_PREFIX>/${CMAKE_INSTALL_LIBDIR}"
+    PHP_VERSION "${PHP_VERSION}"
+    PHP_VERSION_ID "${PHP_VERSION_ID}"
+    PHP_EXTENSION_DIR "${PHP_EXTENSION_DIR}"
+    PHP_CONFIG_FILE_SCAN_DIR "${PHP_CONFIG_FILE_SCAN_DIR}"
+    PHP_CONFIG_FILE_PATH "${PHP_CONFIG_FILE_PATH}"
+    PHP_DEBUG:BOOL "${PHP_DEBUG}"
+    PHP_THREAD_SAFETY:BOOL "${PHP_THREAD_SAFETY}"
+)
 
 install(
   TARGETS php_embed
@@ -73,9 +71,3 @@ install(
   FILE_SET HEADERS
     DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/sapi/embed
 )
-
-install(
-  FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/php-embed.pc
-  DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig
-)
diff --git a/cmake/scripts/CMakeLists.txt b/cmake/scripts/CMakeLists.txt
@@ -62,26 +62,25 @@ block()
 endblock()
 
 # Configure pkgconf php.pc metadata file.
-block()
-  include(PHP/PkgConfigGenerator)
-  pkgconfig_generate_pc(
-    php.pc.in
-    php.pc
-    TARGET php_cli
-    VARIABLES
-      prefix "${CMAKE_INSTALL_PREFIX}"
-      exec_prefix "${CMAKE_INSTALL_PREFIX}"
-      includedir "${CMAKE_INSTALL_FULL_INCLUDEDIR}"
-      libdir "${CMAKE_INSTALL_FULL_LIBDIR}"
-      PHP_VERSION "${PHP_VERSION}"
-      PHP_VERSION_ID "${PHP_VERSION_ID}"
-      PHP_EXTENSION_DIR "${PHP_EXTENSION_DIR}"
-      PHP_CONFIG_FILE_SCAN_DIR "${PHP_CONFIG_FILE_SCAN_DIR}"
-      PHP_CONFIG_FILE_PATH "${PHP_CONFIG_FILE_PATH}"
-      PHP_DEBUG:BOOL "${PHP_DEBUG}"
-      PHP_THREAD_SAFETY:BOOL "${PHP_THREAD_SAFETY}"
-  )
-endblock()
+include(PHP/PkgConfigGenerator)
+pkgconfig_generate_pc(
+  php.pc.in
+  php.pc
+  TARGET php_cli
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig
+  VARIABLES
+    prefix "$<INSTALL_PREFIX>"
+    exec_prefix "$<INSTALL_PREFIX>"
+    includedir "$<INSTALL_PREFIX>/${CMAKE_INSTALL_INCLUDEDIR}"
+    libdir "$<INSTALL_PREFIX>/${CMAKE_INSTALL_LIBDIR}"
+    PHP_VERSION "${PHP_VERSION}"
+    PHP_VERSION_ID "${PHP_VERSION_ID}"
+    PHP_EXTENSION_DIR "${PHP_EXTENSION_DIR}"
+    PHP_CONFIG_FILE_SCAN_DIR "${PHP_CONFIG_FILE_SCAN_DIR}"
+    PHP_CONFIG_FILE_PATH "${PHP_CONFIG_FILE_PATH}"
+    PHP_DEBUG:BOOL "${PHP_DEBUG}"
+    PHP_THREAD_SAFETY:BOOL "${PHP_THREAD_SAFETY}"
+)
 
 install(
   FILES
@@ -96,9 +95,3 @@ install(
     ${CMAKE_CURRENT_BINARY_DIR}/phpize
   DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
-
-install(
-  FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/php.pc
-  DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig
-)
