Fix nits

Author: petk

bin/check-cmake.php

@@ -191,6 +191,7 @@ function getProjectModules(): array
         'FindPackageMessage' => ['find_package_message'],
         'ProcessorCount' => ['processorcount'],
         'PHP/AddCustomCommand' => ['php_add_custom_command'],
+        'PHP/Bison' => ['php_bison', '/find_package\([\n ]*BISON/'],
         'PHP/CheckAttribute' => [
             'php_check_function_attribute',
             'php_check_variable_attribute',
@@ -199,6 +200,7 @@ function getProjectModules(): array
         'PHP/ConfigureFile' => ['php_configure_file'],
         'PHP/Install' => ['php_install'],
         'PHP/PkgConfigGenerator' => ['pkgconfig_generate_pc'],
+        'PHP/Re2c' => ['php_re2c', '/find_package\([\n ]*RE2C/'],
         'PHP/SearchLibraries' => ['php_search_libraries'],
         'PHP/Set' => ['php_set'],
         'PHP/SystemExtensions' => ['PHP::SystemExtensions'],
@@ -273,24 +275,29 @@ function checkCMakeInclude(Iterator $files, array $modules): int
         $content = getCMakeCode($file);
 
         // Check for redundant includes.
-        foreach ($modules as $module => $commands) {
+        foreach ($modules as $module => $patterns) {
             $hasModule = false;
             $moduleEscaped = str_replace('/', '\/', $module);
 
             if (1 === preg_match('/^[ \t]*include[ \t]*\(' . $moduleEscaped . '[ \t]*\)/m', $content)) {
                 $hasModule = true;
             }
 
-            $hasCommand = false;
-            foreach ($commands as $command) {
-                if (
+            $hasPattern = false;
+            foreach ($patterns as $pattern) {
+                if (isRegularExpression($pattern)) {
+                    if (1 === preg_match($pattern, $content)) {
+                        $hasPattern = true;
+                        break;
+                    }
+                } elseif (
                     (
-                        1 === preg_match('/::/', $command)
-                        && 1 === preg_match('/[^A-Za-z0-9_]' . $command . '[^A-Za-z0-9_]/m', $content)
+                        1 === preg_match('/::/', $pattern)
+                        && 1 === preg_match('/[^A-Za-z0-9_]' . $pattern . '[^A-Za-z0-9_]/m', $content)
                     )
-                    || 1 === preg_match('/^[ \t]*' . $command . '[ \t]*\(/m', $content)
+                    || 1 === preg_match('/^[ \t]*' . $pattern . '[ \t]*\(/m', $content)
                 ) {
-                    $hasCommand = true;
+                    $hasPattern = true;
                     break;
                 }
             }
@@ -304,12 +311,12 @@ function checkCMakeInclude(Iterator $files, array $modules): int
                 continue;
             }
 
-            if ($hasModule && !$hasCommand) {
+            if ($hasModule && !$hasPattern) {
                 $status = 1;
                 output("E: redundant include($module) in $file");
             }
 
-            if (!$hasModule && $hasCommand) {
+            if (!$hasModule && $hasPattern) {
                 $status = 1;
                 output("E: missing include($module) in $file");
             }
@@ -319,6 +326,18 @@ function checkCMakeInclude(Iterator $files, array $modules): int
     return $status;
 };
 
+/**
+ * Check if given string is regular expression.
+ */
+function isRegularExpression(string $string): bool
+{
+    set_error_handler(static function () {}, E_WARNING);
+    $isRegularExpression = false !== preg_match($string, '');
+    restore_error_handler();
+
+    return $isRegularExpression;
+}
+
 /**
  * Check for set(<variable>) usages with only one argument. These should be
  * replaced with set(<variable> "").

cmake/Zend/CMakeLists.txt

@@ -523,7 +523,7 @@ if(TARGET Zend::MaxExecutionTimers)
 endif()
 
 ################################################################################
-# Generate lexer and parser files.
+# Generate parser and lexer files.
 ################################################################################
 
 include(cmake/GenerateGrammar.cmake)

cmake/Zend/cmake/GenerateGrammar.cmake

@@ -1,4 +1,4 @@
-# Generate lexer and parser files.
+# Generate parser and lexer files.
 
 if(CMAKE_SCRIPT_MODE_FILE STREQUAL CMAKE_CURRENT_LIST_FILE)
   message(FATAL_ERROR "This file should be used with include().")
@@ -32,9 +32,9 @@ php_bison(
   CODEGEN
 )
 
-# Tweak zendparse to be exported through ZEND_API. This has to be revisited
-# once bison supports foreign skeletons and that bison version is used. Read
-# https://git.savannah.gnu.org/cgit/bison.git/tree/data/README.md for more.
+# Tweak zendparse to be exported through ZEND_API. This has to be revisited if
+# Bison will support foreign skeletons.
+# See: https://git.savannah.gnu.org/cgit/bison.git/tree/data/README.md
 block()
   string(
     CONCAT patch
@@ -79,7 +79,7 @@ block()
     endif()
   ]])
 
-  # Run patch based on whether building or running inside a CMake script.
+  # Run patch based on whether building or running inside a script.
   if(CMAKE_SCRIPT_MODE_FILE)
     cmake_language(EVAL CODE "${patch}")
   else()

cmake/cmake/Configuration.cmake

@@ -259,5 +259,7 @@ set_package_properties(
     DESCRIPTION "Compression library"
 )
 
-# Set base directory for the ExternalProject CMake module across the PHP.
-set_directory_properties(PROPERTIES EP_BASE ${PHP_BINARY_DIR}/_deps/EP)
+# Set base directory for ExternalProject CMake module.
+set_directory_properties(
+  PROPERTIES EP_BASE ${PHP_BINARY_DIR}/CMakeFiles/PHP/ExternalProject
+)

cmake/cmake/modules/FindBISON.cmake

@@ -16,6 +16,6 @@ set_package_properties(
     DESCRIPTION "General-purpose parser generator"
 )
 
-# Include CMake find module. Absolute path prevents the maximum
-# nesting/recursion depth error on some systems, like macOS.
+# Find package with upstream CMake find module. Absolute path prevents the
+# maximum nesting/recursion depth error on some systems, like macOS.
 include(${CMAKE_ROOT}/Modules/FindBISON.cmake)

cmake/cmake/modules/FindRE2C.cmake

@@ -31,6 +31,7 @@ set_package_properties(
 # Find the executable.
 ################################################################################
 
+set(_re2cRequiredVars RE2C_EXECUTABLE)
 set(_reason "")
 
 find_program(
@@ -48,14 +49,15 @@ endif()
 # Check version.
 ################################################################################
 
-block(PROPAGATE RE2C_VERSION _reason)
+block(PROPAGATE RE2C_VERSION _reason _re2cRequiredVars)
   if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.29)
     set(test IS_EXECUTABLE)
   else()
     set(test EXISTS)
   endif()
 
   if(${test} ${RE2C_EXECUTABLE})
+    list(APPEND _re2cRequiredVars RE2C_VERSION)
     execute_process(
       COMMAND ${RE2C_EXECUTABLE} --version
       OUTPUT_VARIABLE version
@@ -65,12 +67,9 @@ block(PROPAGATE RE2C_VERSION _reason)
     )
 
     if(NOT result EQUAL 0)
-      string(APPEND _reason "Command \"${RE2C_EXECUTABLE} --version\" failed. ")
+      string(APPEND _reason "Command '${RE2C_EXECUTABLE} --version' failed. ")
     elseif(version MATCHES "^re2c ([0-9.]+[^\n]+)")
-      find_package_check_version("${CMAKE_MATCH_1}" valid)
-      if(valid)
-        set(RE2C_VERSION "${CMAKE_MATCH_1}")
-      endif()
+      set(RE2C_VERSION "${CMAKE_MATCH_1}")
     else()
       string(APPEND _reason "Invalid version format. ")
     endif()
@@ -79,10 +78,11 @@ endblock()
 
 find_package_handle_standard_args(
   RE2C
-  REQUIRED_VARS RE2C_EXECUTABLE RE2C_VERSION
+  REQUIRED_VARS ${_re2cRequiredVars}
   VERSION_VAR RE2C_VERSION
   HANDLE_VERSION_RANGE
   REASON_FAILURE_MESSAGE "${_reason}"
 )
 
+unset(_re2cRequiredVars)
 unset(_reason)

cmake/cmake/modules/PHP/Bison.cmake

@@ -25,16 +25,15 @@ php_bison(
 )
 ```
 
-This creates a CMake target `<name>` and adds a command that generates parser
-file `<output>` from the given `<input>` template file using the `bison` parser
+This creates a target `<name>` and adds a command that generates parser file
+`<output>` from the given `<input>` template file using the Bison parser
 generator. Relative source file path `<input>` is interpreted as being relative
 to the current source directory. Relative `<output>` file path is interpreted as
 being relative to the current binary directory. If generated files are already
 available (for example, shipped with the released archive), and Bison is not
-found, it will create a custom target but skip the `bison` command-line
-execution.
+found, it will create a target but skip the `bison` command-line execution.
 
-When used in CMake command-line script mode (see `CMAKE_SCRIPT_MODE_FILE`) it
+When used in command-line script mode (see `CMAKE_SCRIPT_MODE_FILE`) it
 generates the parser right away without creating a target.
 
 #### Options
@@ -57,38 +56,36 @@ generates the parser right away without creating a target.
 * `DEPENDS <depends>...` - Optional list of dependent files to regenerate the
   output file.
 
-* `VERBOSE` - This adds the `--verbose` (`-v`) command-line option to and will
-  create extra output file `<parser-output-filename>.output` containing verbose
-  descriptions of the grammar and parser. File will be by default created in the
-  current binary directory.
+* `VERBOSE` - Adds the `--verbose` (`-v`) command-line option and creates extra
+  output file `<parser-output-filename>.output` in the current binary directory.
+  Report contains verbose grammar and parser descriptions.
 
-* `REPORT_FILE <file>` - This adds the `--report-file=<file>` command-line
-  option and will create verbose information report in the specified `<file>`.
-  This option must be used together with the `VERBOSE` option. Relative file
-  path is interpreted as being relative to the current binary directory.
+* `REPORT_FILE <file>` - Adds the `--report-file=<file>` command-line option and
+  creates verbose information report in the specified `<file>`. This option must
+  be used with the `VERBOSE` option. Relative file path is interpreted as being
+  relative to the current binary directory.
 
-* `CODEGEN` - This adds the `CODEGEN` option to the `add_custom_command()` call.
-  Works as of CMake 3.31 when policy `CMP0171` is set to `NEW`, which provides a
-  global CMake `codegen` target for convenience to call only the
-  code-generation-related targets and skip the majority of the build:
+* `CODEGEN` - Adds the `CODEGEN` option to the `add_custom_command()` call. This
+  option is available starting with CMake 3.31 when the policy `CMP0171` is set
+  to `NEW`. It provides a `codegen` target for convenience, allowing to run only
+  code-generation-related targets while skipping the majority of the build:
 
   ```sh
   cmake --build <dir> --target codegen
   ```
 
-* `WORKING_DIRECTORY <working-directory>` - The path where the `bison` is
-  executed. Relative `<working-directory>` path is interpreted as being relative
-  to the current binary directory. If not set, `bison` is by default executed in
-  the `PHP_SOURCE_DIR` when building the php-src repository. Otherwise it is
+* `WORKING_DIRECTORY <directory>` - The path where the `re2c` is executed.
+  Relative `<directory>` path is interpreted as being relative to the current
+  binary directory. If not set, `bison` is by default executed in the
+  `PHP_SOURCE_DIR` when building the php-src repository. Otherwise it is
   executed in the directory of the `<output>` file. If variable
   `PHP_BISON_WORKING_DIRECTORY` is set before calling the `php_bison()` without
   this option, it will set the default working directory to that instead.
 
 * `ABSOLUTE_PATHS` - Whether to use absolute file paths in the `bison`
-  command-line invocations. By default all file paths are added to `bison` as
-  relative to the working directory. Using relative paths is convenient when
-  line directives (`#line ...`) are generated in the output files to not show
-  the full path on the disk, if file is committed to Git repository.
+  command-line invocations. By default all file paths are added as relative to
+  the working directory. Using relative paths is convenient when line directives
+  (`#line ...`) are generated in the output files committed to Git repository.
 
   When this option is enabled:
 
@@ -119,7 +116,7 @@ These variables can be set before using this module to configure behavior:
 
 * `PHP_BISON_WORKING_DIRECTORY` - Set the default global working directory
   for all `php_bison()` invocations in the directory scope where the
-  `WORKING_DIRECTORY <dir>` option is not set.
+  `WORKING_DIRECTORY <directory>` option is not set.
 
 ## Examples
 
@@ -159,9 +156,9 @@ php_bison(foo foo.y foo.c OPTIONS $<$<CONFIG:Debug>:--debug> --yacc)
 #   bison --yacc foo.y --output foo.c
 ```
 
-### Custom target usage
+### Target usage
 
-To specify dependencies with the custom target created by `php_bison()`:
+Target created by `php_bison()` can be used to specify additional dependencies:
 
 ```cmake
 # CMakeLists.txt
@@ -172,29 +169,20 @@ php_bison(foo_parser parser.y parser.c)
 add_dependencies(some_target foo_parser)
 ```
 
-Or to run only the specific `foo_parser` target, which generates the
-parser-related files:
+Running only the `foo_parser` target to generate the parser-related files:
 
 ```sh
 cmake --build <dir> --target foo_parser
 ```
 
 ### Module configuration
 
-To specify minimum required Bison version other than the module's default,
-`find_package(BISON)` can be called before the `php_bison()`:
+To specify different minimum required Bison version than the module's default,
+the `find_package(BISON)` can be called before `php_bison()`:
 
 ```cmake
-find_package(BISON 3.7)
-include(PHP/Bison)
-php_bison(...)
-```
-
-Set `PHP_BISON_*` variables to override module default configuration:
-
-```cmake
-set(PHP_BISON_VERSION_DOWNLOAD 3.7)
 include(PHP/Bison)
+find_package(BISON 3.7)
 php_bison(...)
 ```
 #]=============================================================================]
@@ -204,12 +192,12 @@ php_bison(...)
 ################################################################################
 
 macro(_php_bison_config)
-  # Minimum required bison version.
+  # Minimum required Bison version.
   if(NOT PHP_BISON_VERSION)
     set(PHP_BISON_VERSION 3.0.0)
   endif()
 
-  # If bison is not found on the system, set which version to download.
+  # If Bison is not found on the system, set which version to download.
   if(NOT PHP_BISON_VERSION_DOWNLOAD)
     set(PHP_BISON_VERSION_DOWNLOAD 3.8.2)
   endif()
@@ -354,7 +342,7 @@ function(php_bison name input output)
     BASE_DIRECTORY ${CMAKE_BINARY_DIR}
     OUTPUT_VARIABLE relativePath
   )
-  set(message "[bison] Generating ${relativePath} with Bison ${BISON_VERSION}")
+  set(message "[Bison] Generating ${relativePath} with Bison ${BISON_VERSION}")
 
   if(CMAKE_SCRIPT_MODE_FILE)
     message(STATUS "${message}")
@@ -632,7 +620,6 @@ function(_php_bison_download)
     LOG_INSTALL TRUE
   )
 
-  # Set bison executable.
   ExternalProject_Get_Property(bison INSTALL_DIR)
   set_property(CACHE BISON_EXECUTABLE PROPERTY VALUE ${INSTALL_DIR}/bin/bison)