Refactor find modules (#9)

Changes:

* Using HINTS instead of PATHS in find modules

  When pkg-config is utilized in find modules, the HINTS has precedence over
  PATHS. Meaning, pkg-config result is tried first and then system or default
  paths. And when <PackageName>_ROOT or CMAKE_PREFIX_PATH are set they have
  precedence over pkg-config.

* Enabled version ranges handling in find modules

* Valgrind:
  * Valgrind find module refactored to include a fix for the parent includedir
    issue.
  * Valgrind's HAVE_VALGRIND variable moved to global configure checks as it is
    more related to the code usage than the find module itself and to have more
    standardized find module.
  * Valgrind imported target needs to be INTERFACE as no library is linked.

* When searching for php executable, suffixes are removed as this would become
  too difficult and increases the check time.

* <PackageName>_INCLUDE_DIRS used for appending INTERFACE_INCLUDE_DIRECTORIES.

* LDAP module now has components

* `<PackageName>_INCLUDE_DIRS` used in most targets to append
  INTERFACE_INCLUDE_DIRECTORIES

* Testing better places for find module sanity checks

* Updated Markdown headers

* s/pkgconf/pkg-config/ for easier understanding

Author: petk

cmake/Zend/cmake/CheckDlsym.cmake

@@ -5,7 +5,7 @@ Some non-ELF platforms, such as OpenBSD, FreeBSD, NetBSD, Mac OSX (~10.3),
 needed underscore character (`_`) prefix for symbols, when using `dlsym()`. This
 module is obsolete on current platforms.
 
-Cache variables:
+## Cache variables
 
 * `DLSYM_NEEDS_UNDERSCORE`
   Whether `dlsym()` requires a leading underscore in symbol names.

cmake/Zend/cmake/CheckFloatPrecision.cmake

@@ -3,7 +3,7 @@ Check for x87 floating point internal precision control.
 
 See: https://wiki.php.net/rfc/rounding
 
-Cache variables:
+## Cache variables
 
 * `HAVE__FPU_SETCW`
   Whether `_FPU_SETCW` is usable.

cmake/Zend/cmake/CheckMMAlignment.cmake

@@ -2,7 +2,7 @@
 Test and set the alignment defines for the Zend memory manager (`ZEND_MM`). This
 also does the logarithmic test.
 
-Cache variables:
+## Cache variables
 
 * `ZEND_MM_ALIGNMENT`
 * `ZEND_MM_ALIGNMENT_LOG2`

cmake/Zend/cmake/CheckStackLimit.cmake

@@ -1,7 +1,7 @@
 #[=============================================================================[
 Check whether the stack grows downwards. Assumes contiguous stack.
 
-Cache variables:
+## Cache variables
 
 * `ZEND_CHECK_STACK_LIMIT`
   Whether checking the stack limit is supported.

cmake/Zend/cmake/CheckStrerrorR.cmake

@@ -2,7 +2,7 @@
 Check for `strerror_r()`, and if its a POSIX-compatible or a GNU-specific
 version.
 
-Cache variables:
+## Cache variables
 
 * `HAVE_STRERROR_R`
   Whether `strerror_r()` is available.

cmake/cmake/ConfigureChecks.cmake

@@ -504,41 +504,6 @@ if(TARGET PHP::CheckGethostbynameR)
   target_link_libraries(php_configuration INTERFACE PHP::CheckGethostbynameR)
 endif()
 
-if(PHP_CCACHE)
-  find_package(Ccache)
-endif()
-
-# Check GCOV.
-if(PHP_GCOV)
-  if(NOT CMAKE_C_COMPILER_ID STREQUAL "GNU")
-    message(FATAL_ERROR "GCC is required for using PHP_GCOV='ON'")
-  endif()
-
-  # Check if ccache is being used.
-  if(CMAKE_C_COMPILER_LAUNCHER MATCHES "ccache")
-    message(
-      WARNING
-      "ccache should be disabled when PHP_GCOV='ON' option is used. You can "
-      "disable ccache by setting option PHP_CCACHE='OFF' or environment "
-      "variable CCACHE_DISABLE=1."
-    )
-  endif()
-
-  find_package(Gcov)
-  set_package_properties(
-    Gcov
-    PROPERTIES
-      TYPE REQUIRED
-      PURPOSE "Necessary to enable GCOV coverage report and symbols."
-  )
-
-  if(TARGET Gcov::Gcov)
-    target_link_libraries(php_configuration INTERFACE Gcov::Gcov)
-
-    gcov_generate_report()
-  endif()
-endif()
-
 ################################################################################
 # Check for required libraries.
 ################################################################################
@@ -820,3 +785,63 @@ block()
     target_link_libraries(php_configuration INTERFACE ${libgcc_path})
   endif()
 endblock()
+
+################################################################################
+# Check for additional tools.
+################################################################################
+
+if(PHP_CCACHE)
+  find_package(Ccache)
+endif()
+
+# Check GCOV.
+if(PHP_GCOV)
+  if(NOT CMAKE_C_COMPILER_ID STREQUAL "GNU")
+    message(FATAL_ERROR "GCC is required for using PHP_GCOV='ON'")
+  endif()
+
+  if(CMAKE_C_COMPILER_LAUNCHER MATCHES "ccache")
+    message(
+      WARNING
+      "ccache should be disabled when PHP_GCOV='ON' option is used. You can "
+      "disable ccache by setting option PHP_CCACHE='OFF' or environment "
+      "variable CCACHE_DISABLE=1."
+    )
+  endif()
+
+  find_package(Gcov)
+  set_package_properties(
+    Gcov
+    PROPERTIES
+      TYPE REQUIRED
+      PURPOSE "Necessary to enable GCOV coverage report and symbols."
+  )
+
+  if(TARGET Gcov::Gcov)
+    target_link_libraries(php_configuration INTERFACE Gcov::Gcov)
+
+    gcov_generate_report()
+  endif()
+endif()
+
+# Check Valgrind.
+if(PHP_VALGRIND)
+  find_package(Valgrind)
+  set_package_properties(
+    Valgrind
+    PROPERTIES
+      TYPE REQUIRED
+      PURPOSE "Necessary to enable Valgrind support."
+  )
+
+  if(Valgrind_FOUND)
+    set(HAVE_VALGRIND 1)
+  endif()
+
+  target_link_libraries(php_configuration INTERFACE Valgrind::Valgrind)
+endif()
+add_feature_info(
+  "Valgrind"
+  PHP_VALGRIND
+  "support for dynamic analysis"
+)

cmake/cmake/Requirements.cmake

@@ -122,21 +122,6 @@ endif()
 ################################################################################
 find_package(Sendmail)
 
-################################################################################
-# Find Valgrind.
-################################################################################
-if(PHP_VALGRIND)
-  find_package(Valgrind)
-  set_package_properties(
-    Valgrind
-    PROPERTIES
-      TYPE REQUIRED
-      PURPOSE "Necessary to enable Valgrind support."
-  )
-
-  target_link_libraries(php_configuration INTERFACE Valgrind::Valgrind)
-endif()
-
 ################################################################################
 # Find PHP installed on the system for generating stub files (*_arginfo.h),
 # Zend/zend_vm_gen.php, ext/tokenizer/tokenizer_data_gen.php and similar where

cmake/cmake/modules/FindACL.cmake

@@ -5,27 +5,25 @@ Module defines the following `IMPORTED` target(s):
 
 * `ACL::ACL` - The package library, if found.
 
-Result variables:
+## Result variables
 
 * `ACL_FOUND` - Whether the package has been found.
 * `ACL_INCLUDE_DIRS` - Include directories needed to use this package.
 * `ACL_LIBRARIES` - Libraries needed to link to the package library.
 * `ACL_VERSION` - Package version, if found.
 
-Cache variables:
+## Cache variables
 
 * `ACL_IS_BUILT_IN` - Whether ACL is a part of the C library (BSD-based
   systems).
 * `ACL_INCLUDE_DIR` - Directory containing package library headers.
 * `ACL_LIBRARY` - The path to the package library.
 
-Hints:
+## Hints
 
-The `ACL_ROOT` variable adds custom search path.
-
-Set `ACL_USE_USER_GROUP` to `TRUE` before calling `find_package(ACL)` to also
-check if the ACL library supports `ACL_USER` and `ACL_GROUP`. For example, macOS
-doesn't have support for user/group.
+* Set `ACL_USE_USER_GROUP` to `TRUE` before calling `find_package(ACL)` to also
+  check if the ACL library supports `ACL_USER` and `ACL_GROUP`. For example,
+  macOS doesn't have support for user/group.
 #]=============================================================================]
 
 include(CheckSourceCompiles)
@@ -141,7 +139,7 @@ if(ACL_IS_BUILT_IN)
 else()
   set(_ACL_REQUIRED_VARS ACL_LIBRARY ACL_INCLUDE_DIR)
 
-  # Use pkgconf, if available on the system.
+  # Try pkg-config.
   find_package(PkgConfig QUIET)
   if(PKG_CONFIG_FOUND)
     pkg_check_modules(PC_ACL QUIET libacl)
@@ -150,7 +148,7 @@ else()
   find_path(
     ACL_INCLUDE_DIR
     NAMES sys/acl.h
-    PATHS ${PC_ACL_INCLUDE_DIRS}
+    HINTS ${PC_ACL_INCLUDE_DIRS}
     DOC "Directory containing ACL library headers"
   )
 
@@ -161,25 +159,18 @@ else()
   find_library(
     ACL_LIBRARY
     NAMES acl
-    PATHS ${PC_ACL_LIBRARY_DIRS}
+    HINTS ${PC_ACL_LIBRARY_DIRS}
     DOC "The path to the ACL library"
   )
 
   if(NOT ACL_LIBRARY)
     string(APPEND _reason "ACL library not found. ")
   endif()
 
-  # Get version.
-  block(PROPAGATE ACL_VERSION)
-    # ACL headers don't provide version. Try pkgconf version, if found.
-    if(PC_ACL_VERSION AND ACL_INCLUDE_DIR)
-      cmake_path(COMPARE "${ACL_INCLUDE_DIR}" EQUAL "${PC_ACL_INCLUDEDIR}" isEqual)
-
-      if(isEqual)
-        set(ACL_VERSION ${PC_ACL_VERSION})
-      endif()
-    endif()
-  endblock()
+  # ACL headers don't provide version. Try pkg-config.
+  if(PC_ACL_VERSION AND ACL_INCLUDE_DIR IN_LIST PC_ACL_INCLUDE_DIRS)
+    set(ACL_VERSION ${PC_ACL_VERSION})
+  endif()
 
   _acl_check(_acl_works)
 
@@ -204,6 +195,7 @@ find_package_handle_standard_args(
     ${_ACL_REQUIRED_VARS}
     _acl_works
   VERSION_VAR ACL_VERSION
+  HANDLE_VERSION_RANGE
   REASON_FAILURE_MESSAGE "${_reason}"
 )
 
@@ -227,11 +219,11 @@ endif()
 if(NOT TARGET ACL::ACL)
   add_library(ACL::ACL UNKNOWN IMPORTED)
 
-  if(ACL_INCLUDE_DIR)
+  if(ACL_INCLUDE_DIRS)
     set_target_properties(
       ACL::ACL
       PROPERTIES
-        INTERFACE_INCLUDE_DIRECTORIES "${ACL_INCLUDE_DIR}"
+        INTERFACE_INCLUDE_DIRECTORIES "${ACL_INCLUDE_DIRS}"
     )
   endif()
 

cmake/cmake/modules/FindApache.cmake

@@ -9,7 +9,7 @@ Module defines the following `IMPORTED` target(s):
 
 * `Apache::Apache` - The package library, if found.
 
-Result variables:
+## Result variables
 
 * `Apache_FOUND` - Whether the package has been found.
 * `Apache_INCLUDE_DIRS` - Include directories needed to use this package.
@@ -19,7 +19,7 @@ Result variables:
 * `Apache_LIBEXECDIR` - Path to the directory containing all Apache modules and
   `httpd.exp` file (list of exported symbols).
 
-Cache variables:
+## Cache variables
 
 * `Apache_APXS_EXECUTABLE` - Path to the APache eXtenSion tool command-line tool
   (`apxs`).
@@ -34,10 +34,6 @@ Cache variables:
 * `Apache_INCLUDE_DIR` - Directory containing package library headers.
 * `Apache_APR_INCLUDE_DIR` - Directory containing `apr` library headers.
 * `Apache_APR_LIBRARY` - The path to the `apr` library.
-
-Hints:
-
-The `Apache_ROOT` variable adds custom search path.
 #]=============================================================================]
 
 include(FeatureSummary)
@@ -145,7 +141,7 @@ endif()
 find_program(
   Apache_APR_CONFIG_EXECUTABLE
   NAMES apr-config apr-1-config
-  PATHS ${_Apache_APR_BINDIR}
+  HINTS ${_Apache_APR_BINDIR}
   DOC "Path to the apr library command-line tool for retrieving metainformation"
 )
 mark_as_advanced(Apache_APR_CONFIG_EXECUTABLE)
@@ -190,8 +186,7 @@ if(Apache_APR_CONFIG_EXECUTABLE)
   )
 endif()
 
