重要: このチュートリアルは、Bazel 8 で導入された新しい マクロシステムである シンボリック マクロ を対象としています。古いバージョンの Bazel をサポートする必要がある場合は、 代わりにレガシー マクロを作成する必要があります。 レガシー マクロの作成をご覧ください。
ビルドの一部としてツールを実行する必要があるとします。たとえば、ソースファイルの生成や前処理、バイナリの圧縮などを行う場合です。この チュートリアルでは、画像のサイズを変更するシンボリックマクロを作成します。
マクロは単純なタスクに適しています。新しいプログラミング言語のサポートの追加など、より複雑な処理を行う場合は、ルールの作成を検討してください。ルールを使用すると、より細かく制御でき、柔軟性も高まります。
画像のサイズを変更するマクロを作成する最も簡単な方法は、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という名前を付けます。
# Implementation function
def _miniature_impl(name, visibility, src, size, **kwargs):
native.genrule(
name = name,
visibility = visibility,
srcs = [src],
outs = [name + "_small_" + src.name],
cmd = "convert $< -resize " + size + " $@",
**kwargs,
)
# Macro declaration
miniature = macro(
doc = """Create a miniature of the src image.
The generated file name will be prefixed with `name + "_small_"`.
""",
implementation = _miniature_impl,
# Inherit most of genrule's attributes (such as tags and testonly)
inherit_attrs = native.genrule,
attrs = {
"src": attr.label(
doc = "Image file",
allow_single_file = True,
# Non-configurable because our genrule's output filename is
# suffixed with src's name. (We want to suffix the output file with
# srcs's name because some tools that operate on image files expect
# the files to have the right file extension.)
configurable = False,
),
"size": attr.string(
doc = "Output size in WxH format",
default = "100x100",
),
# Do not allow callers of miniature() to set srcs, cmd, or outs -
# _miniature_impl overrides their values when calling native.genrule()
"srcs": None,
"cmd": None,
"outs": None,
},
)
注意点:
シンボリック マクロの実装関数には、
nameとvisibilityパラメータが必要です。これらは、マクロのメイン ターゲットに使用する必要があります。シンボリック マクロの動作を記述するには、
docパラメータをmacro()とその属性に使用します。genruleまたは他のネイティブ ルールを呼び出すには、native.を使用します。**kwargsを使用して、追加の継承された引数を基盤となるgenruleに転送します（ Python と同様に機能します）。 これにより、ユーザーはtagsやtestonlyなどの標準属性を設定できます。
次に、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"],
)