建立舊版巨集

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

重要事項:本教學課程適用於舊版巨集。如果您只需要支援 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 相同)。這項功能非常實用,可讓使用者使用 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"],
)

最後,警告事項:巨集會假設 src 是檔案名稱字串 (否則 outs = ["small_" + src] 會失敗)。因此 src = "image.png" 會正常運作;但如果 BUILD 檔案改用 src = "//other/package:image.png",甚至 src = select(...),會發生什麼情況?

請務必在巨集的說明文件中宣告這類假設。遺憾的是,舊版巨集 (尤其是大型巨集) 通常較不穩定,因為很難在程式碼中注意到並記錄所有這類假設,當然,有些巨集使用者也不會閱讀說明文件。建議您盡可能改用符號巨集,因為這類巨集會對屬性類型進行內建檢查。