cc_common

每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6
用于 C++ 编译、链接和命令行生成的实用程序。

成员

action_is_enabled

bool cc_common.action_is_enabled(feature_configuration, action_name)

如果指定 action_config 在功能配置中处于启用状态，则返回 True。

参数

参数 说明
feature_configuration 必需
要查询的功能配置。
action_name 必需
action_config 的名称。

CcToolchainInfo

Provider cc_common.CcToolchainInfo

用于检索包含有关所用 C++ 工具链信息的提供程序的键

compile

tuple cc_common.compile(actions, feature_configuration, cc_toolchain, srcs=[], public_hdrs=[], private_hdrs=[], includes=[], quote_includes=[], system_includes=[], framework_includes=[], defines=[], local_defines=[], include_prefix='', strip_include_prefix='', user_compile_flags=[], conly_flags=[], cxx_flags=[], compilation_contexts=[], name, disallow_pic_outputs=False, disallow_nopic_outputs=False, additional_inputs=[])

应用于 C++ 编译。返回 (CompilationContext, CcCompilationOutputs) 元组。

参数

参数 说明
actions 必需
actions 对象。
feature_configuration 必需
要查询的 feature_configuration。
cc_toolchain 必需
要使用的CcToolchainInfo提供程序。
srcs 默认值为 []
要编译的源文件列表。
public_hdrs 默认值为 []
编译 src 所需的标头列表，可能会通过依赖规则以传递方式包含。
private_hdrs 默认值为 []
编译 src 所需的标头列表，不应包含在依赖规则中。
includes 序列；或 depset； 默认值为 []
通过尖括号和引号引用的头文件的搜索路径。通常使用 -I 传递。以传递方式传播到依赖项。
quote_includes 默认值为 []
以英文引号引用的头文件的搜索路径，例如 #include "foo/bar/header.h"。它们可以是相对于执行根的相对路径，也可以是绝对路径。通常使用 -iquote 传递。以传递方式传播到依赖项。
system_includes 默认值为 []
尖括号（例如 #include <foo/bar/header.h>）引用的头文件的搜索路径。这些路径可以是相对于执行根目录的相对路径，也可以是绝对路径。通常通过 -isystem 传递。以传递方式传播到依赖项。
framework_includes 默认值为 []
Apple 框架中头文件的搜索路径。它们可以是相对于执行根的相对路径，也可以是绝对路径。通常使用 -F 传递。以传递方式传播到依赖项。
defines 默认值为 []
编译相应目标所需的定义集。每个 define 都是一个字符串。以传递方式传播到依赖项。
local_defines 默认值为 []
编译相应目标所需的定义集。每个 define 都是一个字符串。不会传递性地传播到依赖项。
include_prefix 默认值为 ''
要添加到相应规则的标头路径的前缀。设置后，此规则的 hdrs 属性中的标头可通过以下方式访问：将此属性的值附加到其相对于代码库的路径。在添加此属性之前，系统会先移除 strip_include_prefix 属性中的前缀。
strip_include_prefix 默认值为 ''
要从此规则的标头路径中剥离的前缀。设置后，此规则的 hdrs 属性中的标头可在其路径上访问，但会截断此路径前缀。如果它是相对路径，则会被视为软件包相对路径。如果它是绝对路径，则会被理解为相对于代码库的路径。include_prefix 属性中的前缀是在剥离此前缀后添加的。
user_compile_flags 默认值为 []
其他编译选项的列表。
conly_flags 默认值为 []
C 编译的其他编译选项列表。
cxx_flags 默认值为 []
C++ 编译的其他编译选项列表。
compilation_contexts 默认值为 []
用于编译的依赖项中的头文件。
name 必需
用于命名此方法创建的操作的输出制品。另请参阅 `main_output` 实参。
disallow_pic_outputs 默认值为 False
是否应创建 PIC 输出。
disallow_nopic_outputs 默认值为 False
是否应创建 NOPIC 输出。
additional_inputs 默认值为 []
编译 src 所需的其他文件的列表

configure_features

FeatureConfiguration cc_common.configure_features(ctx=None, cc_toolchain, language=None, requested_features=[], unsupported_features=[])

创建 feature_configuration 实例。需要 cpp 配置 fragment。

