FindVcvars

Finds a "vcvars" batch script.

This CMake module can be used when configuring a project or when running in cmake -P script mode.

Why this repository ?

Waiting the module is integrated in upstream CMake (most likely CMake 3.13), this repository allows project to easily integrate the module by either copying its content or downloading it.

For reference, the associated merge request is https://gitlab.kitware.com/cmake/cmake/merge_requests/899

Notes

• Anticipate future release of VS 2022 listing MSVC_VERSION up to 1949 as being valid version numbers.

• There is no support for looking up Microsoft Visual C++ Compiler for Python 2.7

Changes

v1.12

• feat(Vcvars): Add support for selecting vcvarsall.bat via Vcvars_FIND_VCVARSALL
• feat(Vcvars): Add support for VC toolset version selection via -vcvars_ver
• chore(Vcvars): Refactor MSVC-to-VS version mapping using Vcvars version lists
• chore(Vcvars): Consolidate support for legacy MSVC versions (VS 6.0, 2002, 2003)
• chore(Vcvars): Simplify logic for auto-discovering Vcvars_MSVC_VERSION
• tests: Fix REQUESTED_* handling and remove redundant logic
• tests: Validate call line in generated launcher script
• tests: Support parallel execution of script and project-mode tests
• fix(Vcvars): Ensure message reflects correct variable being set

v1.11

• feat(vsvars): Refactor vcvars discovery with reusable function

v1.10

• feat(Vcvars): Add MSVC version mappings by toolset and Visual Studio version

v1.9

• feat(Vcvars): Support FunctionsOnly component to skip discovery logic
• ci: Add GitHub Actions workflow to run script-mode tests
• ci: Use src subdir for checkout
• docs: Fix listing of change entries using git
• tests: Add initial test infrastructure for FindVcvars module
• tests: Add script-mode tests with support for requested and expected variables
• tests: Refactor test script to support both script and project modes
• tests: Add add_find_vcvars_test() function to reduce duplication
• tests: Add project-mode tests using fixture-based setup
• tests: Check specifying FunctionsOnly component works as expected

v1.8

• docs: Add changelog insertion placeholder and streamline release instructions
• Update minimum required CMake version from 3.5 to 3.20.6

v1.7

• Add support for msvc version 1940 (Visual Studio 2022)
• Anticipate future VS 2022 releases up to msvc 1950

v1.6

• Update _Vcvars_SUPPORTED_MSVC_VERSIONS anticipating future VS 2022 releases

• Fix typo in comments

v1.5

• Add support for msvc version 1929
• Add initial support for Visual Studio 2022

v1.4

• Add support for MSVC version 1928
• Add support for MSVC version 1927

v1.3

• Add support for MSVC version 1916 through 1926

v1.2

• Add support for Visual Studio 2017 15.8 (msvc version 1915)

v1.1

• Rename Vcvars_WRAPPER_BATCH_FILE to Vcvars_LAUNCHER

Integrating the module in your project

There are few possible approaches:

Approach 1: Download

• Add file cmake/CMakeLists.txt with the following code used to download the module:

# Download FindVcvars.cmake
set(dest_file "${CMAKE_CURRENT_BINARY_DIR}/FindVcvars.cmake")
set(expected_hash "56cbf16b279d9c8481a01e5ff115b9d2429f384377640c1265c2fecf19bcbe92")
set(url "https://raw.githubusercontent.com/scikit-build/cmake-FindVcvars/v1.12/FindVcvars.cmake")
if(NOT EXISTS ${dest_file})
  file(DOWNLOAD ${url} ${dest_file} EXPECTED_HASH SHA256=${expected_hash})
else()
  file(SHA256 ${dest_file} current_hash)
  if(NOT ${current_hash} STREQUAL ${expected_hash})
    file(DOWNLOAD ${url} ${dest_file} EXPECTED_HASH SHA256=${expected_hash})
  endif()
endif()

• Update top-level CMakeLists.txt with:

add_subdirectory(cmake)

• Update CMAKE_MODULE_PATH:

list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_CURRENT_BINARY_DIR}/cmake)

Approach 2: Copy

• Copy FindVcvars.cmake into your source tree making sure you reference the tag (or SHA) in the associated commit message.

• Update CMAKE_MODULE_PATH:

list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

Approach 3: Git submodule

Add this repository as a git submodule.

Maintainers

These instructions below have been tested on a Linux system, they may have to be adapted to work on macOS or Windows.

Creating new release and updating README

• Step 1: List all tags sorted by version and get the latest one

git fetch --tags && \
  git tag -l | sort -V

latest_tag=$(git describe --tags --abbrev=0)
echo "latest_tag [$latest_tag]"

• Step 2: Choose the next release version number and tag the release

tag=vX.Y.Z
git tag -s -m "FindVcvars $tag" $tag

git push origin $tag

• Step 3: Update release and expected_hash in README

cd cmake-FindVcvars

expected_hash=$(git show $tag:FindVcvars.cmake | sha256sum | cut -d" " -f1) && \
sed -E "s/set\(expected_hash.+\)/set\(expected_hash \"$expected_hash\"\)/g" -i README.md && \
sed -E "s/v[0-9](\.[0-9]+)+\/FindVcvars.cmake/$tag\/FindVcvars.cmake/g" -i README.md && \
git add README.md && \
git commit -m "README: Update release and expected_hash"

• Step 4: Extract changelog entries and update the CHANGES section

# Set new_tag to the tag just created in Step 2
new_tag=$tag

# Extract changelog entries, skipping expected README update commit
changelog=$(git log "${latest_tag}..${new_tag}" --pretty=format:"* %s" --reverse |
  grep -v -E "^(\* )?README: Update release and expected_hash")

# Format the changelog block
changelog_entry=$(printf "\n### %s\n\n%s\n" "$new_tag" "$changelog")

# Insert after placeholder
awk -v entry="$changelog_entry" '
  /^<!-- CHANGELOG-INSERT -->/ {
    print;
    print entry;
    next
  }
  { print }
' README.md > README.tmp && mv README.tmp README.md

• Step 5: Amend the commit to include the changelog

git add README.md
git commit --amend --no-edit

• Step 6: Push changes

git push origin master