C++ と Bazel

問題を報告 ソースを表示

このページには、C++ プロジェクトで Bazel を使用する際に役立つリソースが記載されています。Bazel を使用した C++ プロジェクトのビルドに関するチュートリアル、ビルドルール、その他の情報にリンクされています。

Bazel の操作

C++ プロジェクトで Bazel を使用する際は、次のリソースを参考にしてください。

ベスト プラクティス

Bazel の一般的なベスト プラクティスに加えて、C++ プロジェクトに固有のベスト プラクティスを以下に示します。

BUILD ファイル

BUILD ファイルを作成する場合は、次のガイドラインに従ってください。

  • 各 BUILD ファイルには、ディレクトリ内のコンパイル単位ごとに 1 つの cc_library ルール ターゲットを含める必要があります。

  • インクリメンタリティを最大化し、ビルドを並列化するために、C++ ライブラリはできる限り細分化する必要があります。

  • srcs にソースファイルが 1 つしかない場合は、その C++ ファイルの名前と同じ名前をライブラリに付けます。このライブラリには、C++ ファイル、一致するヘッダー ファイル、ライブラリの直接依存関係が含まれている必要があります。次に例を示します。

    cc_library(
    name = "mylib",
    srcs = ["mylib.cc"],
    hdrs = ["mylib.h"],
    deps = [":lower-level-lib"]
)

  • ファイル内の cc_library ターゲットごとに 1 つの cc_test ルール ターゲットを使用します。ターゲット [library-name]_test とソースファイルに [library-name]_test.cc という名前を付けます。たとえば、上記の mylib ライブラリ ターゲットのテスト ターゲットは次のようになります。

    cc_test(
    name = "mylib_test",
    srcs = ["mylib_test.cc"],
    deps = [":mylib"]
)

含めるパス

インクルード パスについては、次のガイドラインに従ってください。

  • すべてのインクルード パスをワークスペース ディレクトリからの相対パスにします。

  • システム以外のヘッダーには、山かっこ（#include <foo/bar/baz.h>）ではなく、引用符付きインクルード（#include "foo/bar/baz.h"）を使用します。

  • .（現在のディレクトリ）や ..（親ディレクトリ）などの UNIX のディレクトリ ショートカットは使用しないでください。

  • 外部リポジトリに接頭辞が必要な場合など、プロジェクト リポジトリの外部を指す必要がある以前のコードまたは third_party コードの場合は、cc_library ルール ターゲットで include_prefix 引数と strip_include_prefix 引数を使用します。

ツールチェーンの機能

以下のオプションの機能を使用すると、C++ プロジェクトの健全性を改善できます。有効にするには、--features コマンドライン フラグ、または repo、package、cc_* ルールの features 属性を使用します。

  • parse_headers 機能を使用すると、--process_headers_in_dependencies フラグを使用するときに、ビルド ターゲット内のすべてのヘッダー ファイルとその依存関係を C++ コンパイラで解析できます（ただし、コンパイルは行いません）。これにより、ヘッダーのみのライブラリの問題を検出し、ヘッダーが自己完結型で、含まれる順序とは無関係になります。
  • layering_check 機能により、ターゲットには、その直接の依存関係によって提供されるヘッダーのみが含まれます。デフォルトのツールチェーンは、Linux で clang をコンパイラとして使用するこの機能をサポートしています。