AutotoolsToolchain

AutotoolsToolchain 是 Autotools 的工具链生成器。它将生成包含 Autotools 构建系统可以理解的环境变量定义的 shell 脚本。

这个生成器可以在 conanfile 中按名称使用

conanfile.py

class Pkg(ConanFile):
    generators = "AutotoolsToolchain"

conanfile.txt

[generators]
AutotoolsToolchain

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

from conan import ConanFile
from conan.tools.gnu import AutotoolsToolchain

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

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

生成的文件

它将生成 conanautotoolstoolchain.sh 或 conanautotoolstoolchain.bat 文件

$ conan install conanfile.py # default is Release
$ source conanautotoolstoolchain.sh
# or in Windows
$ conanautotoolstoolchain.bat

这些启动器会将信息附加到 CPPFLAGS、LDFLAGS、CXXFLAGS、CFLAGS 环境变量中，这些变量将设置和选项转换为相应的构建标志，例如 -stdlib=libstdc++、-std=gnu14、架构标志等。它还将 Conan 生成器所在的文件夹附加到 PKG_CONFIG_PATH 环境变量中。

自 Conan 2.4.0 起，在交叉构建环境中，如果构建配置文件在配置变量 tools.build:compiler_executables 中定义了 c 和 cpp 的值，也会设置环境变量 CC_FOR_BUILD 和 CXX_FOR_BUILD。更多信息请参阅conf 部分。

这个生成器还会生成一个名为 conanbuild.conf 的文件，包含两个键

• configure_args: 调用 configure 脚本的参数。

• make_args: 调用 make 脚本的参数。

• autoreconf_args: 调用 autoreconf 脚本的参数。

通过 Autotools 构建助手 使用 conanbuild.conf 文件，可以无缝地使用这些预计算的参数调用 configure 和 make 脚本。

自定义

如果你想改变一些预计算的值，可以在调用 generate() 方法之前修改一些属性

from conan import ConanFile
from conan.tools.gnu import AutotoolsToolchain

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

    def generate(self):
        tc = AutotoolsToolchain(self)
        tc.configure_args.append("--my_argument")
        tc.generate()

• configure_args: 传递给 configure 脚本的附加参数。

  • 默认情况下会传递以下参数

    • --prefix : 默认值为 /。

    • --bindir=${prefix}/bin

    • --sbindir=${prefix}/bin

    • --libdir=${prefix}/lib

    • --includedir=${prefix}/include

    • --oldincludedir=${prefix}/include

    • --datarootdir=${prefix}/res

  • 此外，如果存在 shared 选项，默认会添加

    • --enable-shared、--disable-static 如果 shared==True

    • --disable-shared、--enable-static 如果 shared==False

• make_args (默认为 []): 传递给 make 脚本的附加参数。

• autoreconf_args (默认为 ["--force", "--install"]): 传递给 autoreconf 脚本的附加参数。

• extra_defines (默认为 []): 附加的宏定义（defines）。

• extra_cxxflags (默认为 []): 附加的 cxxflags。

• extra_cflags (默认为 []): 附加的 cflags。

• extra_ldflags (默认为 []): 附加的 ldflags。

• ndebug: 如果 settings.build_type != Debug，则为 “NDEBUG”。

• gcc_cxx11_abi: 如果是 gcc/libstdc++，则为 “_GLIBCXX_USE_CXX11_ABI”。

• libcxx: 根据 settings.compiler.libcxx 计算得到的标志。

• fpic: 如果定义了 options.fpic，则为 True/False。

• cppstd: 根据 settings.compiler.cppstd 计算得到的标志

• arch_flag: 根据 settings.arch 计算得到的标志

• build_type_flags: 根据 settings.build_type 计算得到的标志

• sysroot_flag: 用于将 --sysroot 标志传递给编译器。

• apple_arch_flag: 仅在 Apple 系统上交叉构建时使用。根据 settings.arch 计算得到的标志。

• apple_isysroot_flag: 仅在 Apple 系统上交叉构建时使用。根 SDK 的路径。

