การสร้างมาโครเดิม

รายงานปัญหา ดูแหล่งที่มา Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

สำคัญ: บทแนะนำนี้มีไว้สำหรับมาโครเดิม หากคุณต้องการรองรับเฉพาะ Bazel 8 ขึ้นไป เราขอแนะนำให้ใช้มาโครเชิงสัญลักษณ์แทน โปรดดูการสร้างมาโครเชิงสัญลักษณ์

สมมติว่าคุณต้องเรียกใช้เครื่องมือเป็นส่วนหนึ่งของการสร้าง เช่น คุณอาจต้องการสร้างหรือประมวลผลไฟล์ต้นฉบับล่วงหน้า หรือบีบอัดไบนารี ในบทแนะนำนี้ คุณจะได้สร้างมาโครเดิมที่จะปรับขนาดรูปภาพ

มาโครเหมาะสำหรับงานง่ายๆ หากต้องการทำสิ่งที่ซับซ้อนกว่านี้ เช่น เพิ่มการรองรับภาษาโปรแกรมใหม่ ให้ลองสร้างกฎ กฎช่วยให้คุณควบคุมและมีความยืดหยุ่นมากขึ้น

วิธีที่ง่ายที่สุดในการสร้างมาโครที่ปรับขนาดรูปภาพคือการใช้genrule

genrule(
    name = "logo_miniature",
    srcs = ["logo.png"],
    outs = ["small_logo.png"],
    cmd = "convert $< -resize 100x100 $@",
)

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    data = [":logo_miniature"],
)

หากต้องการปรับขนาดรูปภาพเพิ่มเติม คุณอาจต้องใช้โค้ดซ้ำ โดยทำดังนี้ กำหนดฟังก์ชันในไฟล์ .bzl แยกต่างหาก แล้วเรียกใช้ไฟล์ miniature.bzl

def miniature(name, src, size = "100x100", **kwargs):
    """Create a miniature of the src image.

    The generated file is prefixed with 'small_'.
    """
    native.genrule(
        name = name,
        srcs = [src],
        # Note that the line below will fail if `src` is not a filename string
        outs = ["small_" + src],
        cmd = "convert $< -resize " + size + " $@",
        **kwargs
    )

ข้อควรทราบ

  • ตามธรรมเนียมแล้ว มาโครเดิมจะมีอาร์กิวเมนต์ name เช่นเดียวกับกฎ

  • หากต้องการบันทึกลักษณะการทำงานของมาโครเดิม ให้ใช้สตริงเอกสารเหมือนใน Python

  • หากต้องการเรียกใช้ genrule หรือกฎดั้งเดิมอื่นๆ ให้ใส่คำนำหน้า native.

  • ใช้ **kwargs เพื่อส่งต่ออาร์กิวเมนต์เพิ่มเติมไปยัง genrule (ซึ่งทำงานเหมือนกับใน Python) ซึ่งจะเป็นประโยชน์เพื่อให้ผู้ใช้สามารถใช้แอตทริบิวต์มาตรฐาน เช่น visibility หรือ tags

ตอนนี้ให้ใช้มาโครจากไฟล์ BUILD

load("//path/to:miniature.bzl", "miniature")

miniature(
    name = "logo_miniature",
    src = "image.png",
)

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    data = [":logo_miniature"],
)

และสุดท้ายนี้ หมายเหตุคำเตือน: มาโครจะถือว่า src เป็นสตริงชื่อไฟล์ (มิฉะนั้น outs = ["small_" + src] จะทำงานไม่สำเร็จ) ดังนั้น src = "image.png" จึงใช้งานได้ แต่จะเกิดอะไรขึ้นหากไฟล์ BUILD ใช้ src = "//other/package:image.png" หรือแม้แต่ src = select(...) แทน

คุณควรประกาศสมมติฐานดังกล่าวในเอกสารประกอบของมาโคร อย่างไรก็ตาม แมโครเดิม โดยเฉพาะแมโครขนาดใหญ่ มักจะมีความเปราะบางเนื่องจาก การสังเกตและบันทึกสมมติฐานดังกล่าวทั้งหมดในโค้ดอาจเป็นเรื่องยาก และ แน่นอนว่าผู้ใช้แมโครบางรายจะไม่ยอมอ่านเอกสาร เราขอแนะนำให้ใช้มาโครสัญลักษณ์แทนหากเป็นไปได้ ซึ่งมี การตรวจสอบประเภทแอตทริบิวต์ในตัว