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

unknown apple_common.apple_toolchain()

ยูทิลิตีสำหรับการแปลงรายการจาก Apple Toolchain

AppleDebugOutputs

None 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 string; ต้องระบุ
การแสดงสตริงของ 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 นี้ยังอยู่ในขั้นทดลองสูงและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ อย่าพึ่งพาความเสถียรของฟังก์ชันนี้ในตอนนี้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
ctx; ต้องระบุ
บริบทของกฎ Starlark
ลำดับ ของเป้าหมาย หรือ None; ค่าเริ่มต้นคือ None
รายการ Target ที่อยู่ในกราฟทรัพยากร Dependency ของไบนารี แต่ไลบรารีไม่ควรลิงก์กับไบนารี โดยเป็นกรณีของทรัพยากร Dependency ที่จะพบขณะรันไทม์ในอิมเมจอื่น เช่น ตัวโหลด Bundle หรือไลบรารี/เฟรมแบบไดนามิกที่ไฟล์ไบนารีนี้จะโหลด
sequence ของ strings ค่าเริ่มต้นคือ []
ลิงก์ตัวเลือกเพิ่มเติมที่จะส่งไปให้กับการดำเนินการของ Linker
sequence ของไฟล์ ค่าเริ่มต้นคือ []
ไฟล์เพิ่มเติมที่จะส่งต่อไปยังการดำเนินการ Linker
sequence ของ strings ค่าเริ่มต้นคือ []
ฟีเจอร์ที่ขอเพิ่มเติมซึ่งจะส่งไปยังการดำเนินการของ Linker
sequence ของ strings ค่าเริ่มต้นคือ []
ฟีเจอร์ที่ปิดใช้เพิ่มเติมซึ่งจะส่งไปยังการทำงานของ Linker
int; ค่าเริ่มต้นคือ -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 นี้ยังอยู่ในขั้นทดลองสูงและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ อย่าพึ่งพาความเสถียรของฟังก์ชันนี้ในตอนนี้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
ctx; ต้องระบุ
บริบทของกฎ Starlark

new_dynamic_framework_provider

unknown apple_common.new_dynamic_framework_provider(binary=None, cc_info, framework_dirs=None, framework_files=None)

สร้างอินสแตนซ์ผู้ให้บริการ AppleDynamicFramework ใหม่

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
binary ไฟล์ หรือ None; ค่าเริ่มต้นคือ None
อาร์ติแฟกต์ไบนารี Dylib ของเฟรมเวิร์กแบบไดนามิก
cc_info CcInfo; ต้องระบุ
CcInfo ที่มีข้อมูลเกี่ยวกับทรัพยากร Dependency แบบทรานซิทีฟที่ลิงก์กับไบนารี
framework_dirs depset ของ strings หรือ None; ค่าเริ่มต้นคือ None
ชื่อเส้นทางเฟรมเวิร์กที่ใช้เป็นอินพุตลิงก์เพื่อลิงก์กับเฟรมเวิร์กแบบไดนามิก
framework_files depset ของไฟล์ หรือ None; ค่าเริ่มต้นคือ None
อาร์ติแฟกต์ทั้งหมดที่ควรรวมไว้เป็นอินพุตเพื่อลิงก์กับเฟรมเวิร์กแบบไดนามิก

new_executable_binary_provider

unknown apple_common.new_executable_binary_provider(binary=None, cc_info)

สร้างอินสแตนซ์ผู้ให้บริการ AppleExecutableBinaryInfo ใหม่

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
binary ไฟล์ หรือ None; ค่าเริ่มต้นคือ None
อาร์ติแฟกต์ไบนารีของไฟล์ปฏิบัติการ
cc_info CcInfo; ต้องระบุ
CcInfo ที่มีข้อมูลเกี่ยวกับทรัพยากร Dependency แบบทรานซิทีฟที่ลิงก์กับไบนารี

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

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

ตัวอย่าง

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