MSBuildToolchain¶

MSBuildToolchain 是 MSBuild 的工具链生成器。它将生成 MSBuild 属性文件，这些文件可以添加到 Visual Studio 解决方案项目中。此生成器会将当前的包配置、设置和选项转换为 MSBuild 属性文件的语法。

此生成器可在 conanfile 中通过名称使用

conanfile.py¶

class Pkg(ConanFile):
    generators = "MSBuildToolchain"

conanfile.txt¶

[generators]
MSBuildToolchain

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

from conan import ConanFile
from conan.tools.microsoft import MSBuildToolchain

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"

    def generate(self):
        tc = MSBuildToolchain(self)
        tc.generate()

运行 conan install 命令后，MSBuildToolchain 将生成三个文件：

$ conan install . # default is Release
$ conan install . -s build_type=Debug

主文件 *conantoolchain.props*，将添加到项目中。
文件 *conantoolchain_<config>.props*，该文件将根据配置和平台有条件地包含在前面的 *conantoolchain.props* 文件中，例如 *conantoolchain_release_x86.props*。
文件 *conanvcvars.bat*，其中包含 vcvars 调用，用于从命令行或任何其他自动化工具定义构建环境（如果打开 IDE，则可能不需要）。该文件将由 MSBuild.build() 方法自动调用。

每次使用不同配置调用时，都会创建一个新的属性 .props 文件，该文件也会被有条件地包含。这允许安装不同的配置，然后直接从 Visual Studio IDE 中切换它们。

MSBuildToolchain 文件可以配置：

Visual Studio 运行时（*MT/MD/MTd/MDd*），从 Conan 输入设置中获取。
C++ 标准，从 Conan 输入设置中获取。

使用工具链的一个优点是，它们有助于实现与在缓存中创建包时完全相同的本地开发流程构建。

自定义¶

conf¶

MSBuildToolchain 受以下 [conf] 变量影响：

tools.microsoft.msbuildtoolchain:compile_options：一个类似字典的对象，包含要添加到 <ClCompile> 部分的额外编译选项。该字典将被翻译成：<[KEY]>[VALUE]</[KEY]> 格式。
tools.microsoft:winsdk_version：该值将定义工具链文件中的 <WindowsTargetPlatformVersion> 元素。
tools.build:cxxflags：一个额外的 C++ 标志列表，将追加到 <ClCompile> 和 <ResourceCompile> 部分的 <AdditionalOptions> 下。
tools.build:cflags：一个额外的纯 C 标志列表，将追加到 <ClCompile> 和 <ResourceCompile> 部分的 <AdditionalOptions> 下。
tools.build:sharedlinkflags：一个额外的链接器标志列表，将追加到 <Link> 部分的 <AdditionalOptions> 下。
tools.build:exelinkflags：一个额外的链接器标志列表，将追加到 <Link> 部分的 <AdditionalOptions> 下。
tools.build:defines：一个预处理器定义列表，将追加到 <ResourceCompile> 部分的 <PreprocessorDefinitions> 下。

参考¶

class MSBuildToolchain(conanfile)¶

MSBuildToolchain 类生成器

参数:: conanfile – < ConanFile 对象 > 当前配方对象。始终使用 self。

generate()¶: 生成 *conantoolchain.props*、*conantoolchain_<config>.props* 文件，以及（如果 compiler=msvc）*conanvcvars.bat* 文件。在前两种情况下，它们将具有有效的 XML 格式，并包含所有正确的设置，就像任何其他 VS 项目 *.props 文件一样。最后一个文件模拟了 vcvarsall.bat 环境变量脚本。另请参阅 VCVars。

属性¶

properties：添加到生成的 .props 文件中的额外属性。您可以使用键值语法定义属性，如下所示：

from conan import ConanFile
from conan.tools.microsoft import MSBuildToolchain

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"

    def generate(self):
        msbuild = MSBuildToolchain(self)
        msbuild.properties["IncludeExternals"] = "true"
        msbuild.generate()

然后，生成的 *conantoolchain_<config>.props* 文件将在其内容中包含已定义的属性：

<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemDefinitionGroup>
...
</ItemDefinitionGroup>
<PropertyGroup Label="Configuration">
    ...
    <IncludeExternals>true</IncludeExternals>
    ...
</PropertyGroup>
</Project>