Add script for regenerating ext/standard/credits_*.h headers

Author: petk

bin/check-cmake.php

@@ -708,7 +708,7 @@ function checkAll(array $options): int
 {
     $status = 0;
 
-    output($options['script'] . ': Working tree ' . realpath($options['path']));
+    output($options['script'] . ': Working tree ' . $options['path']);
 
     output($options['script'] . ': Checking CMake modules');
     $allCMakeFiles = getAllCMakeFiles($options['path']);

bin/init.cmake

@@ -16,6 +16,10 @@ Usage:
 
 cmake_minimum_required(VERSION 3.25)
 
+if(NOT CMAKE_SCRIPT_MODE_FILE)
+  message(FATAL_ERROR "This is a command-line script.")
+endif()
+
 # The PHP MAJOR.MINOR version currently in development (the master branch).
 set(PHP_DEVELOPMENT_VERSION "8.5")
 

bin/php.cmake

@@ -35,6 +35,10 @@ Usage examples:
 
 cmake_minimum_required(VERSION 3.25)
 
+if(NOT CMAKE_SCRIPT_MODE_FILE)
+  message(FATAL_ERROR "This is a command-line script.")
+endif()
+
 ################################################################################
 # Set default variables.
 ################################################################################

cmake/cmake/scripts/GenerateCredits.cmake

@@ -0,0 +1,63 @@
+#!/usr/bin/env -S cmake -P
+#
+# Command-line script to regenerate the ext/standard/credits_*.h headers from
+# CREDITS files.
+#
+# Run with: `cmake -P cmake/scripts/GenerateCredits.cmake`
+
+if(NOT CMAKE_SCRIPT_MODE_FILE)
+  message(FATAL_ERROR "This is a command-line script.")
+endif()
+
+set(PHP_SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/../../)
+
+if(NOT EXISTS ${PHP_SOURCE_DIR}/ext/standard/credits.h)
+  message(FATAL_ERROR "This script should be run inside the php-src repository")
+endif()
+
+set(template [[
+/*
+                      DO NOT EDIT THIS FILE!
+
+ it has been automatically created by scripts/dev/credits from
+ the information found in the various ext/.../CREDITS and
+ sapi/.../CREDITS files
+
+ if you want to change an entry you have to edit the appropriate
+ CREDITS file instead
+
+*/
+
+]])
+
+file(GLOB credits ${PHP_SOURCE_DIR}/*/*/CREDITS)
+
+foreach(credit ${credits})
+  cmake_path(GET credit PARENT_PATH parent)
+  cmake_path(GET parent PARENT_PATH parent)
+  cmake_path(GET parent FILENAME dir)
+
+  list(APPEND dirs ${dir})
+  file(STRINGS ${credit} lines ENCODING UTF-8)
+  list(GET lines 0 title)
+  list(GET lines 1 authors)
+  list(APPEND ${dir}_credits "CREDIT_LINE(\"${title}\", \"${authors}\")")
+endforeach()
+
+list(REMOVE_DUPLICATES dirs)
+
+foreach(dir ${dirs})
+  list(SORT ${dir}_credits CASE INSENSITIVE)
+  list(JOIN ${dir}_credits ";\n" credits)
+  set(content "${template}${credits};\n")
+
+  if(EXISTS ${PHP_SOURCE_DIR}/ext/standard/credits_${dir}.h)
+    file(READ ${PHP_SOURCE_DIR}/ext/standard/credits_${dir}.h current)
+    if(content STREQUAL "${current}")
+      continue()
+    endif()
+  endif()
+
+  file(WRITE ${PHP_SOURCE_DIR}/ext/standard/credits_${dir}.h "${content}")
+  message("Updated ext/standard/credits_${dir}.h")
+endforeach()

cmake/ext/standard/CMakeLists.txt

@@ -433,6 +433,41 @@ check_symbol_exists(
   HAVE_POSIX_SPAWN_FILE_ACTIONS_ADDCHDIR_NP
 )
 
+################################################################################
+# Regenerate credits_*.h files.
+################################################################################
+
+block()
+  file(GLOB credits ${PHP_SOURCE_DIR}/*/*/CREDITS)
+
+  # The CODEGEN keyword adds the custom command to a global 'codegen' target.
+  set(codegen)
+  if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.31)
+    set(codegen CODEGEN)
+  endif()
+
+  add_custom_command(
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/php_credits.timestamp
+    DEPENDS ${credits}
+    COMMAND
+      ${CMAKE_COMMAND}
+        -E touch ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/php_credits.timestamp
+    COMMAND
+      ${CMAKE_COMMAND} -P ${PHP_SOURCE_DIR}/cmake/scripts/GenerateCredits.cmake
+    COMMENT "Regenerating ext/standard/credits_*.h"
+    VERBATIM
+    ${codegen}
+  )
+
+  add_custom_target(
+    php_standard_credits
+    DEPENDS
+      ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/php_credits.timestamp
+  )
+
+  add_dependencies(php_standard php_standard_credits)
+endblock()
+
 # TODO: Check whether to enable the chroot() function by checking which SAPI is
 # being built.
 set(ENABLE_CHROOT_FUNC 1 CACHE INTERNAL "Whether to enable chroot() function")

cmake/scripts/CMakeLists.txt

@@ -21,6 +21,7 @@ block()
   )
 endblock()
 
+# The php-config and phpize scripts.
 block()
   find_program(
     SED_EXECUTABLE
@@ -37,7 +38,6 @@ block()
     set(SED /usr/bin/sed)
   endif()
 
-  # The php-config script.
   message(STATUS "Creating scripts/php-config")
 
   # Replace the upstream php-config script hardcoded php include directory to a
@@ -87,7 +87,6 @@ block()
     RENAME ${PHP_PROGRAM_PREFIX}php-config${PHP_PROGRAM_SUFFIX}
   )
 
-  # The phpize script.
   message(STATUS "Creating scripts/phpize")
 
   # Replace the upstream phpize script hardcoded php include directory to a