-# Find the apr library (Apache portable runtime).
-# Use pkgconf, if available on the system.
+# Try pkg-config.
 find_package(PkgConfig QUIET)
 if(PKG_CONFIG_FOUND)
   pkg_check_modules(PC_Apache_APR QUIET apr-1)
@@ -200,7 +195,7 @@ endif()
 find_path(
   Apache_APR_INCLUDE_DIR
   NAMES apr.h
-  PATHS
+  HINTS
     ${PC_Apache_APR_INCLUDE_DIRS}
     ${_Apache_APR_INCLUDE_DIR}
     ${_Apache_APU_INCLUDE_DIR}
@@ -215,7 +210,7 @@ endif()
 find_library(
   Apache_APR_LIBRARY
   NAMES apr-1
-  PATHS ${PC_Apache_APR_LIBRARY_DIRS}
+  HINTS ${PC_Apache_APR_LIBRARY_DIRS}
   DOC "The path to the apr library"
 )
 mark_as_advanced(Apache_APR_LIBRARY)
@@ -231,7 +226,7 @@ endif()
 find_program(
   Apache_APU_CONFIG_EXECUTABLE
   NAMES apu-config apu-1-config
-  PATHS ${_Apache_APU_BINDIR}
+  HINTS ${_Apache_APU_BINDIR}
   DOC "Path to the Apache Portable Runtime Utilities config command-line tool"
 )
 mark_as_advanced(Apache_APU_CONFIG_EXECUTABLE)
@@ -270,7 +265,7 @@ endif()
 find_program(
   Apache_EXECUTABLE
   NAMES ${_Apache_NAME} apache2
-  PATHS ${_Apache_SBINDIR}
+  HINTS ${_Apache_SBINDIR}
   DOC "Path to the Apache HTTP server command-line utility"
 )
 mark_as_advanced(Apache_EXECUTABLE)
@@ -283,7 +278,7 @@ find_path(
   Apache_INCLUDE_DIR
   NAMES httpd.h
   PATH_SUFFIXES apache2
-  PATHS ${_Apache_APXS_INCLUDE_DIR}
+  HINTS ${_Apache_APXS_INCLUDE_DIR}
   DOC "Directory containing Apache headers"
 )
 mark_as_advanced(Apache_INCLUDE_DIR)
@@ -294,7 +289,7 @@ endif()
 
 # Get Apache version.
 block(PROPAGATE Apache_VERSION)
-  if(Apache_INCLUDE_DIR AND EXISTS ${Apache_INCLUDE_DIR}/ap_release.h)
+  if(EXISTS ${Apache_INCLUDE_DIR}/ap_release.h)
     file(
       STRINGS
       ${Apache_INCLUDE_DIR}/ap_release.h
@@ -397,6 +392,7 @@ find_package_handle_standard_args(
     Apache_APR_INCLUDE_DIR
     Apache_EXECUTABLE
   VERSION_VAR Apache_VERSION
+  HANDLE_VERSION_RANGE
   REASON_FAILURE_MESSAGE "${_reason}"
 )