feat(Vcvars): Add support for selecting vcvarsall.bat via Vcvars_FIND_VCVARSALL

When Vcvars_FIND_VCVARSALL is enabled, the module uses vcvarsall.bat
instead of architecture-specific scripts. The appropriate arch argument
(x86 or x64), derived from Vcvars_MSVC_ARCH, is automatically appended
when invoking the generated wrapper script.

Author: jcfr

FindVcvars.cmake

@@ -29,6 +29,18 @@ These variables can be used to choose which "vcvars" batch script is looked up.
   the variable :variable:`Vcvars_MSVC_VERSION` is initialized based on the most
   recent version of Visual Studio installed on the system.
 
+.. variable:: Vcvars_FIND_VCVARSALL
+
+  If set to TRUE, forces the module to look up ``vcvarsall.bat`` instead of
+  an architecture-specific script such as ``vcvars64.bat``.
+
+  When enabled, the appropriate architecture argument (e.g., ``x64`` or ``x86``),
+  determined from the value of :variable:`Vcvars_MSVC_ARCH`, is automatically passed
+  to ``vcvarsall.bat`` via the generated wrapper script.
+
+  Default is FALSE.
+
+
 This will define the following variables:
 
 .. variable:: Vcvars_BATCH_FILE
@@ -341,10 +353,14 @@ endfunction()
 function(Vcvars_FindFirstValidMsvcVersion msvc_arch candidate_msvc_versions msvc_version_output_varname batch_file_output_varname)
   _vcvars_message(STATUS "Setting ${msvc_version_output_varname}")
   # which vcvars script ?
-  if(msvc_arch STREQUAL "64")
-    set(_candidate_scripts vcvarsamd64.bat vcvars64.bat)
+  if(Vcvars_FIND_VCVARSALL)
+    set(_candidate_scripts vcvarsall.bat)
   else()
-    set(_candidate_scripts vcvars32.bat)
+    if(msvc_arch STREQUAL "64")
+      set(_candidate_scripts vcvarsamd64.bat vcvars64.bat)
+    else()
+      set(_candidate_scripts vcvars32.bat)
+    endif()
   endif()
   foreach(_candidate_msvc_version IN LISTS candidate_msvc_versions)
     Vcvars_GetVisualStudioPaths(${_candidate_msvc_version} "${msvc_arch}" _paths)
@@ -403,9 +419,15 @@ if(NOT DEFINED Vcvars_MSVC_VERSION)
     endif()
   endif()
 endif()
+
+if(NOT DEFINED Vcvars_FIND_VCVARSALL)
+  set(Vcvars_FIND_VCVARSALL FALSE)
+endif()
+
 if(NOT DEFINED Vcvars_BATCH_FILE)
   set(Vcvars_BATCH_FILE "Vcvars_BATCH_FILE-NOTFOUND")
 endif()
+
 if(NOT DEFINED Vcvars_LAUNCHER)
   set(Vcvars_LAUNCHER "Vcvars_LAUNCHER-NOTFOUND")
 endif()
@@ -416,10 +438,14 @@ if(NOT Vcvars_MSVC_ARCH MATCHES ${_Vcvars_MSVC_ARCH_REGEX})
 endif()
 
 # which vcvars script ?
-if(Vcvars_MSVC_ARCH STREQUAL "64")
-  set(_Vcvars_SCRIPTS vcvarsamd64.bat vcvars64.bat)
+if(Vcvars_FIND_VCVARSALL)
+  set(_Vcvars_SCRIPTS vcvarsall.bat)
 else()
-  set(_Vcvars_SCRIPTS vcvars32.bat)
+  if(Vcvars_MSVC_ARCH STREQUAL "64")
+    set(_Vcvars_SCRIPTS vcvarsamd64.bat vcvars64.bat)
+  else()
+    set(_Vcvars_SCRIPTS vcvars32.bat)
+  endif()
 endif()
 
 # set Vcvars_BATCH_FILE
@@ -457,17 +483,26 @@ endif()
 set(Vcvars_LAUNCHER)
 if(Vcvars_BATCH_FILE)
 
+  set(_vcvarsall_arch )
+  if(Vcvars_FIND_VCVARSALL)
+    if(Vcvars_MSVC_ARCH STREQUAL "64")
+      set(_vcvarsall_arch "x64")
+    elseif(Vcvars_MSVC_ARCH STREQUAL "32")
+      set(_vcvarsall_arch "x86")
+    endif()
+  endif()
   set(_in "${CMAKE_BINARY_DIR}/${CMAKE_FILES_DIRECTORY}/Vcvars_wrapper.bat.in")
   get_filename_component(_basename ${Vcvars_BATCH_FILE} NAME_WE)
   set(_out "${CMAKE_BINARY_DIR}/${CMAKE_FILES_DIRECTORY}/${_basename}_wrapper.bat")
