การสร้างมาโคร

รายงานปัญหา ดูแหล่งที่มา

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

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

วิธีที่ง่ายที่สุดในการสร้างมาโครที่ปรับขนาดรูปภาพคือการใช้ 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],
    outs = ["small_" + src],
    cmd = "convert $< -resize " + size + " $@",
    **kwargs
  )

โดยมีข้อควรทราบดังนี้

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

  • หากต้องการบันทึกลักษณะการทํางานของมาโคร ให้ใช้ docstring เช่น ใน 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"],
)