Change internal CACHE variables to local variables

- Setting internal CACHE variables isn't needed in these cases.

- This also fixes ftp and mysqlnd extensions to have entire
  configuration deferred to properly check for the PHP openssl
  extension.

- Some help texts moved to configuration headers.

- Main configuration header improved a bit further.

- Gersemi configuration moved forward with new --config option.

- HAVE_<extension> cache variables are no longer automatically defined
  as this is simply redundant and makes it simpler to manage locally
  and individually on the extension level.

Author: petk

bin/check-cmake.php

@@ -591,7 +591,7 @@ function runGersemi(): int
     }
 
     exec(
-        'gersemi --check --indent 2 --definitions cmake bin -- cmake bin',
+        'gersemi --check --config ' . __DIR__ . '/check-cmake/.gersemirc -- cmake bin',
         $output,
         $status,
     );

bin/check-cmake/.gersemirc

@@ -2,16 +2,10 @@
 #
 # CMake code formatting configuration.
 # See: https://github.com/BlankSpruce/gersemi
-#
-# This is only a template for now, as configuration options are passed manually.
 
-cache: true
-color: true
-definitions: [.]
+definitions: [../../cmake, ., ../../bin]
 indent: 2
 line_length: 80
 list_expansion: favour-inlining
-quiet: false
 unsafe: false
 warn_about_unknown_commands: true
-workers: max

cmake/cmake/modules/PHP/Extensions.cmake

@@ -49,8 +49,7 @@ php_extensions_add(subdirectory)
 * `PHP_ALWAYS_ENABLED_EXTENSIONS`
 
   This global property contains a list of always enabled PHP extensions which
-  don't need the `HAVE_<extension-name>` preprocessor macros defined in the PHP
-  configuration header and can be considered as part of the core PHP engine.
+  can be considered part of the core PHP engine.
 
 * `PHP_EXTENSIONS`
 
@@ -670,13 +669,6 @@ function(_php_extensions_post_configure directory)
     return()
   endif()
 
-  # Define HAVE_<extension-name> symbol for php_config.h.
-  string(TOUPPER "HAVE_${extension}" symbol)
-  set(
-    ${symbol} 1
-    CACHE INTERNAL "Whether to enable the PHP extension '${extension}'."
-  )
-
   get_target_property(extension_type php_${extension} TYPE)
 
   if(NOT extension_type MATCHES "^(MODULE|SHARED)_LIBRARY$")

cmake/ext/date/CMakeLists.txt

@@ -62,7 +62,7 @@ target_compile_definitions(
     HAVE_STRTOLL
 )
 
