ビルドの一環としてツールを実行する必要があるとします。たとえば、ソースファイルの生成や前処理、バイナリの圧縮を行います。このチュートリアルでは、画像のサイズを変更するマクロを作成します。
マクロは単純なタスクに適しています。新しいプログラミング言語のサポートを追加するなど、より複雑な処理を行う場合は、ルールの作成を検討してください。ルールを使用すると、より細かく柔軟に制御できます。
画像のサイズを変更するマクロを作成する最も簡単な方法は、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 と同様に docstring を使用します。
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"],
)