参数

参数 说明
ctx ctx；或 None； 默认值为 None
规则上下文。
cc_toolchain 必需
要为其配置功能的 cc_toolchain。
language 字符串；或 None； 默认值为 None
要配置的语言：c++ 或 objc（默认值为 c++）
requested_features 默认值为 []
要启用的功能列表。
unsupported_features 默认值为 []
当前规则不支持的功能列表。

create_cc_toolchain_config_info

CcToolchainConfigInfo cc_common.create_cc_toolchain_config_info(ctx, features=[], action_configs=[], artifact_name_patterns=[], cxx_builtin_include_directories=[], toolchain_identifier, host_system_name=None, target_system_name, target_cpu, target_libc, compiler, abi_version=None, abi_libc_version=None, tool_paths=[], make_variables=[], builtin_sysroot=None, cc_target_os=None)

创建 CcToolchainConfigInfo 提供方

参数

参数 说明
ctx 必需
规则上下文。
features 默认值为 []
包含一项功能的所有标志规范。

参数：

name：功能的名称。您可以通过向工具链添加“feature”部分，并在 BUILD 文件中添加相应的字符串作为功能，从而在不更改 Bazel 的情况下引入功能。

enabled：如果为“True”，则除非规则类型明确标记为不支持，否则此功能处于启用状态。

flag_sets：FlagSet 列表。如果给定的功能已启用，则系统会为指定的操作应用标志集。

env_sets：EnvSet 列表。如果启用了指定功能，则会针对指定的操作应用环境设置。

requires：一个功能集列表，用于定义工具链何时支持相应功能。如果任何功能集完全适用（即功能集中的所有功能均已启用），则表示支持相应功能。如果省略 requires，则无论启用哪些其他功能，该功能都受支持。例如，使用此属性可根据启用的 build 模式（opt / fastbuild / dbg）过滤标志。

implies：当启用此功能时自动启用的功能或操作配置的字符串列表。如果任何隐含的功能或操作配置无法启用，此功能也不会启用（不会发出任何提示）。

provides：与此功能冲突的名称列表。

如果出现以下情况，则无法启用某项功能：
- provides 包含我们想要启用的其他功能或操作配置的名称。
- provides 包含的值与我们想要启用的其他功能或操作配置中的“提供”相同。使用此功能可确保无法同时意外激活不兼容的功能，从而避免出现难以诊断的编译器错误。
action_configs 默认值为 []
操作配置对应于 Bazel 操作，并允许根据已激活的功能选择工具。操作配置的激活与功能的语义相同：功能可以“要求”或“暗示”操作配置，就像它会要求或暗示其他功能一样。

参数：

action_name：相应配置所适用的 Bazel 操作的名称，例如“c-compile”或“c-module-compile”。

enabled：如果为“True”，则除非规则类型明确将其标记为不受支持，否则此操作处于启用状态。

tools：应用于操作的工具将是第一个具有与功能配置匹配的功能集的工具。如果没有工具与提供的功能配置匹配，系统会抛出错误。因此，最好提供一个具有空功能集的默认工具。

flag_sets：如果启用了指定的操作配置，则会将标志集应用于相应操作。

implies：当启用相应操作配置时自动启用的功能或操作配置的列表。如果任何隐含的功能或操作配置无法启用，则相应操作配置也不会启用（不会发出任何提示）。
artifact_name_patterns 默认值为 []
给定类别的输入或输出制品（对应于操作）的制品名称。

参数：

category_name：相应选择所适用的制品类别。此字段会与 Bazel 中定义的一系列类别进行比较。示例类别包括“linked_output”或相应选择的制品。它与扩展名一起用于根据目标名称创建制品名称。

extension：用于为此选择创建制品的分机号。它与前缀一起用于根据目标名称创建制品名称。
cxx_builtin_include_directories 默认值为 []

用于 C++ 编译的内置 include 目录。这些应该是编译器使用的确切路径，通常相对于执行根目录。

编译器使用的路径可以通过“gcc -E -xc++ - -v”确定。

我们目前还使用 C++ 路径进行 C 编译，只要 C++ 和 C 头文件之间没有名称冲突，这种做法就是安全的。

