blob: e29cd480040c03a5721ea69b953a842672398b8a [file] [log] [blame]
# Copyright 2018 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import("//build/rust/rustc_artifact.gni")
import("//build/rust/rustc_test.gni")
# Defines a Rust library
#
# Parameters
#
# name
# Name of the crate as defined in its manifest file. If not specified, it is
# assumed to be the same as the target name. All dashes will be replaced
# with underscores in the library name: <name_underscored>
#
# version
# Semver version of the crate as seen on crates.io.
#
# edition
# Edition of the Rust language to be used. See
# https://doc.rust-lang.org/edition-guide/editions/index.html for more info on rust editions.
#
# configs (optional)
# A list of config labels applying to this target.
#
# enforce_source_listing (optional)
# When true, enforces that any source files used by the Rust compiler are
# listed in `sources`. Defaults to true.
#
# sources (optional)
# List of source files which this crate is allowed to compile. Only
# allowed when `enforce_source_listing = true`.
# The Rust compiler discovers source files by following `mod` declarations
# starting at the `source_root`. The discovered source files must match this
# list.
#
# inputs (optional)
# List of additional non-source files read by the compiler. These are typically
# configuration or test-data files included in the build with the `include_str!`
# macro. Only allowed when `enforce_source_listing = true`.
#
# deps (optional)
# List of rust_library GN targets on which this crate depends.
# Third party crates can be included through paths like
# "//third_party/rust_crates:<cratename>",
#
# test_configs (optional)
# List of GN config targets to pass to the compilation of this crate's
# tests.
#
# test_deps (optional)
# List of rust_library GN targets on which this crate's tests depend.
#
# non_rust_deps (optional)
# List of non-rust_library GN targets on which this crate depends.
# Obsolete. Please use deps instead.
#
# data_deps (optional)
# List of GN targets that are only needed at runtime.
#
# with_unit_tests (optional)
# Builds unit tests associated with the binary. This will create a
# `<name>_lib_test` test file in the output directory. Equivalent
# to adding a `rustc_test` target with that name and the same source_root.
#
# test_environments (optional)
# What environments unit tests, if provided, should target. Only used here
# for linux and mac tests, with a default value of a general linux/mac
# environment (as a function of $current_os).
# See environments parameter on //build/testing/test_spec.gni for more
# details.
#
# source_root (optional)
# Location of the crate root (e.g. `src/main.rs` or `src/lib.rs`).
# This defaults to `./src/main.rs` for binaries and `./src/lib.rs` for libraries,
# and should only be changed when absolutely necessary
# (such as in the case of generated code).
#
# features (optional)
# A list of conditional compilation flags to enable. This can be used to set features for crates
# built in-tree which are also published to crates.io. This would be passed to rustc as
# '--cfg feature="XXX"'
#
# rustenv (optional)
# A list of environment variables that will be set when running the rust
# compiler. These can be accessed at compile time with
# [`std::env!`](https://doc.rust-lang.org/stable/std/macro.env.html)
#
# output_dir (optional)
# Directory that the resulting library should be placed in.
# See: `gn help output_dir`
#
# disable_rbe (optional)
# Set to true to force this target to build locally, overriding the global `rust_rbe_enable`.
# If with_unit_tests is also true, this setting applies to the unit test as well.
# There is currently no way to separately disable RBE for the library and test.
#
# disable_clippy (optional)
# Don't run clippy on this target.
#
# original_target_name (optional)
# The name of the target as it appears in the BUILD file. Enables tooling
# to find the template invocation in a BUILD file where this target was defined.
#
# Example of usage:
#
# rustc_library("foo-bar") {
# deps = [
# "//garnet/public/rust/bar",
# "//third_party/rust_crates:argh",
# "//third_party/rust_crates:serde",
# "//third_party/rust_crates:slab",
# ]
# with_unit_tests = true
# sources = [ "src/lib.rs" ]
# }
#
# Example of using the outputs of the above:
#
# test_package("foo-bar-tests") {
# deps = [
# ":foo-bar_test",
# ]
#
# tests = [
# {
# name = "foo_bar_lib_test"
# }
# ]
#
template("rustc_library") {
not_needed(invoker, [ "version" ])
if (defined(invoker.original_target_name)) {
_original_target_name = invoker.original_target_name
} else {
_original_target_name = target_name
}
# if "with_unit_tests" is set to true, generate an additional rust test target
# TODO(https://fxbug.dev/72931): accept a string.
if (defined(invoker.with_unit_tests) && invoker.with_unit_tests) {
rustc_test_internal("${target_name}_test") {
name = invoker.target_name + "_lib_test"
if (defined(invoker.name)) {
name = invoker.name + "_lib_test"
}
original_target_name = _original_target_name
forward_variables_from(invoker, "*", [ "name" ])
}
}
if (defined(invoker.source_root)) {
source_root = invoker.source_root
} else {
source_root = "src/lib.rs"
}
if (defined(invoker.name)) {
package_name = invoker.name
} else {
package_name = target_name
}
_crate_name = string_replace(package_name, "-", "_")
rustc_artifact(target_name) {
target_type = "rust_library"
crate_root = source_root
clippy_crate_type = "rlib"
crate_name = _crate_name
original_target_name = _original_target_name
pass_through = {
forward_variables_from(invoker,
[
"data_deps",
"output_dir",
])
# TODO: maybe just use target_name instead?
output_name = _crate_name
}
configs = []
configs = invoker.configs
deps = []
if (defined(invoker.deps)) {
deps += invoker.deps
}
# TODO(https://fxbug.dev/43781) remove "non_rust_deps"
if (defined(invoker.non_rust_deps)) {
deps += invoker.non_rust_deps
}
forward_variables_from(invoker,
[
"disable_clippy",
"edition",
"enforce_source_listing",
"features",
"inputs",
"rustenv",
"sources",
"testonly",
"visibility",
"disable_rbe",
])
# Avoid walking into data_deps when checking component manifest expected includes.
metadata = {
expect_includes_barrier = deps
}
}
}