• msvc_runtime_flag: 当编译器为 msvc 时根据 settings.compiler.runtime_type 计算得到的标志；或在使用已弃用的 Visual Studio 时根据 settings.compiler.runtime 计算得到的标志。

以下属性是只读的，将包含当前配置和自定义属性的计算值。一些 recipe 可能需要读取它们以根据配置生成自定义构建文件（不严格限于 Autotools）

• defines

• cxxflags

• cflags

• ldflags

from conan import ConanFile
from conan.tools.gnu import AutotoolsToolchain

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    def generate(self):
        tc = AutotoolsToolchain(self)
        # Customize the flags
        tc.extra_cxxflags = ["MyFlag"]
        # Read the computed flags and use them (write custom files etc)
        tc.defines
        tc.cxxflags
        tc.cflags
        tc.ldflags

如果要更改 configure_args 的默认值，请在 layout() 方法中调整 cpp.package 对象

def layout(self):
    ...
    # For bindir and sbindir takes the first value:
    self.cpp.package.bindirs = ["mybin"]
    # For libdir takes the first value:
    self.cpp.package.libdirs = ["mylib"]
    # For includedir and oldincludedir takes the first value:
    self.cpp.package.includedirs = ["myinclude"]
    # For datarootdir takes the first value:
    self.cpp.package.resdirs = ["myres"]

注意

在 package_info() 方法中更改 self.cpp_info 是无效的。

自定义环境

如果你的 Makefile 或 configure 脚本需要 CPPFLAGS、LDFLAGS、CXXFLAGS 或 CFLAGS 之外的其他环境变量，可以在调用 generate() 方法之前自定义它。调用 environment() 方法计算上述变量，然后添加你需要的新变量。environment() 方法返回一个 Environment 对象

from conan import ConanFile
from conan.tools.gnu import AutotoolsToolchain

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

    def generate(self):
        at = AutotoolsToolchain(self)
        env = at.environment()
        env.define("FOO", "BAR")
        at.generate(env)

AutotoolsToolchain 还会从配置文件中的 [conf] 部分读取变量并设置 CXXFLAGS、CFLAGS、LDFLAGS 和 CPPFLAGS。请参阅下面的 conf 参考。

管理 configure_args、make_args 和 autoreconf_args 属性

AutotoolsToolchain 提供了一些辅助方法，以便用户可以添加/更新/删除在 configure_args、make_args 和 autoreconf_args 中定义的值（它们都是字符串列表）。这些方法是

• update_configure_args(updated_flags): 将更改 AutotoolsToolchain.configure_args。

• update_make_args(updated_flags): 将更改 AutotoolsToolchain.make_args。

• update_autoreconf_args(updated_flags): 将更改 AutotoolsToolchain.autoreconf_args。

其中 updated_flags 是一个类似字典的 Python 对象，定义了所有要更改的标志。它遵循以下规则

• 键值对是标志名称及其值，例如，{"--enable-tools": no} 将被翻译为 --enable-tools=no。

• 如果该键没有值，则它将是一个空字符串，例如，{"--disable-verbose": ""} 将被翻译为 --disable-verbose。

• 如果键值是 None，则表示你要从 xxxxxx_args 中删除该标志（请注意，它可以是 configure_args、make_args 或 autoreconf_args），例如，{"--force": None} 将从最终结果中删除该标志。

总而言之，你将

• 添加参数: 如果 updated_flags 中给定的标志在 xxxxxx_args 中尚不存在。

• 更新参数: 如果 updated_flags 中给定的标志在属性 xxxxxx_args 中已存在。

• 删除参数: 如果 updated_flags 中给定的标志在 xxxxxx_args 中已存在且其值为 None。

例如

from conan import ConanFile
from conan.tools.gnu import AutotoolsToolchain

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

    def generate(self):
        at = AutotoolsToolchain(self)
        at.update_configure_args({
            "--new-super-flag": "",  # add new flag '--new-super-flag'
            "--host": "my-gnu-triplet",  # update flag '--host=my-gnu-triplet'
            "--force": None  # remove existing '--force' flag
        })
        at.generate()

AutotoolsToolchain 将监听来自 global.conf 的 tools.gnu:extra_configure_args 以扩展 configure_args 属性。