相对路径是相对于配置文件目录解析的。

如果编译器支持 --sysroot，则这些路径应使用 %sysroot% 而不是 include 路径，并指定 sysroot 属性，以便为 Blaze 提供必要的信息来正确替换。
toolchain_identifier 必需

相应 crosstool 版本中工具链的唯一标识符。必须能够将其用作路径中的目录名称。

必须与以下正则表达式匹配：[a-zA-Z_][\.\- \w]*
host_system_name 字符串；或 None； 默认值为 None
忽略。
target_system_name 必需
GNU 系统名称。
target_cpu 必需
目标架构字符串。
target_libc 必需
libc 版本字符串（例如“glibc-2.2.2”）。
compiler 必需参数
编译器版本字符串（例如“gcc-4.1.1”）。
abi_version 字符串；或 None； 默认值为 None
正在使用的 ABI，即 GCC 版本。例如：“gcc-3.4”
abi_libc_version 字符串；或 None； 默认值为 None
我们使用的 ABI 所用的 glibc 版本。
tool_paths 默认值为 []
工具位置。

参数：

name：工具的名称。

path：工具的位置；可以是绝对路径（对于非封闭式工具链），也可以是相对于 cc_toolchain 软件包的路径。
make_variables 默认值为 []
一个可供规则访问的 make 变量。
builtin_sysroot 字符串；或 None； 默认值为 None
内置的 sysroot。如果不存在此属性，则 Bazel 不允许使用其他 sysroot，即不允许通过 --grte_top 选项使用其他 sysroot。
cc_target_os 字符串；或 None； 默认值为 None
仅限内部使用，请勿使用。

create_compilation_context

CompilationContext cc_common.create_compilation_context(headers=unbound, system_includes=unbound, includes=unbound, quote_includes=unbound, framework_includes=unbound, defines=unbound, local_defines=unbound)

创建 CompilationContext。

参数

参数 说明
headers 默认值为 unbound
编译相应目标所需的标头集
system_includes 默认值为 unbound
由尖括号（即 #include <foo/bar/header.h>）引用的头文件的搜索路径集。这些路径可以是相对于执行根目录的相对路径，也可以是绝对路径。通常通过 -isystem 传递
includes 默认值为 unbound
通过尖括号和引号引用的头文件的搜索路径集。通常通过 -I 传递
quote_includes 默认值为 unbound
由引号引用的头文件（即 #include "foo/bar/header.h"）的搜索路径集。它们可以是相对于执行根的相对路径，也可以是绝对路径。通常通过 -iquote
framework_includes 默认值为 unbound
头文件的框架搜索路径集（仅限 Apple 平台）
defines 默认值为 unbound
编译相应目标所需的定义集。每个 define 都是一个字符串。以传递方式传播到依赖项。
local_defines 默认值为 unbound
编译相应目标所需的定义集。每个 define 都是一个字符串。不会以传递方式传播到依赖项。

create_compilation_outputs

CcCompilationOutputs cc_common.create_compilation_outputs(objects=None, pic_objects=None)

创建编译输出对象。

参数

参数 说明
objects depset；或 None； 默认值为 None
对象文件列表。
pic_objects depset；或 None； 默认值为 None
PIC 对象文件的列表。

create_compile_variables

Variables cc_common.create_compile_variables(cc_toolchain, feature_configuration, source_file=None, output_file=None, user_compile_flags=None, include_directories=None, quote_include_directories=None, system_include_directories=None, framework_include_directories=None, preprocessor_defines=None, thinlto_index=None, thinlto_input_bitcode_file=None, thinlto_output_object_file=None, use_pic=False, add_legacy_cxx_options=False, variables_extension=unbound)

返回用于编译操作的变量。

参数

