apel_umum

Laporkan masalah Lihat sumber Malam · 7,3 · 7,2 · 7,1 · 7,0 · 6,5

Fungsi untuk Starlark guna mengakses internal dari implementasi aturan apple.

Anggota

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

Menampilkan dict variabel lingkungan yang harus ditetapkan untuk tindakan yang perlu menjalankan alat build pada sistem host Apple, seperti versi Xcode yang harus digunakan. Kunci adalah nama variabel dan nilainya adalah nilai yang sesuai.

Parameter

Parameter Deskripsi
xcode_config wajib
Penyedia yang berisi informasi tentang konfigurasi xcode.

apple_toolchain

apple_toolchain apple_common.apple_toolchain()

Utilitas untuk me-resolve item dari toolchain Apple.

AppleDebugOutputs

Provider apple_common.AppleDebugOutputs

Konstruktor/kunci untuk penyedia AppleDebugOutputs.

Jika target menyebarkan penyedia AppleDebugOutputs, gunakan ini sebagai kunci yang akan digunakan untuk mengambilnya. Contoh:

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

AppleDynamicFramework

Provider apple_common.AppleDynamicFramework

Konstruktor/kunci untuk penyedia AppleDynamicFramework.

Jika target menyebarkan penyedia AppleDynamicFramework, gunakan ini sebagai kunci yang akan digunakan untuk mengambilnya. Contoh:

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

AppleExecutableBinary

Provider apple_common.AppleExecutableBinary

Konstruktor/kunci untuk penyedia AppleExecutableBinary.

Jika target menyebarkan penyedia AppleExecutableBinary, gunakan ini sebagai kunci yang akan digunakan untuk mengambilnya. Contoh:

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

dotted_version

DottedVersion apple_common.dotted_version(version)

Membuat instance DottedVersion baru.

Parameter

Parameter Deskripsi
version wajib
Representasi string dari 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)

Menautkan biner (kemungkinan multi-arsitektur) yang menargetkan platform Apple. Metode ini terdiri dari sebagian besar logika aturan apple_binary Starlark dalam domain rules_apple dan ada untuk membantu migrasi logika penautannya ke Starlark di rules_apple.

API ini sangat eksperimental dan dapat berubah sewaktu-waktu. Jangan bergantung pada stabilitas fungsi ini untuk saat ini.

Parameter

Parameter Deskripsi
wajib
Konteks aturan Starlark.
urutan Target; atau None; default adalah None
Daftar Target yang ada dalam grafik dependensi biner tetapi library-nya tidak boleh ditautkan ke dalam biner. Inilah kasus untuk dependensi yang akan ditemukan saat runtime di gambar lain, seperti loader bundle atau library/framework dinamis apa pun yang akan dimuat oleh biner ini.
urutan string; default adalah []
Linkopt tambahan yang akan diteruskan ke tindakan penaut.
urutan File; default adalah []
File tambahan yang akan diteruskan ke tindakan penaut.
urutan string; default adalah []
Fitur tambahan yang diminta untuk diteruskan ke tindakan penaut.
urutan string; default adalah []
Fitur tambahan yang dinonaktifkan yang akan diteruskan ke tindakan penaut.
default adalah -1
Apakah akan menyertakan informasi build dalam biner tertaut. Jika 1, informasi build akan selalu disertakan. Jika 0, informasi build selalu dikecualikan. Jika -1 (default), perilaku ditentukan oleh penanda --[no]stamp. Nilai ini harus disetel ke 0 saat membuat output yang dapat dieksekusi untuk aturan pengujian. 

struct apple_common.link_multi_arch_static_library(ctx)

Menautkan library statis (kemungkinan multi-arsitektur) yang menargetkan platform Apple. Metode ini terdiri dari bagian dari logika aturan apple_static_library Starlark, dalam domain rules_apple dan ada untuk membantu migrasi logika penautannya ke Starlark di rules_apple.

API ini sangat eksperimental dan dapat berubah sewaktu-waktu. Jangan bergantung pada stabilitas fungsi ini untuk saat ini.

Parameter

Parameter Deskripsi
wajib
Konteks aturan 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)

Membuat instance penyedia AppleDynamicFramework baru.

Parameter

Parameter Deskripsi
binary File; atau None; default adalah None
Artefak biner dylib dari framework dinamis.
cc_info default adalah None
CcInfo yang berisi informasi tentang dependensi transitif yang ditautkan ke biner.
objc default adalah None
ObjcProvider yang berisi informasi tentang dependensi transitif yang ditautkan ke dalam biner.
framework_dirs depset dari string; atau None; default adalah None
Nama jalur framework yang digunakan sebagai input link untuk menautkan ke framework dinamis.
framework_files depset dari File; atau None; default adalah None
Kumpulan lengkap artefak yang harus disertakan sebagai input untuk ditautkan dengan framework dinamis

new_executable_binary_provider

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

Membuat instance penyedia AppleExecutableBinaryInfo baru.

Parameter

Parameter Deskripsi
binary File; atau None; default adalah None
Artefak biner dari file yang dapat dieksekusi.
cc_info default adalah None
CcInfo yang berisi informasi tentang dependensi transitif yang ditautkan ke biner.
objc default adalah None
ObjcProvider yang berisi informasi tentang dependensi transitif yang ditautkan ke dalam biner.

new_objc_provider

ObjcProvider apple_common.new_objc_provider(**kwargs)

Membuat instance ObjcProvider baru.

Parameter

Parameter Deskripsi
kwargs default adalah {}
Kamus argumen.

Objc

Provider apple_common.Objc

Konstruktor/kunci untuk penyedia Objc.

Jika target menyebarkan penyedia Objc, gunakan ini sebagai kunci yang akan digunakan untuk mengambilnya. Contoh:

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

platform

struct apple_common.platform

Struktur mirip enum yang berisi kolom berikut yang sesuai dengan platform Apple:
  • ios_device
  • ios_simulator
  • macos
  • tvos_device
  • tvos_simulator
  • visionos_device
  • visionos_simulator
  • watchos_device
  • watchos_simulator

Nilai ini dapat diteruskan ke metode yang mengharapkan platform, seperti XcodeVersionConfig.sdk_version_for_platform.

platform_type

struct apple_common.platform_type

Struktur mirip enum yang berisi kolom berikut yang sesuai dengan jenis platform Apple:
  • ios
  • macos
  • tvos
  • visionos
  • watchos

Nilai ini dapat diteruskan ke metode yang mengharapkan jenis platform, seperti 'apple' metode multi_arch_platform fragmen konfigurasi.

Contoh:

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

target_apple_env

dict apple_common.target_apple_env(xcode_config, platform)

Menampilkan dict variabel lingkungan yang harus ditetapkan untuk tindakan yang membangun target dari jenis platform Apple tertentu. Misalnya, kamus ini berisi variabel yang menunjukkan nama platform dan versi SDK yang akan digunakan untuk membangun. Kunci adalah nama variabel dan nilainya adalah nilai yang sesuai.

Parameter

Parameter Deskripsi
xcode_config wajib
Penyedia yang berisi informasi tentang konfigurasi xcode.
platform wajib
Platform Apple.

XcodeProperties

Provider apple_common.XcodeProperties

Konstruktor/kunci untuk penyedia XcodeVersionProperties.

Jika target menyebarkan penyedia XcodeVersionProperties, gunakan ini sebagai kunci yang akan digunakan untuk mengambilnya. Contoh:

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

XcodeVersionConfig

Provider apple_common.XcodeVersionConfig

Konstruktor/kunci untuk penyedia XcodeVersionConfig.