Apple_Common

7.3 · 7.2 · 7.1 · 7.0 · 6.5

ฟังก์ชันสําหรับ Starlark เพื่อเข้าถึงข้อมูลภายในของการติดตั้งใช้งานกฎ Apple

สมาชิก

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

แสดงผล dict ของตัวแปรสภาพแวดล้อมที่ควรตั้งค่าสำหรับการดำเนินการที่ต้องเรียกใช้เครื่องมือบิลด์ในระบบโฮสต์ของ 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=[], extra_requested_features=[], extra_disabled_features=[], stamp=-1)

ลิงก์ไบนารี (อาจเป็นแบบหลายสถาปัตยกรรม) ที่กำหนดเป้าหมายแพลตฟอร์ม Apple เมธอดนี้ประกอบด้วยตรรกะจำนวนมากของกฎ Starlark apple_binary ในโดเมน rules_apple และมีไว้เพื่อช่วยในการย้ายข้อมูลตรรกะการลิงก์เข้ากับ Starlark ใน rules_apple

API นี้อยู่ในขั้นทดลองขั้นสูงและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ อย่าพึ่งพาความเสถียรของฟังก์ชันนี้ในตอนนี้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
ต้องระบุ
บริบทของกฎ Starlark
ลําดับ Target หรือ None ค่าเริ่มต้นคือ None
รายการ Target ที่อยู่ในกราฟความเกี่ยวข้องของไบนารี แต่ไม่ควรลิงก์ไลบรารีเข้ากับไบนารี โดยเป็นกรณีของทรัพยากร Dependency ที่จะพบขณะรันไทม์ในอิมเมจอื่น เช่น ตัวโหลด Bundle หรือไลบรารี/เฟรมแบบไดนามิกที่ไฟล์ไบนารีนี้จะโหลด
ลําดับสตริง ค่าเริ่มต้นคือ []
linkopts เพิ่มเติมที่จะส่งไปยังการดำเนินการของ linker
ลำดับ ของไฟล์ ค่าเริ่มต้นคือ []
ไฟล์เพิ่มเติมที่จะส่งไปยังการดำเนินการ Linker
ลําดับสตริง ค่าเริ่มต้นคือ []
ส่งฟีเจอร์ที่ขอเพิ่มเติมไปยังการดำเนินการของ linker
ลำดับของสตริง ค่าเริ่มต้นคือ []
ฟีเจอร์ที่ปิดใช้เพิ่มเติมซึ่งจะส่งไปยังการดำเนินการของ Linker
ค่าเริ่มต้นคือ -1
หากต้องการรวมข้อมูลบิลด์ในไบนารีที่ลิงก์ หากเป็น 1 ระบบจะรวมข้อมูลบิลด์เสมอ หากเป็น 0 ระบบจะยกเว้นข้อมูลบิลด์เสมอ หากเป็น -1 (ค่าเริ่มต้น) ลักษณะการทำงานจะกำหนดโดยแฟล็ก --[no]stamp ซึ่งควรตั้งค่าเป็น 0 เมื่อสร้างเอาต์พุตที่เป็นไฟล์ปฏิบัติการสำหรับกฎการทดสอบ 

struct apple_common.link_multi_arch_static_library(ctx)

ลิงก์ไลบรารีแบบคงที่ (อาจมีหลายสถาปัตยกรรม) ที่กําหนดเป้าหมายแพลตฟอร์ม Apple วิธีการนี้เป็นส่วนหนึ่งของตรรกะกฎ apple_static_library ของ Starlark ในโดเมน rules_apple และมีหน้าที่ช่วยในการย้ายข้อมูลตรรกะการลิงก์ไปยัง Starlark ใน rules_apple

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 File หรือ None ค่าเริ่มต้นคือ None
อาร์ติแฟกต์ไบนารีของ Dylib ของเฟรมเวิร์กแบบไดนามิก
cc_info ค่าเริ่มต้นคือ None
CcInfo ซึ่งมีข้อมูลเกี่ยวกับ transitive dependencies ที่ลิงก์กับไบนารี
objc ค่าเริ่มต้นคือ None
ObjcProvider ที่มีข้อมูลเกี่ยวกับ transitive dependencies ที่ลิงก์กับไบนารี
framework_dirs depset ของ string หรือ None ค่าเริ่มต้นคือ None
ชื่อเส้นทางเฟรมเวิร์กที่ใช้เป็นอินพุตลิงก์เพื่อลิงก์กับเฟรมเวิร์กแบบไดนามิก
framework_files depset ของไฟล์ หรือ 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 ที่มีข้อมูลเกี่ยวกับทรัพยากร Dependency แบบทรานซิทีฟที่ลิงก์กับไบนารี
objc ค่าเริ่มต้นคือ None
ObjcProvider ที่มีข้อมูลเกี่ยวกับทรัพยากร Dependency แบบทรานซิทีฟที่ลิงก์กับไบนารี

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]

platform

struct apple_common.platform

โครงสร้างคล้าย Enum ที่มีช่องต่อไปนี้ซึ่งสอดคล้องกับแพลตฟอร์ม 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

โครงสร้างที่คล้ายกับ enum ซึ่งมีช่องต่อไปนี้ซึ่งสอดคล้องกับประเภทแพลตฟอร์มของ Apple
  • ios
  • macos
  • tvos
  • visionos
  • watchos

ค่าเหล่านี้ส่งผ่านไปยังเมธอดที่คาดว่าจะเป็นประเภทแพลตฟอร์มได้ เช่น เมธอด multi_arch_platform ของส่วนย่อย "apple"

ตัวอย่าง

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 ต้องระบุ
ผู้ให้บริการที่มีข้อมูลเกี่ยวกับการกำหนดค่า 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