参数 说明
cc_toolchain 必需
要为其创建 build 变量的 cc_toolchain。
feature_configuration 必需
要查询的功能配置。
source_file 默认值为 None
用于编译的可选源文件。请优先在此处传递 source_file，而不是将其附加到从 cc_common.get_memory_inefficient_command_line 生成的命令行末尾，因为这样一来，工具链作者就可以正确指定和定位编译器标志。
output_file 默认值为 None
编译的可选输出文件。请优先在此处传递 output_file，而不是将其附加到从 cc_common.get_memory_inefficient_command_line 生成的命令行末尾，因为这样一来，工具链作者就可以正确指定和定位编译器标志。
user_compile_flags 字符串的序列；或 None； 默认值为 None
其他编译标志 (copts) 的列表。
include_directories depset；或 None； 默认值为 None
包含目录的 depset。
quote_include_directories depset；或 None； 默认值为 None
带引号的 include 目录的 depset。
system_include_directories depset；或 None； 默认值为 None
系统 include 目录的 Depset。
framework_include_directories depset；或 None； 默认值为 None
框架 include 目录的 depset。
preprocessor_defines depset；或 None； 默认值为 None
预处理器定义的 depset。
thinlto_index 字符串；或 None； 默认值为 None
LTO 索引文件路径。
thinlto_input_bitcode_file string；或 None； 默认值为 None
输入到 LTO 后端的位码文件。
thinlto_output_object_file 字符串；或 None； 默认值为 None
LTO 后端输出的对象文件。
use_pic 默认值为 False
如果为 true，编译将生成位置无关的代码。
add_legacy_cxx_options 默认值为 False
未使用。
variables_extension dict； 默认值为 unbound
编译操作使用的其他变量的字典。 

LibraryToLink cc_common.create_library_to_link(actions, feature_configuration=None, cc_toolchain=None, static_library=None, pic_static_library=None, dynamic_library=None, interface_library=None, pic_objects=unbound, objects=unbound, alwayslink=False, dynamic_library_symlink_path='', interface_library_symlink_path='')

创建 LibraryToLink

参数

参数 说明
actions 必需
actions 对象。
feature_configuration 默认值为 None
feature_configuration，表示要查询。
cc_toolchain 默认值为 None
，表示要使用的 CcToolchainInfo 提供程序。
static_library 文件；或 None； 默认值为 None
要关联的静态库的 File。
pic_static_library 文件；或 None； 默认值为 None
要关联的 PIC 静态库的 File。
dynamic_library 文件；或 None； 默认值为 None
要关联的动态库的 File。始终用于运行时，如果未传递 interface_library，则用于关联。
interface_library 文件；或 None； 默认值为 None
要链接的接口库的 File。
pic_objects 文件的序列；默认值为 unbound
实验性，请勿使用
objects 文件的序列；默认值为 unbound
实验性，请勿使用
默认值为 False
是否关联 --whole_archive 块中的静态库/对象。
字符串； 默认值为 ''
替换 solib 目录中动态库链接的默认路径。空字符串表示使用默认值。
默认值为 ''
替换 solib 目录中接口库链接的默认路径。空字符串表示使用默认值。 

Variables cc_common.create_link_variables(cc_toolchain, feature_configuration, library_search_directories=None, runtime_library_search_directories=None, user_link_flags=None, output_file=None, param_file=None, def_file=None, is_using_linker=True, is_linking_dynamic_library=False, must_keep_debug=True, use_test_only_flags=False, is_static_linking_mode=True)

返回用于关联操作的链接变量。

参数

参数 说明
必需
要为其创建 build 变量的 cc_toolchain。
必需
要查询的功能配置。
None；或 depset；默认值为 None
链接器在链接时查找库的目录的 Depset。
None；或 depset； 默认值为 None
加载程序在运行时查找库的目录的 Depset。
None；或序列； 默认值为 None
其他链接标志 (linkopts) 的列表。
默认值为 None
可选的输出文件路径。
默认值为 None
可选参数文件路径。
默认值为 None
可选的 .def 文件路径。
默认值为 True
使用链接器时为 True，使用归档器时为 False。调用方负责使此参数与所使用的操作名称保持同步（对于链接可执行文件或动态库，is_using_linker = True；对于归档静态库，is_using_linker = False）。
默认值为 False
创建动态库时为 True，创建可执行文件或静态库时为 False。调用方负责使此值与所使用的操作名称保持同步。此字段将在 b/65151735 修复后移除。
默认值为 True
设置为 False 时，bazel 将公开“strip_debug_symbols”变量，该变量通常用于使用链接器从输出文件中剥离调试符号。
默认值为 False
设置为 true 时，将设置“is_cc_test”变量。
默认值为 True
未使用。

