成员
- action_is_enabled
- CcToolchainInfo
- 编译compile
- configure_features
- create_cc_toolchain_config_info
- create_compilation_context
- create_compilation_outputs
- create_compile_variables
- create_library_to_link
- create_link_variables
- create_linker_input
- create_linking_context
- create_linking_context_from_compilation_outputs
- do_not_use_tools_cpp_compiler_present
- get_environment_variables
- get_execution_requirements
- get_memory_inefficient_command_line
- get_tool_for_action
- is_enabled
- 链接
- merge_cc_infos
- merge_compilation_contexts
- merge_compilation_outputs
action_is_enabled
bool cc_common.action_is_enabled(feature_configuration, action_name)如果在功能配置中启用了指定的 action_config,则返回 True。
参数
参数 | 说明 |
---|---|
feature_configuration
|
required 要查询的功能配置。 |
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 = [] 编译 src 所需的标头列表,可由相关规则传递。 |
private_hdrs
|
default = [] 编译 src 且不被相关规则包含的标头列表。 |
includes
|
default = [] 通过尖括号和引号引用的头文件的搜索路径。通常以 -I 传递。以传递方式传播到从属项。 |
quote_includes
|
default = [] 搜索由英文引号引用的头文件的路径,例如 #include "foo/bar/header.h"。它们可以是相对于 exec 根目录,也可以是绝对路径。传递时通常带有 -iquote。以传递方式传播到从属项。 |
system_includes
|
default = [] 搜索由尖括号引用的头文件的路径,例如 #include <foo/bar/header.h>。它们可以相对于 exec 根目录,也可以相对于 exec 根目录。通常通过 -isystem 传递。以传递方式传播到从属项。 |
framework_includes
|
default = [] 搜索 Apple 框架中的头文件的路径。它们可以是相对于 exec 根目录,也可以是绝对路径。通常以 -F 的形式传递。以传递方式传播到从属项。 |
defines
|
default = [] 编译此目标所需的一组定义。每个定义都是一个字符串。以传递方式传播到从属项。 |
local_defines
|
default = [] 编译此目标所需的一组定义。每个定义都是一个字符串。不会以传递方式传播到从属项。 |
include_prefix
|
default = '' 要添加到此规则的标头路径中的前缀。设置完毕后,此规则的 hdrs 属性中的标头即为前置于其代码库相对路径的属性值。添加该前缀之前,系统会先移除 Sanes_include_prefix 属性中的前缀。 |
strip_include_prefix
|
default = '' 要从此规则的标头路径中移除的前缀。设置后,此规则的 hdrs 属性中的标头可通过其路径访问,但此前缀会被截断。如果它是相对路径,则会被视为相对软件包路径。如果是绝对路径,则被视为代码库相对路径。include_prefix 属性中的前缀是在去除此前缀后添加的。 |
user_compile_flags
|
default = [] 额外的编译选项列表。 |
compilation_contexts
|
default = [] 用于编译的依赖项的头文件。 |
name
|
required 这用于为此方法创建的操作的输出工件命名。另请参阅“main_output”参数。 |
disallow_pic_outputs
|
default = False 是否应创建 PIC 输出。 |
disallow_nopic_outputs
|
default = False 是否应创建 NOPIC 输出。 |
additional_inputs
|
default = [] 编译 src 所需的其他文件的列表 |
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 ;
default = None规则上下文。 |
cc_toolchain
|
required 我们为其配置功能的 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 = [] 特征列表。 |
action_configs
|
default = [] action_configs 列表。 |
artifact_name_patterns
|
default = [] artifact_name_patterns 列表。 |
cxx_builtin_include_directories
|
默认值 = [] 用于进行 C++ 编译的内置 include 目录。这些路径应该与编译器所用的完全相同,而且通常相对于 exec 根目录。 编译器使用的路径可通过“gcc -E -xc++ - -v”确定。 我们目前也使用 C++ 路径进行 C 编译,只要 C++ 和 C 头文件之间没有名称冲突,这种编译就是安全的。 相对路径是相对于配置文件目录进行解析的。 如果编译器支持 --sysroot,则这些路径应使用 %sysroot%(而非 include 路径),并指定 sysroot 属性,以便为 blaze 提供进行正确替换所需的信息。 |
toolchain_identifier
|
必需 Crosstool 版本中工具链的唯一标识符。必须能将其用作路径中的目录名。 它必须与以下正则表达式匹配:[a-zA-Z_][\.\- \w]* |
host_system_name
|
string; or None ;
default = None已忽略。 |
target_system_name
|
必填 GNU 系统名称。 |
target_cpu
|
必需 目标架构字符串。 |
target_libc
|
required libc 版本字符串(例如“glibc-2.2.2”)。 |
compiler
|
必需 编译器版本字符串(例如“gcc-4.1.1”)。 |
abi_version
|
string; or None ;
默认值 = None正在使用的 abi,是 gcc 版本。E.g.: “gcc-3.4” |
abi_libc_version
|
string; or None ;
default = None我们正在使用的 abi 使用的 glibc 版本。 |
tool_paths
|
default = [] tool_paths 列表。 |
make_variables
|
default = [] make_variables 的列表。 |
builtin_sysroot
|
string; or None ;
default = 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
|
default = unbound 用尖括号(即 #include <foo/bar/header.h>)引用的标头文件的一组搜索路径。它们可以相对于 exec 根目录,也可以相对于 exec 根目录进行搜索。通常通过 -isystem 传递 |
includes
|
default = unbound 通过尖括号和引号引用的标头文件的一组搜索路径。通常通过 -I 传递 |
quote_includes
|
default = unbound 用英文引号引用的标头文件的一组搜索路径,即 #include "foo/bar/header.h"。它们可以是相对于 exec 根目录,也可以是绝对路径。传递时通常采用 -iquote |
framework_includes
|
default = unbound 头文件的一组框架搜索路径(仅限 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 ;
default = None对象文件列表。 |
pic_objects
|
depset; or None ;
default = Nonepic 对象文件列表。 |
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
|
required 我们为其创建构建变量的 cc_toolchain。 |
feature_configuration
|
required 要查询的功能配置。 |
source_file
|
default = None 编译的可选源文件。请在此处传递 source_file,而非将其附加到 cc_common.get_memory_ineffective_command_line 生成的命令行末尾,因为这样,工具链作者才能正确指定和定位编译器标志。 |
output_file
|
default = None 编译的可选输出文件。请在此处传递 output_file,而不是将其附加到从 cc_common.get_memory_ineffective_command_line 生成的命令行末尾,因为这样,工具链作者才能正确指定和定位编译器标志。 |
user_compile_flags
|
sequence of strings; or None ;
default = None其他编译标志 (copt) 的列表。 |
include_directories
|
depset; or None ;
default = None包含目录的依赖项。 |
quote_include_directories
|
depset; or None ;
default = None引号包含目录的位置。 |
system_include_directories
|
depset; or None ;
default = None系统 include 目录的组。 |
framework_include_directories
|
depset; or None ;
default = None框架包含目录的依赖项。 |
preprocessor_defines
|
depset; or None ;
default = None预处理器定义的依赖项。 |
thinlto_index
|
string; or None ;
default = NoneLTO 索引文件路径。 |
thinlto_input_bitcode_file
|
string; or None ;
默认值 = None输入到 LTO 后端的位码文件。 |
thinlto_output_object_file
|
string; or None ;
默认值 = NoneLTO 后端输出的对象文件。 |
use_pic
|
default = False 如果设置为 true,编译将生成与位置无关的代码。 |
add_legacy_cxx_options
|
default = False 未使用。 |
variables_extension
|
dict ;
default = unbound编译操作使用的其他变量的字典。 |
create_library_to_link
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 ;
default = None要链接的静态库的 File 。
|
pic_static_library
|
File; or None ;
default = None要链接的图片静态库的 File 。
|
dynamic_library
|
File; or None ;
default = None要链接的动态库的 File 。始终用于运行时;如果未传递 interface_library ,则始终用于链接。
|
interface_library
|
File; or None ;
默认值 = None要链接的接口库的 File 。
|
pic_objects
|
sequence of Files ;
默认值 = 未绑定实验性功能,请勿使用 |
objects
|
sequence of Files ;
默认值 = 未绑定实验性功能,请勿使用 |
alwayslink
|
default = False 是否关联 --whole_archive 块中的静态库/对象。 |
dynamic_library_symlink_path
|
string ;
default = ''替换 solib 目录中动态链接的默认路径。空字符串可使用默认值。 |
interface_library_symlink_path
|
default = '' 替换 solib 目录中接口库链接的默认路径。空字符串可使用默认值。 |
create_link_variables
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)返回用于关联操作的链接变量。
参数
参数 | 说明 |
---|---|
cc_toolchain
|
required 我们为其创建构建变量的 cc_toolchain。 |
feature_configuration
|
required 要查询的功能配置。 |
library_search_directories
|
None; or depset ;
default = None链接器在链接时查找库的目录的一处目录。 |
runtime_library_search_directories
|
None; or depset ;
default = None加载器在运行时将在其中查找库的目录的代码库。 |
user_link_flags
|
None; or sequence ;
default = None其他链接标记 (linkopts) 的列表。 |
output_file
|
default = None 可选的输出文件路径。 |
param_file
|
default = None 可选参数文件路径。 |
def_file
|
default = None 可选 .def 文件路径。 |
is_using_linker
|
default = True 使用链接器时为 true,使用归档程序时为 false。调用方负责使其与所用的操作名称保持同步(对于链接可执行文件或动态库,is_using_linker = True,对于归档静态库,is_using_linker = False)。 |
is_linking_dynamic_library
|
default = False 创建动态库时为 True,如果为可执行文件或静态库,则为 False。调用方负责确保这与所用的操作名称保持同步。修复 b/65151735 后,此字段将被移除。 |
must_keep_debug
|
default = True 如果设置为 True,bazel 将公开“strip_debug_symbols”变量,该变量通常用于使用链接器从输出文件中删除调试符号。 |
use_test_only_flags
|
default = False 如果设置为 true,则会设置“is_cc_test”变量。 |
is_static_linking_mode
|
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 ;
default = NoneLibraryToLink 的列表。
|
user_link_flags
|
None; or depset of strings; or sequence of strings ;
default = None以字符串形式传递的用户链接标志。接受 [String]、[[String]] 或 depset(String)。不建议采用后者,因为它只是为了实现兼容性而保留,并且将扁平化。如果您想通过非扁平化的 depsets() 传播 user_link_flags,请将其封装在 LinkerInput 中,以免扁平化到最后。 |
additional_inputs
|
None; or depset ;
default = 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 。
|
libraries_to_link
|
None; or sequence ;
default = None已废弃。此参数已弃用,很快就会被移除。请不要依赖它。已使用 --+incompatible_require_linker_input_cc_api 停用。使用此标记验证您的代码是否符合即将移除的代码。LibraryToLink 的列表。
|
user_link_flags
|
None; or sequence ;
default = None已废弃。此参数已弃用,很快就会被移除。请不要依赖它。已使用 --+incompatible_require_linker_input_cc_api 停用。使用此标记验证您的代码是否符合即将移除的代码。以字符串形式传递的用户链接标志列表。 |
additional_inputs
|
None; or sequence ;
default = 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, grep_includes=None)应该用于创建可向下游传播信息的库规则,以便稍后通过执行传递链接以创建可执行文件或动态库的顶级规则进行链接。返回 (
CcLinkingContext
, CcLinkingOutputs
) 的元组。
参数
参数 | 说明 |
---|---|
actions
|
必需actions 对象。
|
feature_configuration
|
必需feature_configuration 才能查询。
|
cc_toolchain
|
必需CcToolchainInfo 提供方。
|
compilation_outputs
|
必需 包含要关联的目标文件的编译输出。 |
user_link_flags
|
default = [] 额外的关联选项列表。 |
linking_contexts
|
default = [] 来自依赖项的库。这些库将链接到 link() 调用的输出工件(可以是二进制文件,也可以是库)。 |
name
|
required 这用于为此方法创建的操作的输出工件命名。 |
language
|
default = 'c++' 目前仅支持 C++。请勿使用此参数。 |
alwayslink
|
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
|
required 要查询的功能配置。 |
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
|
required 要查询的功能配置。 |
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
|
required 要查询的功能配置。 |
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
|
required 要查询的功能配置。 |
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
|
required 要查询的功能配置。 |
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 ;
default = None包含要链接的对象文件的编译输出。 |
user_link_flags
|
default = [] 额外的链接器选项列表。 |
linking_contexts
|
default = [] 将依赖项中的关联上下文关联到此规则生成的关联上下文。 |
name
|
required 这用于为此方法创建的操作的输出工件命名。 |
language
|
default = 'c++' 目前仅支持 C++。请勿使用此参数。 |
output_type
|
default = 'executable' 可以是“executable”或“dynamic_library”。 |
link_deps_statically
|
default = True 值为 true 时,以静态方式链接依赖项,值为 false 时,以动态方式链接依赖项。 |
stamp
|
default = 0 是否在关联的可执行文件中包含 build 信息(如果 output_type 为“executable”)。如果为 1,则始终包含 build 信息。如果为 0(始终排除默认 build 信息,如果为 -1,则使用默认行为,该行为可能会被 --[no]stamp 标记覆盖。在为测试规则生成可执行输出时,此值应未设置(或设置为 0)。 |
additional_inputs
|
sequence; or depset ;
default = []用于向关联操作额外输入信息,例如链接脚本。 |
grep_includes
|
File; or None ;默认值 = None |
additional_outputs
|
sequence ;
默认值 = unbound对于关联操作的其他输出,例如地图文件。 |
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
|
默认值 = [] |