Apple_common

問題を報告 ソースを表示

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

メンバー

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

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

パラメータ

パラメータ 説明
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=[], extra_requested_features=[], extra_disabled_features=[], stamp=-1)

Apple プラットフォームをターゲットとするバイナリ（場合によってはマルチアーキテクチャ）をリンクします。このメソッドは、rules_apple ドメインの Starlark apple_binary ルールのロジックの大部分で構成されており、rules_apple の Starlark へのリンクロジックの移行を支援するために存在します。

この API は試験運用中であり、いつでも変更される可能性があります。現時点では、この関数の安定性に依存しないでください。

パラメータ

パラメータ 説明
required
Starlark ルールのコンテキスト。
Target のシーケンス、または None。デフォルトは None
バイナリの依存関係グラフに存在し、そのライブラリをバイナリにリンクしてはならない Target のリスト。たとえば、バンドル ローダや、このバイナリによって読み込まれる動的なライブラリ/フレームワークなど、実行時に別のイメージに存在する依存関係がこれに該当します。
文字列のシーケンス。デフォルトは []
リンカー アクションに渡される追加の linkopt。
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 は試験運用中であり、いつでも変更される可能性があります。現時点では、この関数の安定性に依存しないでください。

パラメータ

パラメータ 説明
required
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 string の 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 ファイルまたは None。デフォルトは None です。
実行可能ファイルのバイナリ アーティファクト。
cc_info デフォルトは None です。
バイナリにリンクされている推移的依存関係に関する情報を含む CcInfo。
objc デフォルトは None
バイナリにリンクされている推移的依存関係に関する情報を含む ObjcProvider です。

new_objc_provider

ObjcProvider apple_common.new_objc_provider(**kwargs)

新しい ObjcProvider インスタンスを作成します。

パラメータ

パラメータ 説明
kwargs デフォルトは {} です。
引数の辞書。

オブジェクト

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)

指定された Apple プラットフォーム タイプのターゲットをビルドするアクションに設定する必要がある環境変数の dict を返します。たとえば、このディクショナリには、ビルドに使用するプラットフォーム名と 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 プロバイダのコンストラクタまたはキー。