create_linker_input

LinkerInput cc_common.create_linker_input(owner, libraries=None, user_link_flags=None, additional_inputs=None)

创建 LinkerInput。

参数

参数 说明
owner 必需
生成此输入中使用的所有文件的目标的标签。
libraries None；或 depset； 默认值为 None
LibraryToLink 的列表。
None；或 depset（包含 string）；或 sequence（包含 string）； 默认值为 None
以字符串形式传递的用户链接标志。接受 [String]、[[String]] 或 depset(String)。不建议使用后者，因为后者仅出于兼容性目的而保留，并且 depset 已扁平化。如果您想通过未扁平化的 depsets() 传播 user_link_flags，请将它们封装在 LinkerInput 中，以便在最后才进行扁平化处理。
additional_inputs None；或 depset；默认值为 None
用于链接操作的其他输入，例如：链接脚本。

create_linking_context

LinkingContext cc_common.create_linking_context(linker_inputs=None, libraries_to_link=None, user_link_flags=None, additional_inputs=None)

创建 LinkingContext。

参数

参数 说明
linker_inputs None；或 depset； 默认值为 None
LinkerInput 的 Depset。
None；或序列； 默认值为 None
已弃用。此参数已被弃用，很快就会被移除。请勿依赖此功能。它已通过 --+incompatible_require_linker_input_cc_api 停用。使用此标志可验证您的代码是否与即将进行的移除操作兼容。
LibraryToLink 的列表。
None；或序列； 默认值为 None
已弃用。此参数已被弃用，很快就会被移除。请勿依赖此功能。它已通过 --+incompatible_require_linker_input_cc_api 停用。使用此标志可验证您的代码是否与即将进行的移除操作兼容。
以字符串形式传递的用户链接标志列表。
additional_inputs None；或序列； 默认值为 None
已弃用。此参数已被弃用，很快就会被移除。请勿依赖此功能。它已通过 --+incompatible_require_linker_input_cc_api 停用。使用此标志可验证您的代码是否与即将进行的移除操作兼容。
用于关联操作的其他输入，例如：关联脚本。

create_linking_context_from_compilation_outputs

tuple cc_common.create_linking_context_from_compilation_outputs(actions, feature_configuration, cc_toolchain, compilation_outputs, user_link_flags=[], linking_contexts=[], name, language='c++', alwayslink=False, additional_inputs=[], disallow_static_libraries=False, disallow_dynamic_library=False)

应使用此属性创建可向下游传播信息的库规则，以便稍后由顶级规则（通过传递性关联创建可执行文件或动态库）进行关联。返回 (CcLinkingContext, CcLinkingOutputs) 元组。

参数

参数 说明
actions 必需
actions 对象。
feature_configuration 必需
要查询的 feature_configuration。
cc_toolchain 必需
要使用的CcToolchainInfo提供程序。
compilation_outputs 必需
包含要链接的对象文件的编译输出。
默认值为 []
其他链接选项的列表。
linking_contexts 默认值为 []
来自依赖项的库。这些库将链接到 link() 调用的输出工件（无论是二进制文件还是库）。
name 必需
此参数用于命名此方法创建的操作的输出制品。
language 默认值为 'c++'
目前仅支持 C++。请勿使用此参数。
默认值为 False
相应库是否应始终关联。
additional_inputs 默认值为 []
用于关联操作的其他输入，例如：关联脚本。
disallow_static_libraries 默认值为 False
是否应创建静态库。
disallow_dynamic_library 默认值为 False
是否应创建动态库。

do_not_use_tools_cpp_compiler_present

None cc_common.do_not_use_tools_cpp_compiler_present

请勿使用此字段，其唯一目的是帮助从 config_setting.values{'compiler') 迁移到 config_settings.flag_values{'@bazel_tools//tools/cpp:compiler'}

get_environment_variables

dict cc_common.get_environment_variables(feature_configuration, action_name, variables)

返回要为指定操作设置的环境变量。

参数

参数 说明
feature_configuration 必需
要查询的功能配置。
action_name 必需
操作的名称。必须是 @bazel_tools//tools/build_defs/cc:action_names.bzl (https://github.com/bazelbuild/bazel/blob/master/tools/build_defs/cc/action_names.bzl) 中的名称之一
variables 必需
用于模板扩展的 build 变量。

