Apple 一般

適用於 Starlark 的函式，用於存取 Apple 規則實作的內部項目。

成員

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

傳回需要在 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=[], stamp=-1)

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

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

參數

參數 說明
必要
Starlark 規則內容。
sequence of Targets; or None； 預設值 = 無
位於二進位檔依附元件圖表中，但其程式庫不應連結至二進位檔的 Target 清單。也就是在不同映像檔的執行階段中找到的依附元件，例如軟體包載入器，或是由此二進位檔載入的任何動態程式庫/架構。
sequence of strings； 預設 = []
要傳遞至連接器動作的額外連結選擇。
sequence of Files； 預設 = []
要傳遞至連接器動作的額外檔案。
預設 = -1
是否在連結的二進位檔中加入建構資訊。如果有 1，系統一律會包含建構資訊。如果設為 0，系統會一律排除建構資訊。如果值為 -1 (預設值)，行為取決於 --[no]戳記旗標。為測試規則產生可執行輸出內容的輸出內容時，應設為 0。 

struct apple_common.link_multi_arch_static_library(ctx)

連結以 Apple 平台為目標的 (可能多架構) 靜態資料庫。這個方法包含在 rules_apple 網域中的 Starlark apple_static_library 規則邏輯的一部分，可協助將連結邏輯遷移至 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； 預設值 = 無
動態架構的 dylib 二進位構件。
cc_info 預設值 = 無
CcInfo，包含與二進位檔連結的遞移依附元件相關資訊。
objc 必要
ObjcProvider，內含連結至二進位檔的遞移依附元件相關資訊。
framework_dirs depset of strings; or None； 預設值 = 無
用來與動態架構建立連結的架構路徑名稱，用來當做連結輸入內容。
framework_files depset of Files; or None； 預設值 = 無
完整構件組合應包含為與動態架構連結的輸入內容

new_executable_binary_provider

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

建立新的 AppleExecutableBinaryInfo 供應商執行個體。

參數

參數 說明
binary File; or None； 預設值 = 無
可執行檔的二進位成果。
cc_info 預設值 = 無
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)

傳回應為指定 Apple 平台類型建構目標的動作所應設定的環境變數 dict。舉例來說，這個字典包含變數，代表要建立的平台名稱和 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 提供者的建構函式/金鑰。