Bazel C++ 基础

  • 原文:http://www.bazel.io/docs/cpp.html
  • 译者:chai2010

运绝对路径

涵盖的门道是对立于工作区的干净路径。假设发生以下的目结构:

[workspace]/
    WORKSPACE
    a/
        BUILD
        a.h
        a.cc
    b/
        BUILD
        b.h
        b.cc
        main.cc

如果b/main.cc要包含b.h头文件,我们用创造以下的b/BUILD文件:

cc_library(
    name = "b",
    srcs = ["b.cc"],
    hdrs = ["b.h"],
)

cc_binary(
    name = "main",
    srcs = ["main.cc"],
    deps = [":b"],
)

b/main.cc好如此含有b.h

#include "b/b.h"

点的条文件包含路径是对立于工作区根目录的相对路径。如果b/main.cc还要靠a/a.h头文件的语句,我们尚亟需添加a/BUILD文件:

cc_library(
    name = "a",
    srcs = ["a.cc"],
    hdrs = ["a.h"],
    visibility = ["//b:__pkg__"],
)

然后我们于b/BUILD累加乘关系:

cc_binary(
    name = "main",
    srcs = ["main.cc"],
    deps = [
        ":b",
        "//a",
    ],
)

b/main.cc代码中吗富含了a/a.h头文件:

#include "a/a.h"

b/main.cc虽可以健康下a/a.hb/b.h中导出之符号了。

赖传递

假如带有了一个条文件,那么需要将头文件对应的库添加暨依靠中。不过,只待有增长直接依赖之仓库。假设三明治对应之sandwich.h文本包含了面包对应之bread.h文件,同时bread.h而且带有了面粉对应的flour.h文件。但是,三明治sandwich.h文本并不曾直接包含面粉flour.h文本(三明治用户当然不体贴面粉的事体),因此BUILD文件可以这样:

cc_library(
    name = "sandwich",
    srcs = ["sandwich.cc"],
    hdrs = ["sandwich.h"],
    deps = [":bread"],
)

cc_library(
    name = "bread",
    srcs = ["bread.cc"],
    hdrs = ["bread.h"],
    deps = [":flour"],
)

cc_library(
    name = "flour",
    srcs = ["flour.cc"],
    hdrs = ["flour.h"],
)

面表示了sandwich三明治库因bread面包库,bread又依赖flour对应之面粉库。

增补加头文件包含路径

多多时刻你恐怕连无期望基于工作区根路径的相对路径来含有每个头文件。因为多已经有的老三方库的头文件包含方式并无是依据工作区的根路径。假设发生以下目录结构:

[workspace]/
    WORKSPACE
    third_party/
        some_lib/
            include/
                some_lib.h
            BUILD
            some_lib.cc

Bazel希望用third_party/some_lib/include/some_lib.h方式包含some_lib.h,但是some_lib.cc或是与梦想就此"include/some_lib.h"方包含。为了使包含路径有效,需要以third_party/some_lib/BUILD文件中将some_lib/目录添加到头文件包含路径的索列表中:

cc_library(
    name = "some_lib",
    srcs = ["some_lib.cc"],
    hdrs = ["some_lib.h"],
    copts = ["-Ithird_party/some_lib"],
)

立刻对因的标第三方库特别实用,因为好避免在峰文件路径中起无关之external/[repository-name]/前缀。

带有外部库:一个事例

如下了 Google
Test。可以在WORKSPACE文本中使new_启的库房相关的函数,下载依赖之GTest代码到即仓库着:

new_http_archive(
    name = "gtest",
    url = "https://googletest.googlecode.com/files/gtest-1.7.0.zip",
    sha256 = "247ca18dd83f53deb1328be17e4b1be31514cedfc1e3424f672bf11fd7e0d60d",
    build_file = "gtest.BUILD",
)

创建gtest.BUILD文本,对承诺Google
Test的构建配置文件。配置文件中发出几乎独需要特别注意的地方:

  • gtest-1.7.0/src/gtest-all.cc文件已使#include语法包含了gtest-1.7.0/src/目中其他*.cc文件,因此待以它消除以外(也可以仅含它一个文本,但是要对配置包含路径)。
  • 它们的头文件于gtest-1.7.0/include/目,需要以它长到头文件包含路径列表中
  • GTest依赖pthread多线程库,通过linkopt选料指定。

最后之规则大约是这么:

cc_library(
    name = "main",
    srcs = glob(
        ["gtest-1.7.0/src/*.cc"],
        exclude = ["gtest-1.7.0/src/gtest-all.cc"]
    ),
    hdrs = glob([
        "gtest-1.7.0/include/**/*.h",
        "gtest-1.7.0/src/*.h"
    ]),
    copts = [
        "-Iexternal/gtest/gtest-1.7.0/include"
    ],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

旋即是发生硌乱:所有为gtest-1.7.0也前缀的实际还是转变的临时文件。我们好透过new_http_archive函数中之strip_prefix性能来忽略她:

new_http_archive(
    name = "gtest",
    url = "https://googletest.googlecode.com/files/gtest-1.7.0.zip",
    sha256 = "247ca18dd83f53deb1328be17e4b1be31514cedfc1e3424f672bf11fd7e0d60d",
    build_file = "gtest.BUILD",
    strip_prefix = "gtest-1.7.0",
)

现在gtest.BUILD简单多矣:

cc_library(
    name = "main",
    srcs = glob(
        ["src/*.cc"],
        exclude = ["src/gtest-all.cc"]
    ),
    hdrs = glob([
        "include/**/*.h",
        "src/*.h"
    ]),
    copts = ["-Iexternal/gtest/include"],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

现在cc_相关的平整可经//external:gtest/main引用GTest了。

比如:我们可创建以下测试:

#include "gtest/gtest.h"

TEST(FactorialTest, Negative) {
  EXPECT_EQ(1, 1);
}

创造对应之BUILD文件:

cc_test(
    name = "my_test",
    srcs = ["my_test.cc"],
    copts = ["-Iexternal/gtest/include"],
    deps = ["@gtest//:main"],
)

使用bazel test一声令下运行测试。

拄预编译的库房

要如乘一个都编译好之堆栈(可能只有头文件与对应的*.so仓库文件),可以行使cc_library规则包装一个仓库对象:

cc_library(
    name = "mylib",
    srcs = ["mylib.so"],
    hdrs = ["mylib.h"],
)

另的目标虽可凭借是包的库对象了。