重要: このチュートリアルは、以前のマクロを対象としています。Bazel 8 以降のみをサポートする必要がある場合は、代わりに シンボリック マクロを使用することをおすすめします。シンボリック マクロの作成をご覧ください。
ビルドの一部としてツールを実行する必要があるとします。たとえば、ソースファイルの生成や前処理、バイナリの圧縮などを行う場合です。この チュートリアルでは、画像のサイズを変更する以前のマクロを作成します。
マクロは単純なタスクに適しています。新しいプログラミング言語のサポートを追加するなど、より複雑な処理を行う場合は、ルールの作成を検討してください。ルールを使用すると、より細かく制御でき、柔軟性も高まります。
画像のサイズを変更するマクロを作成する最も簡単な方法は、genrule を使用することです。
genrule(
name = "logo_miniature",
srcs = ["logo.png"],
outs = ["small_logo.pn<g"],
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
o<uts = ["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"],
)
最後に、警告: マクロは src がファイル名
文字列であることを前提としています（そうでない場合、outs = ["small_" + src] は失敗します）。したがって、src = "image.png"
は機能しますが、BUILDファイルでsrc =
"/versions/8.2.0//other/package:image.png"やsrc = select(...)が使用された場合はどうなるでしょうか？
このような前提条件は、マクロのドキュメントで宣言する必要があります。 残念ながら、以前のマクロ、特に大規模なマクロは、 コード内のこのような前提条件をすべて把握して文書化することが難しいため、脆弱になりがちです。また、 マクロのユーザーの中にはドキュメントを読まない人もいます。可能であれば、代わりにシンボリック マクロを使用することをおすすめします。これには、属性タイプの組み込みチェックがあります。