Add initial custom PHP command module

petk · petk · commit 48c5c49c1477 · 2024-10-09T11:11:12.000+02:00
This enables generating files either with PHP found on the system or by
using the built PHP CLI executable.
diff --git a/bin/check-cmake/cmake-includes.sh b/bin/check-cmake/cmake-includes.sh
@@ -88,6 +88,7 @@ modules="
   FindPackageMessage
   ProcessorCount
 
+  PHP/AddCustomCommand
   PHP/CheckAttribute
   PHP/CheckCompilerFlag
   PHP/ConfigureFile
@@ -153,6 +154,7 @@ FindPackageHandleStandardArgs="
 FindPackageMessage="find_package_message"
 ProcessorCount="processorcount"
 
+PHP_AddCustomCommand="php_add_custom_command"
 PHP_CheckAttribute="
   php_check_function_attribute
   php_check_variable_attribute
diff --git a/bin/init.sh b/bin/init.sh
@@ -139,8 +139,12 @@ if test -z "$branch"; then
   case $branch in
     PHP-[0-9]\.[0-9]*)
       ;;
+    master)
+      branch=master
+      ;;
     *)
-      branch="master"
+      echo "Unknown branch. Please, add the '--branch' option" >&2
+      exit 1
       ;;
   esac
 fi
diff --git a/cmake/Zend/CMakeLists.txt b/cmake/Zend/CMakeLists.txt
@@ -49,6 +49,7 @@ include(CheckIncludeFile)
 include(CheckSourceCompiles)
 include(CheckSymbolExists)
 include(CMakePushCheckState)
+include(PHP/AddCustomCommand)
 include(PHP/SearchLibraries)
 
 ################################################################################
@@ -483,18 +484,21 @@ endif()
 # 32-bit targets are not considered development oriented environments, where the
 # files need to be regenerated, executing this script is skipped.
 # See: https://github.com/php/php-src/issues/15899