get_execution_requirements

sequence cc_common.get_execution_requirements(feature_configuration, action_name)

返回给定操作的执行要求。

参数

参数 说明
feature_configuration 必需
要查询的功能配置。
action_name 必需
操作的名称。必须是 @bazel_tools//tools/build_defs/cc:action_names.bzl (https://github.com/bazelbuild/bazel/blob/master/tools/build_defs/cc/action_names.bzl) 中的名称之一

get_memory_inefficient_command_line

sequence cc_common.get_memory_inefficient_command_line(feature_configuration, action_name, variables)

返回给定操作的扁平化命令行标志，并使用给定的变量进行扩展。扁平化嵌套集，最好不要使用，或者至少不应在分析结束后继续使用。我们正在开发可返回 Args 的内存高效型函数。

参数

参数 说明
feature_configuration 必需
要查询的功能配置。
action_name 必需
操作的名称。必须是 @bazel_tools//tools/build_defs/cc:action_names.bzl (https://github.com/bazelbuild/bazel/blob/master/tools/build_defs/cc/action_names.bzl) 中的名称之一
variables 必需
用于模板扩展的 build 变量。

get_tool_for_action

string cc_common.get_tool_for_action(feature_configuration, action_name)

返回指定操作的工具路径。

参数

参数 说明
feature_configuration 必需
要查询的功能配置。
action_name 必需
操作的名称。必须是 @bazel_tools//tools/build_defs/cc:action_names.bzl (https://github.com/bazelbuild/bazel/blob/master/tools/build_defs/cc/action_names.bzl) 中的名称之一

is_enabled

bool cc_common.is_enabled(feature_configuration, feature_name)

如果指定功能在功能配置中处于启用状态，则返回 True。

参数

参数 说明
feature_configuration 必需
要查询的功能配置。
feature_name 必需
功能名称。 

CcLinkingOutputs cc_common.link(actions, feature_configuration, cc_toolchain, compilation_outputs=None, user_link_flags=[], linking_contexts=[], name, language='c++', output_type='executable', link_deps_statically=True, stamp=0, additional_inputs=[], additional_outputs=unbound)

应用于 C++ 传递性关联。

参数

参数 说明
actions 必需
actions 对象。
feature_configuration 必需
要查询的 feature_configuration。
cc_toolchain 必需
要使用的CcToolchainInfo提供程序。
compilation_outputs CcCompilationOutputs；或 None； 默认值为 None
包含要链接的对象文件的编译输出。
默认值为 []
链接器选项的其他列表。
linking_contexts 默认值为 []
将依赖项中的关联上下文链接到此规则生成的关联上下文。
name 必需
此参数用于命名此方法创建的操作的输出制品。
language 默认值为 'c++'
目前仅支持 C++。请勿使用此参数。
output_type 默认值为 'executable'
可以是“executable”或“dynamic_library”。
默认值为 True
True 表示以静态方式链接依赖项，False 表示以动态方式链接依赖项。
stamp 默认值为 0
是否在关联的可执行文件中包含 build 信息（如果 output_type 为“executable”）。如果值为 1，则始终包含 build 信息。如果为 0（默认值），则始终排除默认 build 信息。如果值为 -1，则使用默认行为，该行为可能会被 --[no]stamp 标志替换。在为测试规则生成可执行输出时，应取消设置此属性（或将其设置为 0）。
additional_inputs 序列；或 depset； 默认值为 []
用于链接操作的其他输入，例如：链接脚本。
additional_outputs 序列；默认值为 unbound
用于链接操作的其他输出，例如：地图文件。

merge_compilation_contexts

CompilationContext cc_common.merge_compilation_contexts(compilation_contexts=[])

将多个 CompilationContexts 合并为一个。

参数

参数 说明
compilation_contexts 默认值为 []
要合并的 CompilationContexts 的列表。每个上下文的标头将通过返回的提供程序中的直接字段导出。

merge_compilation_outputs

CcCompilationOutputs cc_common.merge_compilation_outputs(compilation_outputs=[])

合并编译输出。

参数

参数 说明
compilation_outputs 默认值为 []