假设您需要在构建过程中运行某个工具。例如,您可能需要生成或预处理源文件,或者压缩二进制文件。在本教程中,您将创建一个用于调整图片大小的宏。
宏适用于简单任务。如果您想执行更复杂的任务(例如添加对新编程语言的支持),请考虑创建规则。规则可让您获得更大的控制权和灵活性。
创建用于调整图片大小的宏的最简单方法是使用 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 中一样)。 这非常有用,因此用户可以使用标准属性,例如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"],
)