-set(HAVE_TIMELIB_CONFIG_H 1 CACHE INTERNAL "Whether you have timelib_config.h.")
+set(HAVE_TIMELIB_CONFIG_H 1)
 
 message(STATUS "Creating ext/date/lib/timelib_config.h")
 file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/lib/timelib_config.h [[

cmake/ext/enchant/CMakeLists.txt

@@ -49,10 +49,7 @@ set_package_properties(
 )
 
 if(Enchant_FOUND)
-  set(
-    HAVE_ENCHANT_GET_VERSION 1
-    CACHE INTERNAL "enchant_get_version since 1.6.0"
-  )
+  set(HAVE_ENCHANT_GET_VERSION 1)
 else()
   message(WARNING "Library Enchant 2 not found, trying with Enchant 1")
 

cmake/ext/ftp/CMakeLists.txt

@@ -65,14 +65,22 @@ function(php_ftp_post_configuration)
 
     target_link_libraries(php_ftp PRIVATE OpenSSL::SSL)
 
-    set(HAVE_FTP_SSL 1 CACHE INTERNAL "Whether FTP over SSL is enabled")
+    set(HAVE_FTP_SSL 1)
   endif()
 
   add_feature_info(
     "ext/ftp SSL"
     HAVE_FTP_SSL
     "FTP over SSL support"
   )
+
+  set(HAVE_FTP 1)
+
+  configure_file(
+    ${PhpExtensionFtp_SOURCE_DIR}/config.cmake.h.in
+    ${PhpExtensionFtp_BINARY_DIR}/config.h
+    @ONLY
+  )
 endfunction()
 
 # Run at the end of the configuration.
@@ -81,7 +89,3 @@ cmake_language(
     DIRECTORY ${PHP_SOURCE_DIR}
   CALL php_ftp_post_configuration
 )
-
-set(HAVE_FTP 1)
-
-configure_file(config.cmake.h.in config.h @ONLY)

cmake/ext/gd/CMakeLists.txt

@@ -213,23 +213,12 @@ if(NOT EXT_GD_EXTERNAL)
           libgd/wbmp.h
   )
 
-  set(HAVE_GD_BUNDLED 1 CACHE INTERNAL "Whether the bundled libgd is used")
+  set(HAVE_GD_BUNDLED 1)
 
   # With bundled GD library these are always available.
-  set(
-    HAVE_GD_PNG 1
-    CACHE INTERNAL "Whether the PNG functionality can be used with libgd"
-  )
-
-  set(
-    HAVE_GD_BMP 1
-    CACHE INTERNAL "Whether the BMP functionality can be used with libgd"
-  )
-
-  set(
-    HAVE_GD_TGA 1
-    CACHE INTERNAL "Whether the TGA functionality can be used with libgd"
-  )
+  set(HAVE_GD_PNG 1)
+  set(HAVE_GD_BMP 1)
+  set(HAVE_GD_TGA 1)
 
   target_compile_definitions(
     php_gd
@@ -279,7 +268,7 @@ if(NOT EXT_GD_EXTERNAL)
 
   target_link_libraries(php_gd PRIVATE PNG::PNG)
 
-  set(HAVE_LIBPNG 1 CACHE INTERNAL "Whether the libpng is available")
+  set(HAVE_LIBPNG 1)
 
   if(EXT_GD_AVIF)
     find_package(libavif 0.8.2)
@@ -292,8 +281,8 @@ if(NOT EXT_GD_EXTERNAL)
 
     target_link_libraries(php_gd PRIVATE libavif::libavif)
 
-    set(HAVE_LIBAVIF 1 CACHE INTERNAL "Whether the libavif is available")
-    set(HAVE_GD_AVIF 1 CACHE INTERNAL "Whether the AVIF support is enabled")
+    set(HAVE_LIBAVIF 1)
+    set(HAVE_GD_AVIF 1)
   endif()
 
   if(EXT_GD_WEBP)
@@ -307,8 +296,8 @@ if(NOT EXT_GD_EXTERNAL)
 
     target_link_libraries(php_gd PRIVATE WebP::WebP)
 
-    set(HAVE_LIBWEBP 1 CACHE INTERNAL "Whether the libwebp is available")
-    set(HAVE_GD_WEBP 1 CACHE INTERNAL "Whether the WebP support is enabled")
+    set(HAVE_LIBWEBP 1)
+    set(HAVE_GD_WEBP 1)
   endif()
 
   if(EXT_GD_JPEG)
@@ -322,8 +311,8 @@ if(NOT EXT_GD_EXTERNAL)
 
     target_link_libraries(php_gd PRIVATE JPEG::JPEG)
 
-    set(HAVE_LIBJPEG 1 CACHE INTERNAL "Whether the libjpeg is available")
-    set(HAVE_GD_JPG 1 CACHE INTERNAL "Whether the JPEG support is enabled")
+    set(HAVE_LIBJPEG 1)
+    set(HAVE_GD_JPG 1)
   endif()
 
   if(EXT_GD_XPM)
@@ -337,8 +326,8 @@ if(NOT EXT_GD_EXTERNAL)
 
     target_link_libraries(php_gd PRIVATE XPM::XPM)
 
-    set(HAVE_XPM 1 CACHE INTERNAL "Whether the libXpm library is available")
-    set(HAVE_GD_XPM 1 CACHE INTERNAL "Whether the XPM support is enabled")
+    set(HAVE_XPM 1)
+    set(HAVE_GD_XPM 1)
   endif()
 
   if(EXT_GD_FREETYPE)
@@ -352,27 +341,13 @@ if(NOT EXT_GD_EXTERNAL)
 
     target_link_libraries(php_gd PRIVATE Freetype::Freetype)
 
-    set(
-      HAVE_LIBFREETYPE 1
-      CACHE INTERNAL "Whether the FreeType library is available"
-    )
-
-    set(
-      HAVE_GD_FREETYPE 1
-      CACHE INTERNAL "Whether the FreeType support is enabled"
-    )
+    set(HAVE_LIBFREETYPE 1)
+    set(HAVE_GD_FREETYPE 1)
   endif()
 
   if(EXT_GD_JIS)
-    set(
-      JISX0208 1
-      CACHE INTERNAL "Whether the JIS-mapped Japanese font support is available"
-    )
-
-    set(
-      USE_GD_JISX0208 1
-      CACHE INTERNAL "Whether the JIS-mapped Japanese font support is enabled"
-    )
+    set(JISX0208 1)
+    set(USE_GD_JISX0208 1)
   endif()
 
   # Do sanity check when all required packages are found.

cmake/ext/gettext/CMakeLists.txt

@@ -61,7 +61,7 @@ if(TARGET Intl::Intl)
     )
   endif()
 
-  set(HAVE_LIBINTL 1 CACHE INTERNAL "Whether gettext library is available")
+  set(HAVE_LIBINTL 1)
 
   check_library_exists(Intl::Intl ngettext "" HAVE_NGETTEXT)
   check_library_exists(Intl::Intl dngettext "" HAVE_DNGETTEXT)

cmake/ext/hash/CMakeLists.txt

@@ -26,7 +26,7 @@ if(EXT_HASH_MHASH)
     "Support for mhash in the hash extension is deprecated as of PHP 8.1.0"
   )
 
