VCVars¶
生成一个名为 conanvcvars.bat
的文件,该文件通过封装 vcvarsall Microsoft bash 脚本,根据当前设置激活 Visual Studio 开发人员命令提示符。
VCVars
生成器可以在 conanfile 中按名称使用
class Pkg(ConanFile):
generators = "VCVars"
[generators]
VCVars
它也可以在 conanfile 的 generate()
方法中完全实例化
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\Community
,C:\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 类生成器,用于生成一个
conanvcvars.bat
脚本,该脚本激活正确的 Visual Studio 提示符。当认为有必要时,例如,如果使用 CMake
Ninja
生成器和 Visual Studio 编译器进行构建,而这需要一个活动的 Visual Studio 提示符,则此生成器将由其他生成器(如CMakeToolchain
)自动调用。因此,在大多数情况下,没有必要显式实例化此生成器。- 参数:
conanfile –
ConanFile 对象
当前的配方对象。始终使用self
。
- generate(scope='build')¶
创建一个
conanvcvars.bat
文件,该文件调用 Visualvcvars
并带有必要的参数来激活与 Conan 设置匹配的正确 Visual Studio 提示符。- 参数:
scope –
str
激活范围,默认为 “build”。这意味着它将从聚合的通用conanbuild.bat
中添加对此conanvcvars.bat
的调用,这是在self.run()
调用和构建助手(如cmake.configure()
和cmake.build()
)中默认调用的脚本。