Apple 一般

Starlark 用來存取 Apple 規則實作項目內部資訊的函式。

成員

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

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

參數

參數 說明
xcode_config required
供應商，其中包含 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 required
DottedVersion 的字串表示法。 

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

連結指定 Apple 平台的二進位檔 (可能為多架構)。這個方法包含 rules_apple 網域中 Starlark apple_binary 規則的大部分邏輯，可協助將其連結邏輯遷移至 rules_apple 中的 Starlark。

這個 API 仍在實驗階段，隨時可能變更。此時請勿依賴這個函式的穩定性。

參數

參數 說明
必要
Starlark 規則內容。
sequence of Targets; or None; 預設值 = None
This is a list of Targets that are in the dependency graph of the binary, but whose libraries should not be linked into the binary. 也就是在不同映像檔的執行階段中找到的依附元件，例如套裝組合載入器，或是由此二進位檔載入的任何動態程式庫/架構。
sequence of strings; default = []
要傳遞至連接器動作的額外連結選擇。
sequence of Files; default = []
要傳遞至連結器動作的額外檔案。
default = -1
是否要在連結的二進位檔中加入建構資訊。如果有 1，系統一律會包含建構資訊。如果為 0，系統一律會排除建構資訊。如果值為 -1 (預設值)，行為取決於 --[no]戳記旗標。為測試規則產生可執行的輸出內容時，應將此值設為 0。		 

struct apple_common.link_multi_arch_static_library(ctx)

連結指定 Apple 平台的 (可能為多架構) 靜態資料庫。這個方法包含部分 Starlark apple_static_library 規則邏輯，位於 rules_apple 網域中，可協助將其連結邏輯遷移至 rules_apple 中的 Starlark。

這個 API 屬於實驗性質，可能隨時變更。請勿依賴這項功能的穩定性。

參數

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

multi_arch_split

SplitTransitionProviderApi apple_common.multi_arch_split

規則屬性設定轉換，可在一個或多個 Apple 平台上建構依附元件。

如要使用這項轉換，您必須在規則中定義「platform_type」和「minimum_os_version」字串屬性，且這兩個屬性為必填項目。

platform_type 屬性的值會決定目標架構，並根據這個設定轉換建立依附元件。

選項包括：

  • ios：從 --ios_multi_cpus 收集到的架構。
  • macos：從 --macos_cpus 收集到的架構。
  • tvos：從 --tvos_cpus 收集到的架構。
  • watchos：從 --watchos_cpus 收集到的架構。

min_os_version 應為含有點號的版本字串 (例如「7.3」)，並用於根據平台類型，以類似的方式設定最低作業系統。例如，如果指定 platform_type「ios」和 min_os_version「8.0」，就能確保以 iOS 最低版本「8.0」建構依附元件。

new_dynamic_framework_provider

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

建立新的 AppleDynamicFramework 供應器例項。

參數

參數 說明
binary File; or None; default = None
動態架構的 dylib 二進位檔構件。
cc_info default = None
CcInfo，包含與二進位檔連結的遞移依附元件相關資訊。
objc 必要
ObjcProvider，內含連結至二進位檔的遞移依附元件相關資訊。
framework_dirs depset of strings; or None; 預設值 = None
用於連結動態架構的連結輸入內容的架構路徑名稱。
framework_files depset of Files; or None; default = None
應納入為動態架構連結輸入的完整構件組合

new_executable_binary_provider

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

建立新的 AppleExecutableBinaryInfo 供應器例項。

參數

參數 說明
binary File; or None; default = None
executable 的二進位檔構件。
cc_info default = None
CcInfo，其中包含連結至二進位檔的轉換依附元件相關資訊。
objc 必要
ObjcProvider，內含連結至二進位檔的遞移依附元件相關資訊。

new_objc_provider

ObjcProvider apple_common.new_objc_provider(**kwargs)

建立新的 ObjcProvider 例項。

參數

參數 說明
kwargs default = {}
引數的字典。

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
  • watchos_device
  • watchos_simulator

這些值可以傳送至需要平台的方法，例如 XcodeVersionConfig.sdk_version_for_platform。

platform_type

struct apple_common.platform_type

類似於列舉的結構體，其中包含與 Apple 平台類型相對應的下列欄位：
  • ios
  • macos
  • tvos
  • 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 required
供應商，其中包含 xcode 設定資訊。
platform required
Apple 平台。

XcodeProperties

Provider apple_common.XcodeProperties

XcodeVersionProperties 供應器的建構函式/鍵。

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

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

XcodeVersionConfig

Provider apple_common.XcodeVersionConfig

XcodeVersionConfig 供應器的建構函式/鍵。