-  file(WRITE ${_in} "call \"@Vcvars_BATCH_FILE@\"
+  file(WRITE ${_in} "call \"@Vcvars_BATCH_FILE@\" @_vcvarsall_arch@
 %*
 ")
   configure_file(${_in} ${_out} @ONLY)
 
   set(Vcvars_LAUNCHER ${_out})
   unset(_in)
   unset(_out)
+  unset(_vcvarsall_arch)
 endif()
 
 # cleanup

tests/CMakeLists.txt

@@ -66,7 +66,13 @@ if(DEFINED REQUESTED_MSVC_VERSION AND NOT FUNCTIONS_ONLY_COMPONENT_REQUESTED)
   list(APPEND requested_vars REQUESTED_MSVC_VERSION)
 endif()
 
+if(DEFINED REQUESTED_FIND_VCVARSALL AND NOT FUNCTIONS_ONLY_COMPONENT_REQUESTED)
+  set(Vcvars_FIND_VCVARSALL ${REQUESTED_FIND_VCVARSALL})
+  list(APPEND requested_vars REQUESTED_FIND_VCVARSALL)
+endif()
+
 foreach(var_suffix IN LISTS
+  FIND_VCVARSALL
   MSVC_ARCH
   MSVC_VERSION
   )
@@ -214,11 +220,13 @@ check_msvc_version_to_vs_version_convert(Vcvars_VS7_MSVC_VERSIONS "7.0")
 check_msvc_version_to_vs_version_convert(Vcvars_VS6_MSVC_VERSIONS "6.0")
 
 if(FUNCTIONS_ONLY_COMPONENT_REQUESTED)
+  check_var_not_defined("Vcvars_FIND_VCVARSALL")
   check_var_not_defined("Vcvars_MSVC_ARCH")
   check_var_not_defined("Vcvars_MSVC_VERSION")
   check_var_not_defined("Vcvars_LAUNCHER")
   check_var_not_defined("Vcvars_LAUNCHER")
 else()
+  check_var_equals("Vcvars_FIND_VCVARSALL" "${EXPECTED_FIND_VCVARSALL}")
   check_var_equals("Vcvars_MSVC_ARCH" "${EXPECTED_MSVC_ARCH}")
   check_var_equals("Vcvars_MSVC_VERSION" "${EXPECTED_MSVC_VERSION}")
 
@@ -304,6 +312,7 @@ add_find_vcvars_test(
     -DEXPECTED_MSVC_VERSION:STRING=${EXPECTED_MSVC_VERSION}
     -DEXPECTED_BATCH_FILENAME:STRING=${EXPECTED_BATCH_FILENAME}
     -DEXPECTED_WRAPPER_FILENAME:STRING=${EXPECTED_WRAPPER_FILENAME}
+    -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
   )
 
 add_find_vcvars_test(
@@ -316,6 +325,7 @@ add_find_vcvars_test(
     -DEXPECTED_MSVC_VERSION:STRING=${EXPECTED_MSVC_VERSION}
     -DEXPECTED_BATCH_FILENAME:STRING=vcvars64.bat
     -DEXPECTED_WRAPPER_FILENAME:STRING=vcvars64_wrapper.bat
+    -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
   )
 
 add_find_vcvars_test(
@@ -328,6 +338,7 @@ add_find_vcvars_test(
     -DEXPECTED_MSVC_VERSION:STRING=${EXPECTED_MSVC_VERSION}
     -DEXPECTED_BATCH_FILENAME:STRING=vcvars32.bat
     -DEXPECTED_WRAPPER_FILENAME:STRING=vcvars32_wrapper.bat
+    -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
   )
 
 add_find_vcvars_test(
@@ -340,5 +351,32 @@ add_find_vcvars_test(
     -DEXPECTED_MSVC_VERSION:STRING=${EXPECTED_MSVC_VERSION}
     -DEXPECTED_BATCH_FILENAME:STRING=${EXPECTED_BATCH_FILENAME}
     -DEXPECTED_WRAPPER_FILENAME:STRING=${EXPECTED_WRAPPER_FILENAME}
+    -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
+  )
+
+add_find_vcvars_test(
+  NAME "find-vcvarsall-ON"
+  OPTIONS
+    # Requested
+    -DREQUESTED_FIND_VCVARSALL:BOOL=ON
+    # Expected
+    -DEXPECTED_MSVC_ARCH:STRING=${EXPECTED_MSVC_ARCH}
+    -DEXPECTED_MSVC_VERSION:STRING=${EXPECTED_MSVC_VERSION}
+    -DEXPECTED_BATCH_FILENAME:STRING=vcvarsall.bat
+    -DEXPECTED_WRAPPER_FILENAME:STRING=vcvarsall_wrapper.bat
+    -DEXPECTED_FIND_VCVARSALL:BOOL=ON
+  )
+
+add_find_vcvars_test(
+  NAME "find-vcvarsall-OFF"
+  OPTIONS
+    # Requested
+    -DREQUESTED_FIND_VCVARSALL:BOOL=OFF
+    # Expected
+    -DEXPECTED_MSVC_ARCH:STRING=${EXPECTED_MSVC_ARCH}
+    -DEXPECTED_MSVC_VERSION:STRING=${EXPECTED_MSVC_VERSION}
+    -DEXPECTED_BATCH_FILENAME:STRING=${EXPECTED_BATCH_FILENAME}
+    -DEXPECTED_WRAPPER_FILENAME:STRING=${EXPECTED_WRAPPER_FILENAME}
+    -DEXPECTED_FIND_VCVARSALL:BOOL=OFF
   )