BazelCon 2024 註冊現已開放！

本頁面由 Cloud Translation API 翻譯而成。

副本

回報問題查看原始碼 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

用於 C++ 編譯、連結和產生指令列的工具。

成員

action_is_enabled
CcToolchainInfo
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
link [連結]
merge_compilation_contexts
merge_compilation_outputs

action_is_enabled

bool cc_common.action_is_enabled(feature_configuration, action_name)

如果功能設定中已啟用指定的 action_config，則傳回「是」。

參數

參數	說明
`feature_configuration`	必須查詢功能設定。
`action_name`	必要 action_config 的名稱。

CcToolchainInfo

Provider cc_common.CcToolchainInfo

這個金鑰用於擷取提供者，其中包含目前使用的 C++ 工具鍊相關資訊

configure_features

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

建立 feature_configuration 例項。需要 cpp 設定片段。

參數

參數	說明
`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`：旗標集清單。如果已啟用指定功能，系統就會為指定的動作套用旗標組合。 `env_sets`：EnvSet 清單。如果啟用指定功能，系統就會為指定的動作套用 env 集。 `requires`：功能集清單，定義工具鏈支援這項功能的時間。如果某項功能集已完全套用 (亦即功能集的所有功能皆已啟用)，系統支援該功能。如果省略 `requires`，系統會獨立支援該功能，而不會啟用其他功能。以下範例用於根據已啟用的建構模式篩選標記 (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++ 編譯內含目錄。這些路徑應為編譯器使用的確切路徑，且通常與執行根目錄相關。編譯器使用的路徑可以透過「gcc -E -xc++ - -v」決定。我們目前也使用 C++ 路徑進行 C 編譯，只要 C++ 和 C 標頭檔案之間沒有名稱衝突，這項做法就很安全。系統會根據設定檔目錄解析相對路徑。如果編譯器支援 --sysroot，則這些路徑應使用 %sysroot% 而非 include 路徑，並指定 sysroot 屬性，以便提供做出正確替換所需的資訊。
`toolchain_identifier`	必填跨工具版本工具鍊的專屬 ID。這個名稱必須能夠用於路徑中的目錄名稱。必須與下列規則運算式相符：[a-zA-Z_][\.\- \w]*
`host_system_name`	string；或 `None`；預設值為 `None` 忽略。
`target_system_name`	必填 GNU 系統名稱。
`target_cpu`	required 目標架構字串。
`target_libc`	必要 libc 版本字串 (例如「glibc-2.2.2」)。
`compiler`	必要編譯器版本字串 (例如「gcc-4.1.1」)。
`abi_version`	string；或 `None`；預設值為 `None` 使用中的 abi，即 gcc 版本。例如：「gcc-3.4」
`abi_libc_version`	string; 或 `None`；預設值為 `None` 我們目前使用的 Abi 使用的 glibc 版本。
`tool_paths`	預設為 `[]` Tool 位置。引數： `name`：工具的名稱。 `path`：工具的位置；可以是絕對路徑 (非密封工具鍊)，或與 cc_toolchain 套件的相對路徑。
`make_variables`	預設為 `[]` 可供規則存取的製作變數。
`builtin_sysroot`	string；或 `None`；預設值為 `None` 內建的 sysroot。如果沒有這個屬性，Bazel 就無法使用不同的 sysroot，也就是透過 --grte_top 選項。
`cc_target_os`	string；或 `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` 編譯這個目標所需的定義集。每個定義都是一個字串。會間接傳播至附屬項目。
`local_defines`	預設為 `unbound` 編譯這個目標所需的定義集。每個定義都是字串。不會以遞迴方式傳播至依附元件。

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`	我們要建立的建構變數所需的 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` 。 Depset 的引號包含目錄。
`system_include_directories`	depset；或 `None`；預設為 `None` Depset 的系統包含目錄。
`framework_include_directories`	depset；或 `None`；預設為 `None` 架構的 Depset 包含目錄。
`preprocessor_defines`	depset；或 `None`；預設為 `None` 預先處理器定義的 Depset。
`thinlto_index`	string；或 `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`	字典；預設值為 `unbound` 。 compile 動作使用的額外變數字典。

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`	預設值為 `None` `feature_configuration` 待查詢。
`cc_toolchain`	預設值為 `None` `CcToolchainInfo` 供應器。
`static_library`	File 或 `None`；預設為 `None` `File` 要連結的靜態資料庫。
`pic_static_library`	File；或 `None`；預設為要連結的圖片靜態資料庫的 `None` `File`。
`dynamic_library`	檔案；或 `None`；預設為要連結的動態程式庫的 `None` `File`。一律用於執行階段，如果未傳遞 `interface_library`，則用於連結。
`interface_library`	檔案；或 `None`；預設為要連結的介面程式庫的 `None` `File`。
`pic_objects`	File 的 sequence；預設為 `unbound` 實驗功能，請勿使用
`objects`	File 的 sequence；預設為 `unbound` 實驗功能，請勿使用
`alwayslink`	預設為 `False` 是否要在 --whole_archive 區塊中連結靜態資料庫/物件。
`dynamic_library_symlink_path`	string；預設值為 `''` 覆寫 Solib 目錄中動態程式庫連結的預設路徑。空白字串會使用預設值。
`interface_library_symlink_path`	預設為 `''` 覆寫 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`	我們要建立的建構變數所需的 cc_toolchain。
`feature_configuration`	必要要查詢的特徵設定。
`library_search_directories`	`None` 或 depset；預設為 `None` 。 Depset 是目錄的集合，連結器會在連結時在此目錄中尋找程式庫。
`runtime_library_search_directories`	`None`；或 depset；預設為 `None` 載入器會在執行階段尋找程式庫的目錄 Depset。
`user_link_flags`	`None` 或 sequence；預設為 `None` 。其他連結標記 (linkopts) 清單。
`output_file`	預設值為 `None` 選用的輸出檔案路徑。
`param_file`	預設為 `None` 選用參數檔案路徑。
`def_file`	預設為 `None` (選用) .def 檔案路徑。
`is_using_linker`	預設值為 `True` 使用連接器時為 True，封存器則為 False。呼叫端負責讓這項資訊與所使用的動作名稱保持同步 (is_using_linker = True 表示連結可執行檔或動態程式庫，is_using_linker = False 表示封存靜態程式庫)。
`is_linking_dynamic_library`	預設值為 `False` 如果是建立動態資料庫，則為 True；如果是可執行或靜態資料庫，則為 False。呼叫端負責讓此內容和使用的動作名稱保持同步。修正 b/65151735 後，系統就會移除這個欄位。
`must_keep_debug`	預設為 `True` 如果設為 False，bazel 會公開「strip_debug_symbols」變數，通常用於使用連結器從輸出檔案中移除偵錯符號。
`use_test_only_flags`	預設為 `False` 如果設為 true，系統會設定「is_cc_test」變數。
`is_static_linking_mode`	預設為 `True` 。未使用。

create_linker_input

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

可建立 LinkerInput。

參數

參數	說明
`owner`	required 產生此輸入內容中所有檔案的目標標籤。
`libraries`	`None` 或 depset；預設為 `None` 。列出 `LibraryToLink`。
`user_link_flags`	`None`；或「字串」的「解碼器」；或「字串」的「序列」；預設值為 `None` 以字串形式傳遞的使用者連結標記。接受 [String]、[[String]] 或 depset(String)。不建議使用後者，因為這只會為了相容性目的而保留，而且偏移會壓平。如果您想要透過 unflattened 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` Depset 的 `LinkerInput`。
`libraries_to_link`	`None`；或序列；預設為 `None` 。已淘汰。這個參數已淘汰，並將在近期內移除。請勿仰賴這項功能。`--+incompatible_require_linker_input_cc_api` 會停用。請使用這個標記確認您的程式碼是否與即將移除的程式碼相容。 `LibraryToLink` 清單。
`user_link_flags`	`None`；或 sequence；預設值為 `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`	必填包含要連結的物件檔案的編譯輸出內容。
`user_link_flags`	預設值為 `[]` 其他連結選項清單。
`linking_contexts`	預設值為 `[]` 來自依附元件的程式庫。這些程式庫會連結至 link() 呼叫的輸出構件，例如二進位檔或程式庫。
`name`	必要此方法會用於為此方法建立的動作 (輸出構件) 命名。
`language`	預設值為 `'c++'` 現在僅支援 C++。請勿使用這項參數。
`alwayslink`	預設為 `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`	必要要用於展開範本的建構變數。

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`	必要用於展開範本的建構變數。

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`	required 功能名稱。

連結

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` 。包含要連結的物件檔案的編譯輸出內容。
`user_link_flags`	預設為 `[]` Additional list of linker options.
`linking_contexts`	預設值為 `[]` 連結依附元件的結構定義，連結至這項規則產生的連結結構定義。
`name`	必要此方法會用於為此方法建立的動作 (輸出構件) 命名。
`language`	預設值為 `'c++'` 目前只支援 C++。請勿使用這項參數。
`output_type`	預設值為 `'executable'` 可以是「executable」或「dynamic_library」。
`link_deps_statically`	預設值為 `True` 如果為 True，則會靜態連結依附元件，如果為 False，則會動態連結依附元件。
`stamp`	預設值為 `0` 如果 output_type 為「executable」時，是否要在連結的執行檔中加入建構資訊。如果為 1，系統一律會加入建構資訊。如果為 0，系統一律會排除預設的建構資訊。如果為 -1，則會使用預設行為，但可能會遭到 --[no]stamp 標記覆寫。為測試規則產生可執行輸出內容的輸出內容時，應取消設定 (或設為 0)。
`additional_inputs`	sequence 或 depset；預設為 `[]` 。如果要為連結動作提供其他輸入內容，例如連結指令碼。
`additional_outputs`	sequence；預設值為 `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`	預設值為 `[]`