VCVars

生成一个名为 conanvcvars.bat 的文件,该文件通过封装微软的 vcvarsall 批处理脚本,根据当前设置激活 Visual Studio 开发人员命令提示符。

可以在 conanfiles 中通过名称使用 VCVars 生成器

conanfile.py
class Pkg(ConanFile):
    generators = "VCVars"
conanfile.txt
[generators]
VCVars

并且它也可以在 conanfile 的 generate() 方法中完全实例化

conanfile.py
from conan import ConanFile
from conan.tools.microsoft import VCVars

class Pkg(ConanFile):
    settings = "os", "compiler", "arch", "build_type"
    requires = "zlib/1.2.11", "bzip2/1.0.8"

    def generate(self):
        ms = VCVars(self)
        ms.generate()

定制

conf

VCVars 受以下 [conf] 变量影响

  • tools.microsoft.msbuild:installation_path 指示 Visual Studio 安装文件夹的路径。例如:C:\Program Files (x86)\Microsoft Visual Studio\2019\CommunityC:\Program Files (x86)\Microsoft Visual Studio 14.0 等。

  • tools.microsoft:winsdk_version 在 vcvars 命令行中定义特定的 winsdk 版本。

  • tools.env.virtualenv:powershell 生成一个额外的 conanvcvars.ps1 文件,以便可以从 Powershell 控制台运行它。

参考

class VCVars(conanfile)

VCVars 类生成器,用于生成激活正确 Visual Studio 提示符的 conanvcvars.bat 脚本。

当需要时,此生成器将由其他生成器自动调用,例如 CMakeToolchain。例如,如果使用 Visual Studio 编译器并使用 CMake Ninja 生成器进行构建,则需要激活 Visual Studio 提示符。因此,在大多数情况下不需要显式实例化此生成器。

参数:

conanfileConanFile object 当前的 recipe 对象。总是使用 self

generate(scope='build')

创建一个 conanvcvars.bat 文件,该文件调用 Visual vcvars 并带有必要的参数,以激活与 Conan 设置匹配的正确 Visual Studio 提示符。

参数:

scopestr 激活范围,默认为“build”。这意味着它将从聚合的总 conanbuild.bat 中添加对此 conanvcvars.bat 的调用,conanbuild.bat 是在 self.run() 调用和构建助手(例如 cmake.configure()cmake.build())中默认调用的脚本。