Apple 一般

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6
Starlark 函式，用於存取 Apple 規則實作的內部項目。

成員

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

傳回環境變數的 dict，這些變數應針對需要在 Apple 主機系統上執行建構工具的動作設定，例如應使用的 Xcode 版本。鍵是變數名稱，值則是對應的值。

參數

參數 說明
xcode_config 必要
提供者，內含 Xcode 設定相關資訊。

apple_toolchain

apple_toolchain apple_common.apple_toolchain()

公用程式，用於從 Apple 工具鍊解析項目。

AppleDebugOutputs

Provider apple_common.AppleDebugOutputs

AppleDebugOutputs 提供者的建構函式/金鑰。

如果目標會傳播 AppleDebugOutputs 提供者，請使用這個提供者做為擷取目標的鍵。範例：

dep = ctx.attr.deps[0]
p = dep[apple_common.AppleDebugOutputs]

AppleDynamicFramework

Provider apple_common.AppleDynamicFramework

AppleDynamicFramework 提供者的建構函式/金鑰。

如果目標會傳播 AppleDynamicFramework 提供者，請使用這個提供者做為擷取目標的鍵。範例：

dep = ctx.attr.deps[0]
p = dep[apple_common.AppleDynamicFramework]

AppleExecutableBinary

Provider apple_common.AppleExecutableBinary

AppleExecutableBinary 提供者的建構函式/金鑰。

如果目標會傳播 AppleExecutableBinary 提供者，請使用這個提供者做為擷取目標的鍵。範例：

dep = ctx.attr.deps[0]
p = dep[apple_common.AppleExecutableBinary]

dotted_version

DottedVersion apple_common.dotted_version(version)

建立新的 DottedVersion 例項。

參數

參數 說明
version 必要
以字串形式表示的 DottedVersion。 

struct apple_common.link_multi_arch_binary(ctx, avoid_deps=None, extra_linkopts=[], extra_link_inputs=[], extra_requested_features=[], extra_disabled_features=[], stamp=-1)

連結以 Apple 平台為目標的二進位檔 (可能支援多種架構)。這個方法包含 rules_apple 網域中 Starlark apple_binary 規則的大部分邏輯，有助於將連結邏輯遷移至 rules_apple 中的 Starlark。

這項 API 仍處於高度實驗階段，隨時可能變更。目前請勿依賴這項功能的穩定性。

參數

參數 說明
必要
Starlark 規則內容。
序列的 Target；或 None；預設為 None
。這是二進位檔依附元件圖中的 Target 清單，但程式庫不應連結至二進位檔。如果依附元件會在另一個映像檔中執行階段找到，例如套裝組合載入器，或這個二進位檔載入的任何動態程式庫/架構，就會發生這種情況。
string 的字串序列；預設值為 []
要傳遞至連結器動作的額外 linkopts。
sequence of Files；預設為 []
；要傳遞至連結器動作的額外檔案。
字串序列；預設值為 []
。要傳遞至連結器動作的額外要求功能。
sequence of strings； 預設為 []
要傳遞至連結器動作的其他停用功能。
預設值為 -1
是否要在連結的二進位檔中加入建構資訊。如果為 1，一律會納入建構資訊。如果設為 0，系統一律會排除建構資訊。如果為 -1 (預設值)，則行為由 --[no]stamp 旗標決定。產生測試規則的可執行輸出內容時，這項值應設為 0。 

struct apple_common.link_multi_arch_static_library(ctx)

連結以 Apple 平台為目標的靜態程式庫 (可能為多架構)。這個方法是 Starlark apple_static_library 規則邏輯的一部分，位於 rules_apple 網域中，可協助將連結邏輯遷移至 rules_apple 中的 Starlark。

這項 API 仍處於高度實驗階段，隨時可能變更。目前請勿依賴這項功能的穩定性。

參數

參數 說明
必要
Starlark 規則內容。

new_dynamic_framework_provider

AppleDynamicFramework apple_common.new_dynamic_framework_provider(binary=None, cc_info=None, objc=None, framework_dirs=None, framework_files=None)

建立新的 AppleDynamicFramework 提供者例項。

參數

參數 說明
binary File；或 None；預設為 None
動態架構的 dylib 二進位檔構件。
cc_info 預設值為 None
CcInfo，其中包含連結至二進位的遞移依附元件相關資訊。
objc 預設值為 None
ObjcProvider，其中包含連結至二進位的遞移依附元件相關資訊。
framework_dirs 字串的 depset；或 None；預設為 None
。用做連結輸入內容的架構路徑名稱，以便連結動態架構。
framework_files File 的 depset；或 None；預設為 None
應做為輸入內容納入的完整構件集，用於連結動態架構。

new_executable_binary_provider

AppleExecutableBinary apple_common.new_executable_binary_provider(binary=None, cc_info=None, objc=None)

建立新的 AppleExecutableBinaryInfo 提供者例項。

參數

參數 說明
binary File；或 None；預設為 None
可執行檔的二進位檔構件。
cc_info 預設值為 None
CcInfo，其中包含連結至二進位的遞移依附元件相關資訊。
objc 預設值為 None
ObjcProvider，其中包含連結至二進位的遞移依附元件相關資訊。

new_objc_provider

ObjcProvider apple_common.new_objc_provider(**kwargs)

建立新的 ObjcProvider 執行個體。

參數

參數 說明
kwargs 預設值為 {}
引數字典。

Objc

Provider apple_common.Objc

Objc 提供者的建構函式/金鑰。

如果目標會傳播 Objc 提供者，請使用這個提供者做為擷取目標的鍵。範例：

dep = ctx.attr.deps[0]
p = dep[apple_common.Objc]

platform

struct apple_common.platform

類似列舉的結構體，包含對應 Apple 平台的下列欄位：
  • ios_device
  • ios_simulator
  • macos
  • tvos_device
  • tvos_simulator
  • visionos_device
  • visionos_simulator
  • watchos_device
  • watchos_simulator

這些值可以傳遞至預期平台的函式，例如 XcodeVersionConfig.sdk_version_for_platform。

platform_type

struct apple_common.platform_type

類似列舉的結構體，包含對應 Apple 平台類型的下列欄位：
  • ios
  • macos
  • tvos
  • visionos
  • watchos

這些值可以傳遞至預期平台類型的方法，例如「apple」設定片段的 multi_arch_platform 方法。

範例：

ctx.fragments.apple.multi_arch_platform(apple_common.platform_type.ios)

target_apple_env

dict apple_common.target_apple_env(xcode_config, platform)

傳回環境變數的 dict，這些變數應針對建構指定 Apple 平台類型目標的動作設定。舉例來說，這個字典包含的變數會標示要建構的平台名稱和 SDK 版本。鍵是變數名稱，值則是對應的值。

參數

參數 說明
xcode_config 必要
提供者，內含 Xcode 設定相關資訊。
platform 必要
Apple 平台。

XcodeProperties

Provider apple_common.XcodeProperties

XcodeVersionProperties 提供者的建構函式/金鑰。

如果目標會傳播 XcodeVersionProperties 提供者，請使用這個提供者做為擷取目標的鍵。範例：

dep = ctx.attr.deps[0]
p = dep[apple_common.XcodeVersionProperties]

XcodeVersionConfig

Provider apple_common.XcodeVersionConfig

XcodeVersionConfig 提供者的建構函式/金鑰。