参考

class AutotoolsToolchain(conanfile, namespace=None, prefix='/')

参数:

• conanfile – 当前的 recipe 对象。始终使用 self。

• namespace – 当同一个 recipe 中有多个工具链调用时，此参数可避免冲突。通过设置此参数，用于向构建助手传递信息的 conanbuild.conf 文件将命名为 <namespace>_conanbuild.conf。默认值为 None，表示生成的文件名为 conanbuild.conf。在 Autotools 构建助手的构造函数中也必须使用相同的值设置此命名空间，以便它从正确的文件中读取信息。

• prefix – 用于 --prefix 参数的文件夹（默认为 “/”）。

update_configure_args(updated_flags)

辅助方法，用于更新/修剪 self.configure_args 中的标志。

参数:

updated_flags – dict，以参数作为键，参数值作为值。请注意，如果参数值为 None，则该参数将被修剪（prune）。

update_make_args(updated_flags)

辅助方法，用于更新/修剪 self.make_args 中的参数。

参数:

updated_flags – dict，以参数作为键，参数值作为值。请注意，如果参数值为 None，则该参数将被修剪（prune）。

update_autoreconf_args(updated_flags)

辅助方法，用于更新/修剪 self.autoreconf_args 中的参数。

参数:

updated_flags – dict，以参数作为键，参数值作为值。请注意，如果参数值为 None，则该参数将被修剪（prune）。

conf

• tools.build:cxxflags 列表，包含将由 CXXFLAGS 使用的额外 C++ 标志。

• tools.build:cflags 列表，包含将由 CFLAGS 使用的额外纯 C 标志。

• tools.build:sharedlinkflags 列表，包含将由 LDFLAGS 使用的额外共享库链接器标志。

• tools.build:exelinkflags 列表，包含将由 LDFLAGS 使用的额外可执行文件链接器标志。

• tools.build:defines 列表，包含将由 CPPFLAGS 使用的预处理器定义。

• tools.build:linker_scripts 链接器脚本列表，每个脚本都将以 -T 为前缀并添加到 LDFLAGS 中。仅在支持使用 -T 标志指定链接器脚本的链接器（例如 ld、gold 和 lld）中使用此标志。

• tools.build:sysroot 定义传递给编译器的 --sysroot 标志。

• tools.android:ndk_path (Conan 2.5.0 新增) 在 Android 交叉编译时用于指定 NDK 路径。它用于在 conanautotoolstoolchain.sh|bat 脚本中设置一些环境变量，如 CC、CXX、LD、STRIP、RANLIB、AS、AR，并且自 Conan 2.11.0 起，还包括 ADDR2LINE、NM、OBJCOPY、OBJDUMP、READELF 和 ELFEDIT，前提是它们尚未在 buildenv 环境中定义。如果它们已在 buildenv 环境中定义，则 conanautotoolstoolchain 文件将不会定义它们，将其定义留给 VirtualBuildEnv 生成器。

• tools.build:compiler_executables 类似字典的 Python 对象，以编译器作为键，编译器可执行文件路径作为值。这些键将按如下方式映射

• tools.gnu:extra_configure_args 参数列表，用于扩展 AutotoolsToolchain 的 configure_args 属性。

  • c: 将在 conanautotoolstoolchain.sh|bat 脚本中设置 CC（如果交叉构建，还会设置 CC_FOR_BUILD）。

  • cpp: 将在 conanautotoolstoolchain.sh|bat 脚本中设置 CXX（如果交叉构建，还会设置 CXX_FOR_BUILD）。

  • rc: 将在 conanautotoolstoolchain.sh|bat 脚本中设置 RC。

  • cuda: 将在 conanautotoolstoolchain.sh|bat 脚本中设置 NVCC。

  • fortran: 将在 conanautotoolstoolchain.sh|bat 脚本中设置 FC。

注意

标志优先级顺序: 在 tools.build 配置中指定的标志，例如 cxxflags、cflags、sharedlinkflags、exelinkflags 和 defines，将始终优先于 AutotoolsToolchain 属性设置的标志。