Use 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.

Additional changes:
- Valgrind find module refactored to include a fix for the parent
  includedir issue
- Valgrind check moved to global configure checks
- When searching for php executable, suffixes are removed as this would
  become too difficult and increases the check time
- HAVE_VALGRIND moved out of find module
- Valgrind imported target needs to be INTERFACE as no library is linked

Author: petk

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

@@ -150,7 +150,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,7 +161,7 @@ else()
   find_library(
     ACL_LIBRARY
     NAMES acl
-    PATHS ${PC_ACL_LIBRARY_DIRS}
+    HINTS ${PC_ACL_LIBRARY_DIRS}
     DOC "The path to the ACL library"
   )
 

cmake/cmake/modules/FindApache.cmake

@@ -145,7 +145,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)
@@ -200,7 +200,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 +215,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 +231,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 +270,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 +283,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)

cmake/cmake/modules/FindAppArmor.cmake

@@ -44,7 +44,7 @@ endif()
 find_path(
   AppArmor_INCLUDE_DIR
   NAMES sys/apparmor.h
-  PATHS ${PC_AppArmor_INCLUDE_DIRS}
+  HINTS ${PC_AppArmor_INCLUDE_DIRS}
   DOC "Directory containing AppArmor library headers"
 )
 
@@ -55,7 +55,7 @@ endif()
 find_library(
   AppArmor_LIBRARY
   NAMES apparmor
-  PATHS ${PC_AppArmor_LIBRARY_DIRS}
+  HINTS ${PC_AppArmor_LIBRARY_DIRS}
   DOC "The path to the AppArmor library"
 )
 

cmake/cmake/modules/FindArgon2.cmake

@@ -43,7 +43,7 @@ endif()
 find_path(
   Argon2_INCLUDE_DIR
   NAMES argon2.h
-  PATHS ${PC_Argon2_INCLUDE_DIRS}
+  HINTS ${PC_Argon2_INCLUDE_DIRS}
   DOC "Directory containing Argon2 library headers"
 )
 
@@ -54,7 +54,7 @@ endif()
 find_library(
   Argon2_LIBRARY
   NAMES argon2
-  PATHS ${PC_Argon2_LIBRARY_DIRS}
+  HINTS ${PC_Argon2_LIBRARY_DIRS}
   DOC "The path to the Argon2 library"
 )
 

cmake/cmake/modules/FindCapstone.cmake

@@ -43,7 +43,7 @@ endif()
 find_path(
   Capstone_INCLUDE_DIR
   NAMES capstone/capstone.h
-  PATHS ${PC_Capstone_INCLUDE_DIRS}
+  HINTS ${PC_Capstone_INCLUDE_DIRS}
   DOC "Directory containing Capstone library headers"
 )
 
@@ -54,7 +54,7 @@ endif()
 find_library(
   Capstone_LIBRARY
   NAMES capstone
-  PATHS ${PC_Capstone_LIBRARY_DIRS}
+  HINTS ${PC_Capstone_LIBRARY_DIRS}
   DOC "The path to the Capstone library"
 )
 

cmake/cmake/modules/FindCdb.cmake

@@ -44,7 +44,7 @@ endif()
 find_path(
   Cdb_INCLUDE_DIR
   NAMES cdb.h
-  PATHS ${PC_Cdb_INCLUDE_DIRS}
+  HINTS ${PC_Cdb_INCLUDE_DIRS}
   DOC "Directory containing cdb library headers"
 )
 
@@ -55,7 +55,7 @@ endif()
 find_library(
   Cdb_LIBRARY
   NAMES cdb
-  PATHS ${PC_Cdb_LIBRARY_DIRS}
+  HINTS ${PC_Cdb_LIBRARY_DIRS}
   DOC "The path to the cdb library"
 )
 

cmake/cmake/modules/FindCrypt.cmake

@@ -92,7 +92,7 @@ else()
   find_path(
     Crypt_INCLUDE_DIR
     NAMES crypt.h unistd.h
-    PATHS ${PC_Crypt_INCLUDE_DIRS}
+    HINTS ${PC_Crypt_INCLUDE_DIRS}
     DOC "Directory containing Crypt library headers"
   )
 
@@ -103,7 +103,7 @@ else()
   find_library(
     Crypt_LIBRARY
     NAMES crypt
-    PATHS ${PC_Crypt_LIBRARY_DIRS}
+    HINTS ${PC_Crypt_LIBRARY_DIRS}
     DOC "The path to the crypt library"
   )
 

cmake/cmake/modules/FindEditline.cmake

@@ -44,7 +44,7 @@ endif()
 find_path(
   Editline_INCLUDE_DIR
   NAMES editline/readline.h
-  PATHS ${PC_Editline_INCLUDE_DIRS}
+  HINTS ${PC_Editline_INCLUDE_DIRS}
   DOC "Directory containing Editline library headers"
 )
 
@@ -55,7 +55,7 @@ endif()
 find_library(
   Editline_LIBRARY
   NAMES edit
-  PATHS ${PC_Editline_LIBRARY_DIRS}
+  HINTS ${PC_Editline_LIBRARY_DIRS}
   DOC "The path to the Editline library"
 )