C++ Rules for Bazel
Go to file
Googler e1c7ebb858 Add support for select'ing on cc_args(args=...).
This CL is an alternative to unknown commit. I left the other CL seperately, because I wasn't 100% sure that we'd agree to this, since this is an API change.
I did it this way because I believe it's much less hacky, and it also allows us to format things that aren't variables.

BEGIN_PUBLIC
Add support for select'ing on cc_args(args=...).

This is quite tricky because the one parameter was being split into two in a macro, one of type label and the other of type string.

For example, `args = ["--foo", format_arg("--bar=%s", "//path/to:bar")]` was rewritten by the macro to `args = [json.encode(struct(format_type="raw", format="foo")), json.encode(struct(format_type="format_arg", format="--bar=%s", value=0))], variables = ["//path/to:bar"]`.
To allow it to work with selects, we need to ensure that we don't perform post-processing on the inside of the select. To solve this, we:
* Ensure that args only take strings
* Provide a seperate parameter for substitutions.

This new mechanism also has the useful property that we can now format things that are not variables. For example, I can do the following:

```
directory(name = "sysroot", ...)
cc_args(
    name = "sysroot_arg",
    args = ["--sysroot={sysroot}"],
    format = {
        ":sysroot": "sysroot"
    }
)
```

END_PUBLIC

PiperOrigin-RevId: 656211278
Change-Id: If83f1ea5a99090c18f2a561c51ec6d39ce9fe419
2024-07-25 20:13:42 -07:00
.bazelci Enable `//tests/...` in CI 2023-07-08 00:29:45 +02:00
.bcr The targets in the old package were either not publicly visible or testonly dependencies and had diverged heavily from @bazel_tools. 2023-01-10 02:00:52 -08:00
cc Add support for select'ing on cc_args(args=...). 2024-07-25 20:13:42 -07:00
examples Automatic code cleanup. 2023-09-18 03:04:35 -07:00
tests Add support for select'ing on cc_args(args=...). 2024-07-25 20:13:42 -07:00
third_party Add support for expand_if_available for env_entry 2023-07-17 08:12:34 -07:00
tools/migration Cleanup uses of ctoolchain migration 2024-02-12 03:16:53 -08:00
.gitignore Add things needed for rules_cc to build & test in the open 2019-01-09 08:59:09 +01:00
AUTHORS Create AUTHORS 2021-03-25 11:49:43 -04:00
BUILD Introduce flag --@rules_cc//:link_extra_libs 2023-02-16 04:15:10 -08:00
CODEOWNERS Merge pull request #146 from bazelbuild:meteorcloudy-patch-1 2022-09-19 13:51:00 +00:00
CONTRIBUTING.md Add initial content of rules_cc repo 2019-01-09 08:58:14 +01:00
ISSUE_TEMPLATE.md Fix issue template 2019-02-27 01:37:03 -08:00
LICENSE Internal change 2019-01-09 08:56:00 +01:00
MODULE.bazel Make toolchains use directory markers instead of strings. 2024-06-03 16:20:34 -07:00
README.md Update README.md 2023-07-19 15:32:02 -07:00
WORKSPACE BEGIN_PUBLIC 2024-02-20 15:54:10 -08:00
renovate.json Update renovate.json 2019-11-03 11:40:55 +01:00

README.md

C++ rules for Bazel

  • Postsubmit Build status
  • Postsubmit + Current Bazel Incompatible flags Build status

This repository contains a Starlark implementation of C++ rules in Bazel.

The rules are being incrementally converted from their native implementations in the Bazel source tree.

For the list of C++ rules, see the Bazel documentation.

Getting Started

There is no need to use rules from this repository just yet. If you want to use rules_cc anyway, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_cc",
    urls = ["https://github.com/bazelbuild/rules_cc/archive/refs/tags/<VERSION>.tar.gz"],
    sha256 = "...",
)

Then, in your BUILD files, import and use the rules:

load("@rules_cc//cc:defs.bzl", "cc_library")

cc_library(
    ...
)

Using the rules_cc toolchain

This repo contains an auto-detecting toolchain that expects to find tools installed on your host machine. This is non-hermetic, and may have varying behaviors depending on the versions of tools found.

There are third-party contributed hermetic toolchains you may want to investigate:

If you'd like to use the cc toolchain defined in this repo, add this to your WORKSPACE after you include rules_cc:

load("@rules_cc//cc:repositories.bzl", "rules_cc_dependencies", "rules_cc_toolchains")

rules_cc_dependencies()

rules_cc_toolchains()

Migration Tools

This repository also contains migration tools that can be used to migrate your project for Bazel incompatible changes.

Legacy fields migrator

Script that migrates legacy crosstool fields into features (incompatible flag, tracking issue).

TLDR:

bazel run @rules_cc//tools/migration:legacy_fields_migrator -- \
  --input=my_toolchain/CROSSTOOL \
  --inline

Contributing

Bazel and rules_cc are the work of many contributors. We appreciate your help!

To contribute, please read the contribution guidelines: CONTRIBUTING.md.

Note that the rules_cc use the GitHub issue tracker for bug reports and feature requests only. For asking questions see: