cc_common

用于 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=[], compilation_contexts=[], name, disallow_pic_outputs=False, disallow_nopic_outputs=False, additional_inputs=[], grep_includes=None)

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

参数

参数 说明
actions 必需
actions 对象。
feature_configuration 必需
要查询的 feature_configuration。
cc_toolchain 必须使用的
CcToolchainInfo提供程序。
srcs default = []
要编译的源文件列表。
public_hdrs default = []
编译源代码所需的头文件列表，并且可能由依赖项规则传递性地包含。
private_hdrs default = []
src 编译所需的头文件列表，并且不应包含在依赖项规则中。
includes default = []
同时通过尖括号和引号引用的头文件的搜索路径。通常通过 -I 传递。以传递方式传播到依赖项。
quote_includes default = []
搜索由引号引用的头文件的路径，例如 #include "foo/bar/header.h"。它们可以是相对于执行根目录的相对路径，也可以是绝对路径。通常通过 -iquote 传递。以传递方式传播到依赖项。
system_includes default = []
Search paths for header files referenced by angle brackets, e.g. #include <foo/bar/header.h>. They can be either relative to the exec root or absolute. 通常通过 -isystem 传递。以传递方式传播到依赖项。
framework_includes default = []
Apple 框架中头文件的搜索路径。它们可以是相对于执行根目录的相对路径，也可以是绝对路径。通常通过 -F 传递。以传递方式传播到依赖项。
defines default = []
编译此目标所需的一组定义。每个定义都是一个字符串。以传递方式传播到依赖项。
local_defines default = []
编译此目标所需的一组定义。每个定义都是一个字符串。不会传递给依赖项。
include_prefix default = ''
要添加到此规则标头路径的前缀。设置后，此规则的 hdrs 属性中的标头可通过将此属性的值附加到其相对于代码库的路径来访问。系统会先移除 strip_include_prefix 属性中的前缀，然后再添加此前缀。
strip_include_prefix default = ''
要从此规则的标头路径中剥离的前缀。设置此属性后，此规则的 hdrs 属性中的标头可通过去掉此前缀的路径访问。如果是相对路径，则将其视为相对于软件包的路径。如果是绝对路径，则会被视为相对于代码库的路径。移除此前缀后，系统会添加 include_prefix 属性中的前缀。
user_compile_flags default = []
其他编译选项列表。
compilation_contexts default = []
用于编译的依赖项中的头文件。
name 必需
此属性用于为通过此方法创建的操作的输出工件命名。另请参阅 `main_output` 参数。
disallow_pic_outputs default = False
Whether should create PIC outputs.
disallow_nopic_outputs default = False
Whether should create NOPIC outputs.
additional_inputs default = []
编译 srcs 所需的其他文件的列表
grep_includes File; or None; 默认值为 None

configure_features

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

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

参数

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

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 default = []

包含一项功能的所有标志规范。

参数：

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

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

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

env_sets：EnvSet 列表 - 如果启用了给定功能，系统会将 env 集应用于为其指定的操作。

requires：一组功能集，用于定义工具链何时支持此功能。如果任何功能集都完全应用（即启用功能集的所有功能），则该功能受支持。如果省略“requires”，则无论启用了哪些其他功能，系统都支持该功能。例如，您可以使用此方法根据启用的构建模式（opt / fastbuild / dbg）过滤标记。

含义：一个字符串列表，其中包含在启用此功能时自动启用的功能或操作配置。如果无法启用任何隐含功能或操作配置，系统也不会（静默地）启用此功能。

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

如果存在以下情况，则无法启用相应功能：
-“provides”包含我们要启用的其他功能或操作配置的名称。
-“provides”包含与我们要启用的其他功能或操作配置中的“provides”相同的值。使用此方法可确保不兼容的功能不会同时意外启用，从而导致难以诊断的编译器错误。
action_configs default = []

操作配置对应于 Bazel 操作，允许根据已启用的功能选择工具。与功能一样，操作配置的激活也遵循相同的语义：功能可以像对待其他功能一样“要求”或“隐式要求”操作配置。

参数：

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

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

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

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

含义：启用此操作配置时自动启用的功能或操作配置的列表。如果无法启用任何隐含功能或操作配置，此操作配置也将（静默）停用。
artifact_name_patterns default = []

操作的给定类别输入工件或输出工件的工件名称。

参数：

category_name：此选择适用的工件类别。系统会将此字段与 Bazel 中定义的类别列表进行比较。示例类别包括“linked_output”或此选择的工件。该名称与扩展名一起用于根据目标名称创建工件名称。

扩展程序：用于为此选择创建工件的扩展程序。它与前缀一起用于根据目标名称创建工件名称。
cxx_builtin_include_directories default = []

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

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

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

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

如果编译器支持 --sysroot，则这些路径应使用 %sysroot% 而非包含路径，并指定 sysroot 属性，以便向 Blaze 提供进行正确替换所需的信息。
toolchain_identifier 必需

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

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

工具位置。

参数：

name：工具的名称。

path：工具的位置；可以是绝对路径（非密封型工具链的情况下），也可以是相对于 cc_toolchain 软件包的路径。
make_variables default = []
可供规则访问的 make 变量。
builtin_sysroot string; or None； 默认值为 None
内置的 sysroot。如果不存在此属性，Bazel 不允许使用其他 sysroot（例如通过 --grte_top 选项）。
cc_target_os string; or None; default = 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 default = unbound
编译此目标所需的一组头文件
system_includes 默认值 = 未绑定
由尖括号引用的头文件的搜索路径集，即 #include <foo/bar/header.h>。这些路径可以是相对于执行根目录的相对路径，也可以是绝对路径。通常通过 -isystem 传递
includes 默认值 = 未绑定
同时通过尖括号和引号引用的头文件的搜索路径集。通常通过 -I 传递
quote_includes 默认值 = 未绑定
由引号引用的头文件的搜索路径集，即 #include "foo/bar/header.h"。它们可以是相对于执行根目录的相对路径，也可以是绝对路径。通常通过 -iquote 传递
framework_includes default = unbound
header 文件的框架搜索路径集（仅限 Apple 平台）
defines default = unbound
编译此目标所需的一组定义。每个定义都是一个字符串。以传递方式传播到依赖项。
local_defines default = unbound
编译此目标所需的一组定义。每个定义都是一个字符串。不会传递给依赖项。

create_compilation_outputs

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

创建编译输出对象。

参数

参数 说明
objects depset; or None； 默认值为 None
对象文件列表。
pic_objects depset; or 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 default = None
编译的可选源文件。请优先在此处传递 source_file，而不是将其附加到从 cc_common.get_memory_inefficient_command_line 生成的命令行的末尾，因为这样，工具链作者就可以正确指定和放置编译器标志。
output_file default = None
编译的可选输出文件。请优先在此处传递 output_file，而不是将其附加到从 cc_common.get_memory_inefficient_command_line 生成的命令行的末尾，因为这样，工具链作者就可以正确指定和放置编译器标志。
user_compile_flags sequence of strings; or None； 默认值为 None
其他编译标志 (copts) 的列表。
include_directories depset; or None； 默认值为 None
include 目录的 Depset。
quote_include_directories depset; or None； 默认值为 None
引号包含目录的 Depset。
system_include_directories depset; or None； 默认值为 None
系统包含目录的 Depset。
framework_include_directories depset; or None； 默认值为 None
框架包含目录的 Depset。
preprocessor_defines depset; or None; default = None
预处理器定义的依赖项集。
thinlto_index string; or None； 默认值为 None
LTO 索引文件路径。
thinlto_input_bitcode_file string; or None; 默认值为 None
输入到 LTO 后端的位码文件。
thinlto_output_object_file string; or None； 默认值为 None
由 LTO 后端输出的对象文件。
use_pic 默认值 = False
如果为 true，编译将生成位置无关代码。
add_legacy_cxx_options default = False
未使用。
variables_extension dict； 默认值 = 未绑定
包含编译操作使用的其他变量的字典。 

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 default = None
要查询的 feature_configuration。
cc_toolchain default = None
要使用的 CcToolchainInfo 提供程序。
static_library File; or None； 默认值为 None
要关联的静态库的 File。
pic_static_library File; or None； 默认值为 None
要关联的 PIC 静态库的 File。
dynamic_library File; or None； 默认值为 None
要关联的动态库的 File。始终用于运行时，如果未传递 interface_library，则用于关联。
interface_library File; or None； 默认值为 None
要关联的接口库的 File。
pic_objects sequence of Files； 默认值为未绑定
实验性功能，请勿使用
objects sequence of Files； 默认值为未绑定
实验性功能，请勿使用
default = False
Whether to link the static library/objects in the --whole_archive block.
string; default = ''
替换 solib 目录中动态库链接的默认路径。空字符串表示使用默认值。
default = ''
替换 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; or depset; 默认值为 None
链接器在链接时会在其中查找库的目录的依赖项集。
None; or depset； 默认值为 None
加载器在运行时查找库的目录的依赖项集。
None; or sequence; 默认值 = None
其他链接标志 (linkopts) 的列表。
default = None
（可选）输出文件路径。
默认值 = None
可选参数文件路径。
默认值为 None
可选的 .def 文件路径。
默认值 = True
如果使用链接器，则为 True；如果使用归档器，则为 False。调用方负责使其与所使用的操作名称保持同步（对于链接可执行文件或动态库，is_using_linker = True；对于归档静态库，is_using_linker = False）。
默认值 = False
如果创建动态库，则为 True；如果创建可执行文件或静态库，则为 False。调用方负责使其与所使用的操作名称保持同步。修复 b/65151735 后，此字段将被移除。
default = True
如果设置为 True，bazel 将公开“strip_debug_symbols”变量，该变量通常用于使用链接器从输出文件中剥离调试符号。
默认值 = False
如果设置为 true，系统会设置“is_cc_test”变量。
default = True
未使用。

create_linker_input

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

创建 LinkerInput。

参数

参数 说明
owner 必需
生成此输入中使用的所有文件的目标的标签。
libraries None; or depset； 默认值为 None
LibraryToLink 列表。
None; or depset of strings; or sequence of strings; 默认值 = None
用户关联标志以字符串的形式传递。接受 [String]、[[String]] 或 depset(String)。不建议使用后者，因为它仅出于兼容性目的而保留，并且 depset 会扁平化。如果您想通过未展开的 depset() 传播 user_link_flags，请将其封装在 LinkerInput 中，以便在结束之前不展开。
additional_inputs None; or 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; or depset； 默认值为 None
LinkerInput 的 Depset。
None; or sequence； 默认值为 None
已弃用。此参数已弃用，很快就会被移除。请勿依赖此功能。在 --+incompatible_require_linker_input_cc_api 中，此功能处于停用状态。使用此标志可验证您的代码是否与即将移除的 API 兼容。
LibraryToLink 的列表。
None; or sequence； 默认值为 None
已弃用。此参数已弃用，很快就会被移除。请勿依赖此功能。在 --+incompatible_require_linker_input_cc_api 中，此功能处于停用状态。使用此标志可验证您的代码是否与即将移除的 API 兼容。
以字符串形式传递的用户关联标志列表。
additional_inputs None; or sequence； 默认值为 None
已弃用。此参数已弃用，很快就会被移除。请勿依赖此功能。在 --+incompatible_require_linker_input_cc_api 中，此功能处于停用状态。使用此标志可验证您的代码是否与即将移除的 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, grep_includes=None)

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

参数

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

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 必需
要用于模板展开的构建变量。

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)

使用给定变量进行展开，返回给定操作的扁平化命令行标志。会展开嵌套的集合，最好不要使用，或者至少不要在分析结束后保留。我们正在努力实现高效返回实参的内存函数。

参数

参数 说明
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 必需
要用于模板展开的构建变量。

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=[], grep_includes=None, additional_outputs=unbound)

应用于 C++ 传递关联。

参数

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

merge_cc_infos

CcInfo cc_common.merge_cc_infos(direct_cc_infos=[], cc_infos=[])

将多个 CcInfo 合并为一个。

参数

参数 说明
direct_cc_infos default = []
要合并的 CcInfo 的列表，其标头将由返回的提供程序中的直接字段导出。
cc_infos default = []
要合并的 CcInfo 的列表，其标头不会由返回的提供程序中的直接字段导出。

merge_compilation_contexts

CompilationContext cc_common.merge_compilation_contexts(compilation_contexts=[])

将多个 CompilationContexts 合并为一个。

参数

参数 说明
compilation_contexts default = []
要合并的 CompilationContexts 列表。每个情境的标头将由返回的提供程序中的直接字段导出。

merge_compilation_outputs

CcCompilationOutputs cc_common.merge_compilation_outputs(compilation_outputs=[])

合并编译输出。

参数

参数 说明
compilation_outputs default = []