マクロの作成

ビルドの一部としてツールを実行する必要があるとします。たとえば、ソースファイルの生成や前処理、バイナリの圧縮などを行う場合です。このチュートリアルでは、画像のサイズを変更するマクロを作成します。

マクロは単純なタスクに適しています。新しいプログラミング言語のサポートを追加するなど、より複雑な処理を行う場合は、ルールの作成を検討してください。ルールを使用すると、より細かく制御でき、柔軟性も高まります。

画像のサイズを変更するマクロを作成する最も簡単な方法は、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 引数があります。

  • マクロの動作を記述するには、 docstring を 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"],
)