find_* commands: add control over Windows registry views

Fixes: #22775

1 files changed, 236 insertions, 0 deletions

diff --git a/Tests/RunCMake/find_program/Registry-query.cmake b/Tests/RunCMake/find_program/Registry-query.cmake
new file mode 100644
index 0000000..0e1f2a5
--- /dev/null
+++ b/Tests/RunCMake/find_program/Registry-query.cmake
@@ -0,0 +1,236 @@
+
+# helper function for test validation
+function(CHECK query result expression)
+  cmake_language(EVAL CODE
+    "if (NOT (${expression}))
+       message(SEND_ERROR \"wrong value for query '${query}': '${result}'\")
+     endif()")
+endfunction()
+
+
+cmake_policy(SET CMP0134 NEW)
+
+# HKCU/Software/Classes/CLSID/CMake-Tests/find_program: Query default value
+set(FILE_DIR "[HKCU/Software/Classes/CLSID/CMake-Tests/find_program]")
+set(FILE_DIR2 "[HKCU/Software/Classes/CLSID/CMake-Tests/find_program;(default)]")
+
+unset(result)
+find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR}" "${result}" "result MATCHES \"default.${ARCH}/file.exe$\"")
+
+# query value using special name should be identical to default value
+unset(result)
+find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR2}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR2}" "${result}" "result MATCHES \"default.${ARCH}/file.exe$\"")
+
+unset(result)
+find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW HOST REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR}" "${result}" "result MATCHES \"default.${ARCH}/file.exe$\"")
+# VIEW TARGET should have same value as VIEW HOST
+unset(result2)
+find_program(result2 NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW TARGET REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR}" "${result2}" "result2 STREQUAL result")
+
+if (ARCH STREQUAL "64bit")
+
+  # default view is BOTH so querying any value specific to 32 or 64bit must be found
+  unset(result)
+  find_program(result NAMES file64bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.64bit/file64bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file32bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file32bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.64bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64_32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.64bit/file.exe$\"")
+  unset(result)
+
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32_64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file.exe$\"")
+
+  # check the second view is taken into account
+  unset(result)
+  find_program(result NAMES file32bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64_32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file32bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file64bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32_64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.64bit/file64bit.exe$\"")
+
+  # check the both views are taken into account
+  unset(result)
+  find_program(result NAMES file32bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW BOTH REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file32bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file64bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW BOTH REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.64bit/file64bit.exe$\"")
+
+else() # 32bit
+
+  # no 64bit registry: file not found
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64 NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"result-NOTFOUND$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file.exe$\"")
+
+  # views 64_32 and 32_64 give same result
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64_32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32_64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file.exe$\"")
+
+  # check the both views are usable on 32bit platforms
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW BOTH REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"default.32bit/file.exe$\"")
+
+endif()
+
+# HKCU/Software/Classes/CLSID/CMake-Tests/find_program: Query specific value
+set(FILE_DIR "[{|}HKCU/Software/Classes/CLSID/CMake-Tests/find_program|FILE_DIR]")
+set(FILE_DIR2 "[HKCU\\Software\\Classes\\CLSID\\CMake-Tests\\find_program;FILE_DIR]")
+
+unset(result)
+find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR}" "${result}" "result MATCHES \"/${ARCH}/file.exe$\"")
+
+# query value using special name should be identical to default value
+unset(result)
+find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR2}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR2}" "${result}" "result MATCHES \"/${ARCH}/file.exe$\"")
+
+unset(result)
+find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW HOST REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR}" "${result}" "result MATCHES \"/${ARCH}/file.exe$\"")
+# VIEW TARGET should have same value as VIEW HOST
+unset(result2)
+find_program(result2 NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW TARGET REQUIRED NO_CACHE NO_DEFAULT_PATH)
+check("${FILE_DIR}" "${result2}" "result2 STREQUAL result")
+
+if (ARCH STREQUAL "64bit")
+
+  # default view is BOTH so querying any value specific to 32 or 64bit must be found
+  unset(result)
+  find_program(result NAMES file64bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/64bit/file64bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file32bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file32bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/64bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64_32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/64bit/file.exe$\"")
+  unset(result)
+
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32_64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  # check the second view is taken into account
+  unset(result)
+  find_program(result NAMES file32bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64_32 NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file32bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file64bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32_64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/64bit/file64bit.exe$\"")
+
+  # check the both views are taken into account
+  unset(result)
+  find_program(result NAMES file32bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW BOTH REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file32bit.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file64bit.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW BOTH REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/64bit/file64bit.exe$\"")
+
+else() # 32bit
+
+  # no 64bit registry: file not found
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64 NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"result-NOTFOUND$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 64_32 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW 32_64 REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  # check the both views are taken into account
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW BOTH REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+endif()
+
+if (ARCH STREQUAL "64bit")
+
+  # Check influence of variable CMAKE_SIZEOF_VOID_P
+  set(CMAKE_SIZEOF_VOID_P 8)
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW TARGET REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/64bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW HOST REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/${ARCH}/file.exe$\"")
+
+
+  set(CMAKE_SIZEOF_VOID_P 4)
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW TARGET REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" REGISTRY_VIEW HOST REQUIRED NO_CACHE NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/${ARCH}/file.exe$\"")
+
+  unset(CMAKE_SIZEOF_VOID_P)
+
+
+  # Check influence of CMP0134 policy with OLD value
+  cmake_policy(SET CMP0134 OLD)
+  # CMAKE_SIZEOF_VOID_P is not set, so search first 32bit registry
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" NO_CACHE REQUIRED NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/32bit/file.exe$\"")
+
+  cmake_policy(SET CMP0134 NEW)
+  # CMAKE_SIZEOF_VOID_P is not set, so search first the HOST architecture registry
+  unset(result)
+  find_program(result NAMES file.exe PATHS "${CMAKE_CURRENT_SOURCE_DIR}/${FILE_DIR}" NO_CACHE REQUIRED NO_DEFAULT_PATH)
+  check("${FILE_DIR}" "${result}" "result MATCHES \"/${ARCH}/file.exe$\"")
+
+endif()