-  set(PHP_MHASH_BC 1 CACHE INTERNAL "Whether the mhash support is included")
+  set(PHP_MHASH_BC 1)
 endif()
 
 add_library(php_hash STATIC)
@@ -78,7 +78,7 @@ target_sources(
 target_include_directories(php_hash PRIVATE xxhash)
 
 if(WORDS_BIGENDIAN)
-  set(HAVE_SLOW_HASH3 1 CACHE INTERNAL "Whether slow SHA3 algo is used.")
+  set(HAVE_SLOW_HASH3 1)
   message(WARNING "Using slow SHA3 implementation on bigendian")
 else()
   block()

cmake/ext/iconv/CMakeLists.txt

@@ -79,10 +79,7 @@ if(TARGET Iconv::Iconv)
     check_library_exists(Iconv::Iconv libiconv "" HAVE_LIBICONV)
 
     if(HAVE_LIBICONV)
-      set(
-        ICONV_ALIASED_LIBICONV 1
-        CACHE INTERNAL "iconv() is aliased to libiconv()"
-      )
+      set(ICONV_ALIASED_LIBICONV 1)
     else()
       check_library_exists(Iconv::Iconv iconv "" _HAVE_ICONV)
     endif()
@@ -106,11 +103,8 @@ if(TARGET Iconv::Iconv)
   cmake_pop_check_state()
   if(_have_gnu_libiconv)
     message(CHECK_PASS "GNU libiconv")
-    set(HAVE_LIBICONV 1 CACHE INTERNAL "")
-    set(
-      PHP_ICONV_IMPL "libiconv"
-      CACHE INTERNAL "The iconv implementation"
-    )
+    set(HAVE_LIBICONV 1)
+    set(PHP_ICONV_IMPL "libiconv")
   endif()
 
   # Check for glibc implementation.
@@ -123,10 +117,7 @@ if(TARGET Iconv::Iconv)
   endif()
   if(HAVE_GLIBC_ICONV)
     message(CHECK_PASS "GNU C library")
-    set(
-      PHP_ICONV_IMPL "glibc"
-      CACHE INTERNAL "The iconv implementation"
-    )
+    set(PHP_ICONV_IMPL "glibc")
   endif()
 
   # Check for Konstantin Chuguev's iconv implementation.
@@ -139,10 +130,7 @@ if(TARGET Iconv::Iconv)
   endif()
   if(_have_bsd_iconv)
     message(CHECK_PASS "BSD iconv")
-    set(
-      PHP_ICONV_IMPL "BSD iconv"
-      CACHE INTERNAL "The iconv implementation"
-    )
+    set(PHP_ICONV_IMPL "BSD iconv")
   endif()
 
   # Check for IBM iconv implementation.
@@ -155,10 +143,7 @@ if(TARGET Iconv::Iconv)
   endif()
   if(HAVE_IBM_ICONV)
     message(CHECK_PASS "IBM iconv")
-    set(
-      PHP_ICONV_IMPL "IBM iconv"
-      CACHE INTERNAL "The iconv implementation"
-    )
+    set(PHP_ICONV_IMPL "IBM iconv")
   endif()
 
   if(NOT PHP_ICONV_IMPL AND Iconv_IS_BUILT_IN)