マクロの作成

7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

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

画像のサイズを変更するマクロを作成する最も簡単な方法は、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"],
)