-if(PHPSystem_EXECUTABLE AND NOT CMAKE_SIZEOF_VOID_P EQUAL 4)
-  add_custom_command(
+if(NOT CMAKE_SIZEOF_VOID_P EQUAL 4)
+  php_add_custom_command(
+    zend_generate_vm
     OUTPUT
       ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_execute.h
-      ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_opcodes.h
+      ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_handlers.h
       ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_opcodes.c
-    COMMAND ${PHPSystem_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_gen.php
+      ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_opcodes.h
     DEPENDS
+      ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_def.h
       ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_execute.skl
       ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_gen.php
-      ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_def.h
-    COMMENT "[Zend] Regenerating zend_vm_execute.h and zend_vm_opcodes.{h,c}"
+    PHP_COMMAND
+      ${CMAKE_CURRENT_SOURCE_DIR}/zend_vm_gen.php
+    COMMENT "[Zend] Regenerating zend_vm_execute.h, zend_vm_handlers.h and zend_vm_opcodes.{h,c}"
     VERBATIM
   )
 endif()
diff --git a/cmake/cmake/modules/PHP/AddCustomCommand.cmake b/cmake/cmake/modules/PHP/AddCustomCommand.cmake
@@ -0,0 +1,111 @@
+#[=============================================================================[
+Add custom command.
+
+This module is built on top of the CMake
+[`add_custom_command`](https://cmake.org/cmake/help/latest/command/add_custom_command.html)
+and [`add_custom_target()`](https://cmake.org/cmake/help/latest/command/add_custom_target.html)
+commands.
+
+A common issue in build systems is the generation of files with the project
+program itself. Here are two main cases:
+* PHP is found on the system: this is the most simple and developer-friendly to
+  use as some files can be generated during the build phase.
+* When PHP is not found on the system, ideally the files could be generated
+  after the PHP CLI binary is built in the current project itself. However, this
+  can quickly bring cyclic dependencies between the target at hand, PHP CLI and
+  the generated files. In such case, inconvenience is that two build steps might
+  need to be done in order to generate the entire project once the file has been
+  regenerated.
+
+This module exposes the following function:
+
+```cmake
+php_add_custom_command(
+  <unique-symbolic-target-name>
+  OUTPUT  ...
+  DEPENDS ...
+  PHP_COMMAND ...
+  [COMMENT <comment>]
+  [VERBATIM]
+)
+```
+
+It acts similar to `add_custom_command()` and `add_custom_target()`, except that
+the DEPENDS argument doesn't add dependencies among targets but instead checks
+their timestamps manually and executes the PHP_COMMAND only when needed.
+
+```cmake
+php_add_custom_command(
+  php_generate_something
+  OUTPUTS
+    list of generated files
+  DEPENDS
+    list of files or targets that this generation depends on
+  PHP_COMMAND
+    ${CMAKE_CURRENT_SOURCE_DIR}/generate-something.php
+  COMMENT "Generate something"
+  VERBATIM
+)
+```
+#]=============================================================================]
+
+include_guard(GLOBAL)
+
+function(php_add_custom_command)
+  cmake_parse_arguments(
+    PARSE_ARGV
+    1
+    parsed                       # prefix
+    "VERBATIM"                   # options
+    "COMMENT"                    # one-value keywords
+    "OUTPUT;DEPENDS;PHP_COMMAND" # multi-value keywords
+  )
+
+  if(parsed_UNPARSED_ARGUMENTS)
+    message(FATAL_ERROR "Bad arguments: ${parsed_UNPARSED_ARGUMENTS}")
+  endif()
+
+  if(NOT ARGV0)
+    message(FATAL_ERROR "1st argument (target name) is missing.")
+  endif()
+
+  set(targetName ${ARGV0})
+
+  if(parsed_VERBATIM)
+    set(verbatim VERBATIM)
+  else()
+    set(verbatim)
+  endif()
+
+  if(PHPSystem_EXECUTABLE)
+    add_custom_command(
+      OUTPUT ${parsed_OUTPUT}
+      COMMAND ${PHPSystem_EXECUTABLE} ${parsed_PHP_COMMAND}
+      DEPENDS ${parsed_DEPENDS}
+      COMMENT "${parsed_COMMENT}"
+      ${verbatim}
+    )
+
+    return()
+  endif()
+
+  if(NOT CMAKE_CROSSCOMPILING)
+    set(PHP_EXECUTABLE "$<TARGET_FILE:php_cli>")
+  elseif(CMAKE_CROSSCOMPILING AND CMAKE_CROSSCOMPILING_EMULATOR)
+    set(PHP_EXECUTABLE "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:php_cli>")
+  else()
+    return()
+  endif()
+
+  add_custom_target(
+    ${targetName} ALL
+    COMMAND ${CMAKE_COMMAND}
+      -D "PHP_EXECUTABLE=${PHP_EXECUTABLE}"
+      -D "OUTPUT=${parsed_OUTPUT}"
+      -D "PHP_COMMAND=${parsed_PHP_COMMAND}"
+      -D "DEPENDS=${parsed_DEPENDS}"
+      -D "COMMENT=${parsed_COMMENT}"
+      -P ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/AddCustomCommand/RunCommand.cmake
+    ${verbatim}
+  )
+endfunction()
diff --git a/cmake/cmake/modules/PHP/AddCustomCommand/RunCommand.cmake b/cmake/cmake/modules/PHP/AddCustomCommand/RunCommand.cmake
@@ -0,0 +1,56 @@
+#[=============================================================================[
+Script for PHP/AddCustomCommand module that loops over output files and their
+dependant input source files and runs the command inside the execute_process().
+
+Expected variables:
+
+* PHP_EXECUTABLE
+* PHP_COMMAND
+* DEPENDS
+* OUTPUT
+* COMMENT
+#]=============================================================================]
+
+if(NOT CMAKE_SCRIPT_MODE_FILE OR NOT PHP_EXECUTABLE OR NOT PHP_COMMAND)
+  return()
+endif()
+
+set(needsUpdate FALSE)
+
+foreach(input ${DEPENDS})
+  if(NOT EXISTS ${input})
+    continue()
+  endif()
+
+  foreach(output ${OUTPUT})
+    if(NOT EXISTS ${output})
+      continue()
+    endif()
+
+    if("${input}" IS_NEWER_THAN "${output}")
+      set(needsUpdate TRUE)
+      break()
+    endif()
+  endforeach()
+
+  if(needsUpdate)
+    break()
+  endif()
+endforeach()
+
+if(NOT needsUpdate)
+  return()
+endif()
+
+if(COMMENT)
+  execute_process(
+    COMMAND
+      ${CMAKE_COMMAND} -E cmake_echo_color --blue --bold "       ${COMMENT}"
+  )
+endif()
+
+execute_process(COMMAND ${PHP_EXECUTABLE} ${PHP_COMMAND})
+
+# Update modification times of output files to not re-run the command on the
+# consecutive build runs.
+file(TOUCH_NOCREATE ${OUTPUT})
diff --git a/cmake/ext/tokenizer/CMakeLists.txt b/cmake/ext/tokenizer/CMakeLists.txt
@@ -1,5 +1,6 @@
 include(CMakeDependentOption)
 include(FeatureSummary)
+include(PHP/AddCustomCommand)
 
 option(EXT_TOKENIZER "Enable the tokenizer extension" ON)
 
@@ -37,91 +38,18 @@ target_sources(
 # The tokenizer extension depends on the generated Zend scanner and parser.
 add_dependencies(php_tokenizer Zend::Zend)
 
-if(PHPSystem_EXECUTABLE)
-  set(PHP_EXECUTABLE ${PHPSystem_EXECUTABLE})
-elseif(NOT CMAKE_CROSSCOMPILING)
-  set(PHP_EXECUTABLE "$<TARGET_FILE:php_cli>")
-elseif(CMAKE_CROSSCOMPILING AND CMAKE_CROSSCOMPILING_EMULATOR)
-  set(PHP_EXECUTABLE "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:php_cli>")
-endif()
-
-if(PHP_EXECUTABLE)
-  # Patch tokenizer_data_gen.php to generate output only when needed.
-  file(READ "${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data_gen.php" content)
-  string(
-    REPLACE
-    [[$infile = __DIR__ . '/../../Zend/zend_language_parser.y';]]
-    "$infile = '${PHP_SOURCE_DIR}/Zend/zend_language_parser.y';"
-    content
-    "${content}"
-  )
-  string(
-    REPLACE
-    [[$outfile_stub = __DIR__ . '/tokenizer_data.stub.php';]]
-    "$outfile_stub =  '${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data.stub.php';"
-    content
-    "${content}"
-  )
-  string(
-    REPLACE
-    [[$outfile_c = __DIR__ . '/tokenizer_data.c';]]
-    "$outfile_c = '${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data.c';"
-    content
-    "${content}"
-  )
-  string(
-    REPLACE
-    [[file_put_contents($outfile_stub, $result);
-
-echo "Wrote $outfile_stub\n";]]
-    [[
-      if (file_exists($outfile_stub)) {
-        $currentContent = file_get_contents($outfile_stub);
-      }
-      if ($currentContent !== $result) {
-        file_put_contents($outfile_stub, $result);
-        echo "Wrote $outfile_stub\n";
-      }
-    ]]
-    content
-    "${content}"
-  )
-  string(
-    REPLACE
-    [[file_put_contents($outfile_c, $result);
-
-echo "Wrote $outfile_c\n";]]
-    [[
-      $currentContent = '';
-      if (file_exists($outfile_c)) {
-        $currentContent = file_get_contents($outfile_c);
-      }
-      if ($currentContent !== $result) {
-        file_put_contents($outfile_c, $result);
-        echo "Wrote $outfile_c\n";
-      }
-    ]]
-    content
-    "${content}"
-  )
-  file(
-    WRITE
-    "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/tokenizer_data_gen.php"
-    "${content}"
-  )
-
-  add_custom_command(
-    OUTPUT
-      php_tokenizer_data
-    COMMAND
-      ${PHP_EXECUTABLE}
-        ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/tokenizer_data_gen.php
-    DEPENDS
-      ${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data_gen.php
-      ${PHP_SOURCE_DIR}/Zend/zend_language_parser.y
-    COMMENT "[ext/tokenizer] Regenerating ext/tokenizer/tokenizer_data.c"
-    VERBATIM
-  )
-  add_custom_target(php_tokenizer_generate_data ALL DEPENDS php_tokenizer_data)
-  set_property(SOURCE php_tokenizer_data PROPERTY SYMBOLIC TRUE)
-endif()
+# Generate tokenizer data source files.
+php_add_custom_command(
+  php_generate_tokenizer_data
+  OUTPUT
+    ${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data.stub.php
+    ${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data.c
+  DEPENDS
+    ${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data_gen.php
+    ${PHP_SOURCE_DIR}/Zend/zend_language_parser.y
+  PHP_COMMAND
+    ${CMAKE_CURRENT_SOURCE_DIR}/tokenizer_data_gen.php
+  COMMENT
+    "[ext/tokenizer] Regenerating tokenizer_data.c and tokenizer_data.stub.php"
+  VERBATIM
+)
diff --git a/cmake/main/CMakeLists.txt b/cmake/main/CMakeLists.txt
@@ -190,6 +190,8 @@ foreach(extension IN LISTS extensions)
   else()
     target_link_libraries(php_main PRIVATE PHP::${extension})
   endif()
+
+  add_dependencies(php_${extension} zend)
 endforeach()
 
 ################################################################################
diff --git a/patches/8.3/php-config.patch b/patches/8.3/php-config.patch
@@ -58,7 +58,7 @@ index 61ee5c1675..1a8d67a783 100644
  
  dnl
 diff --git a/configure.ac b/configure.ac
-index 8784bbf088..49f9094ac4 100644
+index 9c90d92240..88a86e35a5 100644
 --- a/configure.ac
 +++ b/configure.ac
 @@ -1480,6 +1480,9 @@ exec_prefix=$old_exec_prefix
diff --git a/patches/8.5/docs.patch b/patches/8.5/docs.patch
