建立巨集

回報問題 查看原始碼 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

假設您需要在建構作業中執行工具。例如產生或預先處理來源檔案,或壓縮二進位檔。在本教學課程中,您將建立可調整圖片大小的巨集。

巨集適用於簡單的工作。如果只想執行更複雜的操作,例如新增對新的程式設計語言的支援,請考慮建立規則。規則可讓您享有更大的控制權和彈性。

如要建立可調整圖片大小的巨集,最簡單的方法就是使用 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 引數,就像規則一樣。

  • 如要記錄巨集的行為,請使用類似 Python 的文字說明

  • 如要呼叫 genrule 或任何其他原生規則,請使用 native.

  • 使用 **kwargs 將額外引數轉送至基礎 genrule (運作方式與 Python 相同)。這非常實用,讓使用者可以使用 visibilitytags 等標準屬性。

接著,請使用 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"],
)