Apple_common

Starlark が apple ルール実装の内部にアクセスするための関数。

メンバー

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

Apple ホストシステムでビルドツールを実行する必要があるアクション(使用する Xcode のバージョンなど)に設定する必要がある環境変数の dict を返します。キーは変数名で、値は対応する値です。

パラメータ

パラメータ 説明
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 のリスト。これは、バンドル ローダーや、このバイナリによって読み込まれる動的ライブラリ/フレームワークなど、別のイメージで実行時に見つかる依存関係に当てはまります。
文字列シーケンス。デフォルトは []
です。 リンカー アクションに渡される追加の linkopts。
Fileシーケンス。デフォルトは []
です。 リンカー アクションに渡す追加ファイル。
文字列シーケンス。デフォルトは []
です。 リンカー アクションに渡される追加のリクエスト機能。
文字列シーケンス。デフォルトは []
です。 リンカー アクションに渡す無効な追加機能。
デフォルトは -1
です。リンクされたバイナリにビルド情報を含めるかどうか。1 の場合、ビルド情報は常に含まれます。0 の場合、ビルド情報は常に除外されます。-1(デフォルト)の場合、動作は --[no]stamp フラグによって決まります。テストルールの実行可能出力を生成するときは、0 に設定する必要があります。

struct apple_common.link_multi_arch_static_library(ctx)

Apple プラットフォームを対象とする(マルチアーキテクチャの可能性がある)静的ライブラリをリンクします。このメソッドは、rules_apple ドメインの Starlark apple_static_library ルールロジックの一部を構成し、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 ファイル。または None。デフォルトは None
です。 動的フレームワークの dylib バイナリ アーティファクト。
cc_info デフォルトは None
です。 バイナリにリンクされた推移的依存関係に関する情報を含む CcInfo。
objc デフォルトは None
です。 バイナリにリンクされた推移的依存関係に関する情報を含む ObjcProvider。
framework_dirs stringdepset、または None。デフォルトは None
です。 ダイナミック フレームワークに対してリンクするために、リンク入力として使用されるフレームワーク パス名。
framework_files Filedepset、または 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]

プラットフォーム

struct apple_common.platform

Apple プラットフォームに対応する次のフィールドを含む enum のような構造体:
  • 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 プラットフォーム タイプに対応する次のフィールドを含む enum のような構造体:
  • 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)

指定された 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 プロバイダのコンストラクタ/キー。