feat(Vcvars): Add support for VC toolset version selection via -vcvars_ver

Introduce `Vcvars_PLATFORM_TOOLSET_VERSION`, passed to `vcvarsall.bat` using
the `-vcvars_ver=...` argument when `Vcvars_FIND_VCVARSALL` is TRUE.

By default:
- If `CMAKE_VS_PLATFORM_TOOLSET_VERSION` is set, its value (e.g., 14.28.29910)
  is used directly.
- Otherwise, a default value (e.g., 14.3) is derived from `Vcvars_MSVC_VERSION`
  using a known mapping.

Adds `Vcvars_ConvertMsvcVersionToVcToolsetVersion()` and corresponding test
coverage for all known MSVC versions.

Author: jcfr

.github/workflows/ci.yml

@@ -27,6 +27,7 @@ jobs:
             expected-msvc-version: 1949 # Visual Studio 17 2022
             expected-batch-filename: "vcvars64.bat"
             expected-wrapper-filename: "vcvars64_wrapper.bat"
+            expected-platform-toolset-version: "14.3"
 
     name: Tests on ${{ matrix.os }}
     steps:
@@ -49,6 +50,7 @@ jobs:
           -DEXPECTED_MSVC_VERSION:STRING=${{ matrix.expected-msvc-version }} `
           -DEXPECTED_BATCH_FILENAME:STRING=${{ matrix.expected-batch-filename }} `
           -DEXPECTED_WRAPPER_FILENAME:STRING=${{ matrix.expected-wrapper-filename }} `
+          -DEXPECTED_PLATFORM_TOOLSET_VERSION:STRING=${{ matrix.expected-platform-toolset-version }} `
           -S src/tests `
           -B build
 

FindVcvars.cmake

@@ -40,6 +40,21 @@ These variables can be used to choose which "vcvars" batch script is looked up.
 
   Default is FALSE.
 
+.. variable:: Vcvars_PLATFORM_TOOLSET_VERSION
+
+  The version of the Visual C++ toolset passed to ``vcvarsall.bat``
+  via the ``-vcvars_ver=`` argument.
+
+  If not explicitly set, this variable is initialized as follows:
+
+  * If :variable:`CMAKE_VS_PLATFORM_TOOLSET_VERSION` is defined, its full value
+    (e.g., ``14.28.29910``) is used directly.
+  * Otherwise, a simplified version (e.g., ``14.3``) is derived from
+    :variable:`Vcvars_MSVC_VERSION` using a known mapping provided by
+    :command:`Vcvars_ConvertMsvcVersionToVcToolsetVersion`.
+
+  Only used when :variable:`Vcvars_FIND_VCVARSALL` is ``TRUE``.
+
 
 This will define the following variables:
 
@@ -109,6 +124,24 @@ This module also defines the following functions
     The name of the variable to be set with the Visual Studio version.
 
 
+.. command:: Vcvars_ConvertMsvcVersionToVcToolsetVersion
+
+  Converts an MSVC version number (e.g., ``1931``) to its corresponding
+  Visual C++ toolset version (e.g., ``14.3``).
+
+  The result is suitable for use in the ``-vcvars_ver=`` argument
+  passed to ``vcvarsall.bat``.
+
+  This function currently returns toolset versions with only a single
+  digit after the decimal point. For more specific control (e.g.,
+  ``14.28.29910``), use :variable:`CMAKE_VS_PLATFORM_TOOLSET_VERSION`
+  or set :variable:`Vcvars_PLATFORM_TOOLSET_VERSION` explicitly.
+
+  ::
+
+    Vcvars_ConvertMsvcVersionToVcToolsetVersion(<msvc_version> <output_var>)
+
+
 .. command:: Vcvars_FindFirstValidMsvcVersion
 
   The `Vcvars_FindFirstValidMsvcVersion()` function identifies the first MSVC version from a list of candidates that has an associated and discoverable `vcvars` batch script::
@@ -293,6 +326,40 @@ function(Vcvars_ConvertMsvcVersionToVsVersion msvc_version output_var)
   set(${output_var} ${vs_version} PARENT_SCOPE)
 endfunction()
 
+function(Vcvars_ConvertMsvcVersionToVcToolsetVersion msvc_version output_var)
+  if(NOT msvc_version MATCHES ${_Vcvars_MSVC_VERSION_REGEX})
+    message(FATAL_ERROR "msvc_version is expected to match `${_Vcvars_MSVC_VERSION_REGEX}`")
+  endif()
+  if(msvc_version IN_LIST Vcvars_TOOLSET_143_MSVC_VERSIONS) # VS 2022
+    set(vc_toolset_version "14.3")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_142_MSVC_VERSIONS) # VS 2019
+    set(vc_toolset_version "14.2")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_141_MSVC_VERSIONS) # VS 2017
+    set(vc_toolset_version "14.1")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_140_MSVC_VERSIONS) # VS 2015
+    set(vc_toolset_version "14.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_120_MSVC_VERSIONS) # VS 2013
+    set(vc_toolset_version "12.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_110_MSVC_VERSIONS) # VS 2012
+    set(vc_toolset_version "11.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_100_MSVC_VERSIONS) # VS 2010
+    set(vc_toolset_version "10.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_90_MSVC_VERSIONS) # VS 2008
+    set(vc_toolset_version "9.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_80_MSVC_VERSIONS) # VS 2005
+    set(vc_toolset_version "8.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_71_MSVC_VERSIONS) # VS 2003
+    set(vc_toolset_version "7.1")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_70_MSVC_VERSIONS) # VS 2002
+    set(vc_toolset_version "7.0")
+  elseif(msvc_version IN_LIST Vcvars_TOOLSET_60_MSVC_VERSIONS) # VS 6.0
+    set(vc_toolset_version "6.0")
+  else()
+    message(FATAL_ERROR "failed to convert msvc_version [${msvc_version}] to VC toolset version. It is not a known version number.")
+  endif()
+  set(${output_var} ${vc_toolset_version} PARENT_SCOPE)
+endfunction()
+
 function(Vcvars_GetVisualStudioPaths msvc_version msvc_arch output_var)
 
   if(NOT msvc_version MATCHES ${_Vcvars_MSVC_VERSION_REGEX})
@@ -452,6 +519,22 @@ if(NOT DEFINED Vcvars_MSVC_VERSION)
   unset(_msvc_version)
 endif()
 
+if(NOT DEFINED Vcvars_PLATFORM_TOOLSET_VERSION)
+  if(DEFINED CMAKE_VS_PLATFORM_TOOLSET_VERSION)
+    set(Vcvars_PLATFORM_TOOLSET_VERSION ${CMAKE_VS_PLATFORM_TOOLSET_VERSION})
+    # Display message only once in config mode
+    if(NOT DEFINED Vcvars_BATCH_FILE)
+      _vcvars_message(STATUS "Setting Vcvars_PLATFORM_TOOLSET_VERSION to '${Vcvars_PLATFORM_TOOLSET_VERSION}' as CMAKE_VS_PLATFORM_TOOLSET_VERSION was '${CMAKE_VS_PLATFORM_TOOLSET_VERSION}'")
+    endif()
+  elseif(DEFINED Vcvars_MSVC_VERSION)
+    Vcvars_ConvertMsvcVersionToVcToolsetVersion(${Vcvars_MSVC_VERSION} Vcvars_PLATFORM_TOOLSET_VERSION)
+    # Display message only once in config mode
+    if(NOT DEFINED Vcvars_BATCH_FILE)
+      _vcvars_message(STATUS "Setting Vcvars_PLATFORM_TOOLSET_VERSION to '${Vcvars_PLATFORM_TOOLSET_VERSION}' as Vcvars_MSVC_VERSION was '${Vcvars_MSVC_VERSION}'")
+    endif()
+  endif()
+endif()
+
 if(NOT DEFINED Vcvars_BATCH_FILE AND DEFINED Vcvars_MSVC_VERSION)
   Vcvars_FindFirstValidMsvcVersion(
     "${Vcvars_MSVC_ARCH}"
@@ -474,17 +557,21 @@ endif()
 if(Vcvars_BATCH_FILE)
 
   set(_vcvarsall_arch )
+  set(_vcvarsall_vcvars_ver )
   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()
+    if(DEFINED Vcvars_PLATFORM_TOOLSET_VERSION)
+      set(_vcvarsall_vcvars_ver "-vcvars_ver=${Vcvars_PLATFORM_TOOLSET_VERSION}")
+    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@\" @_vcvarsall_arch@
+  file(WRITE ${_in} "call \"@Vcvars_BATCH_FILE@\" @_vcvarsall_arch@ @_vcvarsall_vcvars_ver@
 %*
 ")
   configure_file(${_in} ${_out} @ONLY)
@@ -507,6 +594,7 @@ find_package_handle_standard_args(Vcvars
     Vcvars_LAUNCHER
     Vcvars_MSVC_VERSION
     Vcvars_MSVC_ARCH
+    Vcvars_PLATFORM_TOOLSET_VERSION
   FAIL_MESSAGE
     "Failed to find vcvars scripts for Vcvars_MSVC_VERSION [${Vcvars_MSVC_VERSION}] and Vcvars_MSVC_ARCH [${Vcvars_MSVC_ARCH}]"
   )

tests/CMakeLists.txt

@@ -7,6 +7,7 @@ foreach(var_name IN ITEMS
   EXPECTED_MSVC_VERSION
   EXPECTED_BATCH_FILENAME
   EXPECTED_WRAPPER_FILENAME
+  EXPECTED_PLATFORM_TOOLSET_VERSION
   )
   if(NOT DEFINED ${var_name})
     message(FATAL_ERROR "Variable ${var_name} is not specified using -D${var_name}=<value>")
@@ -34,6 +35,7 @@ set(expected_vars
   EXPECTED_MSVC_VERSION
   EXPECTED_BATCH_FILENAME
   EXPECTED_WRAPPER_FILENAME
+  EXPECTED_PLATFORM_TOOLSET_VERSION
   )
 foreach(var_name IN LISTS expected_vars)
   if(NOT DEFINED ${var_name})
@@ -54,6 +56,7 @@ foreach(var_suffix IN ITEMS
   FIND_VCVARSALL
   MSVC_ARCH
   MSVC_VERSION
+  PLATFORM_TOOLSET_VERSION
   )
   if(DEFINED REQUESTED_${var_suffix} AND NOT FUNCTIONS_ONLY_COMPONENT_REQUESTED)
     set(Vcvars_${var_suffix} ${REQUESTED_${var_suffix}})
@@ -128,6 +131,7 @@ endfunction()
 set(output_vars
   Vcvars_MSVC_ARCH
   Vcvars_MSVC_VERSION
+  Vcvars_PLATFORM_TOOLSET_VERSION
   Vcvars_BATCH_FILE
   Vcvars_LAUNCHER
   )
@@ -141,6 +145,7 @@ message(STATUS "")
 check_var_equals("Vcvars_FOUND" "TRUE")
 
 check_function_defined("Vcvars_ConvertMsvcVersionToVsVersion")
+check_function_defined("Vcvars_ConvertMsvcVersionToVcToolsetVersion")
 check_function_defined("Vcvars_GetVisualStudioPaths")
 check_function_defined("Vcvars_FindFirstValidMsvcVersion")
 
@@ -198,16 +203,43 @@ check_msvc_version_to_vs_version_convert(Vcvars_VS71_MSVC_VERSIONS "7.1")
 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")
 
+function(check_msvc_version_to_vc_toolset_version_convert msvc_versions_var expected_vc_toolset_version)
+  foreach(msvc_version IN LISTS ${msvc_versions_var})
+    Vcvars_ConvertMsvcVersionToVcToolsetVersion("${msvc_version}" output_var)
+    if(NOT "${output_var}" STREQUAL "${expected_vc_toolset_version}")
+      message(FATAL_ERROR "Vcvars_ConvertMsvcVersionToVcToolsetVersion failed for msvc_version [${msvc_version}]
+       current_value [${output_var}]
+      expected_value [${expected_vc_toolset_version}]
+      ")
+    endif()
+  endforeach()
+endfunction()
+
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS17_MSVC_VERSIONS "14.3")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS16_MSVC_VERSIONS "14.2")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS15_MSVC_VERSIONS "14.1")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS14_MSVC_VERSIONS "14.0")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS12_MSVC_VERSIONS "12.0")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS11_MSVC_VERSIONS "11.0")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS10_MSVC_VERSIONS "10.0")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS9_MSVC_VERSIONS "9.0")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS8_MSVC_VERSIONS "8.0")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS71_MSVC_VERSIONS "7.1")
+check_msvc_version_to_vc_toolset_version_convert(Vcvars_VS7_MSVC_VERSIONS "7.0")
+check_msvc_version_to_vc_toolset_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_PLATFORM_TOOLSET_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}")
+  check_var_equals("Vcvars_PLATFORM_TOOLSET_VERSION" "${EXPECTED_PLATFORM_TOOLSET_VERSION}")
 
   check_file_exists("Vcvars_BATCH_FILE")
   check_filename_matches("Vcvars_BATCH_FILE" "${EXPECTED_BATCH_FILENAME}")
@@ -292,6 +324,7 @@ add_find_vcvars_test(
     -DEXPECTED_BATCH_FILENAME:STRING=${EXPECTED_BATCH_FILENAME}
     -DEXPECTED_WRAPPER_FILENAME:STRING=${EXPECTED_WRAPPER_FILENAME}
     -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=${EXPECTED_PLATFORM_TOOLSET_VERSION}
   )
 
 add_find_vcvars_test(
@@ -305,6 +338,7 @@ add_find_vcvars_test(
     -DEXPECTED_BATCH_FILENAME:STRING=vcvars64.bat
     -DEXPECTED_WRAPPER_FILENAME:STRING=vcvars64_wrapper.bat
     -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=${EXPECTED_PLATFORM_TOOLSET_VERSION}
   )
 
 add_find_vcvars_test(
@@ -318,6 +352,7 @@ add_find_vcvars_test(
     -DEXPECTED_BATCH_FILENAME:STRING=vcvars32.bat
     -DEXPECTED_WRAPPER_FILENAME:STRING=vcvars32_wrapper.bat
     -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=${EXPECTED_PLATFORM_TOOLSET_VERSION}
   )
 
 add_find_vcvars_test(
@@ -331,6 +366,7 @@ add_find_vcvars_test(
     -DEXPECTED_BATCH_FILENAME:STRING=${EXPECTED_BATCH_FILENAME}
     -DEXPECTED_WRAPPER_FILENAME:STRING=${EXPECTED_WRAPPER_FILENAME}
     -DEXPECTED_FIND_VCVARSALL:BOOL=FALSE
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=${EXPECTED_PLATFORM_TOOLSET_VERSION}
   )
 
 add_find_vcvars_test(
@@ -344,6 +380,7 @@ add_find_vcvars_test(
     -DEXPECTED_BATCH_FILENAME:STRING=vcvarsall.bat
     -DEXPECTED_WRAPPER_FILENAME:STRING=vcvarsall_wrapper.bat
     -DEXPECTED_FIND_VCVARSALL:BOOL=ON
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=${EXPECTED_PLATFORM_TOOLSET_VERSION}
   )
 
 add_find_vcvars_test(
@@ -357,5 +394,20 @@ add_find_vcvars_test(
     -DEXPECTED_BATCH_FILENAME:STRING=${EXPECTED_BATCH_FILENAME}
     -DEXPECTED_WRAPPER_FILENAME:STRING=${EXPECTED_WRAPPER_FILENAME}
     -DEXPECTED_FIND_VCVARSALL:BOOL=OFF
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=${EXPECTED_PLATFORM_TOOLSET_VERSION}
   )
 
+add_find_vcvars_test(
+  NAME "set-toolset"
+  OPTIONS
+    # Requested
+    -DREQUESTED_FIND_VCVARSALL:BOOL=ON
+    -DREQUESTED_PLATFORM_TOOLSET_VERSION:STRING=14.2
+    # 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
+    -DEXPECTED_PLATFORM_TOOLSET_VERSION:BOOL=14.2
+  )