| commit | 094c44afc1c1ccd8e720be8abf1aa420d5af9146 | [log] [tgz] |
|---|---|---|
| author | Michael VanBemmel <mvanbem@google.com> | Wed Jul 17 16:39:26 2024 -0700 |
| committer | Copybara-Service <copybara-worker@google.com> | Wed Jul 17 16:40:30 2024 -0700 |
| tree | 6c17e3d1dd265993d84ff79310e4d42a683e2e3a | |
| parent | d0bc610b4f9e9e5392cc186894f379cfc35fe671 [diff] |
Record error format strings on the C++ side of `rs_bindings_from_cc` This change introduces a set of method overloads that accept `FormattedError`s instead of plain `std::string`s. Work intentionally left for future changes: - Migrate all uses of the string overloads and then remove them. - Expose the new information in the IR JSON representation. PiperOrigin-RevId: 653400870 Change-Id: Ib97a8cb60c54bf465a658d6ee9b9474404917e22
NOTE: Crubit currently expects deep integration with the build system, and is difficult to deploy to environments dissimilar to Google's monorepo. We do not have our tooling set up to accept external contributions at this time.
Crubit is a bidirectional bindings generator for C++ and Rust, with the goal of integrating the C++ and Rust ecosystems.
Support for calling FFI-friendly C++ from Rust is in progress.
Support for calling Rust from C++ will arrive in 2024H2.
Consider the following C++ function:
extern "C" bool IsGreater(int lhs, int rhs);
This function, if present in a header file which is processed by Crubit, becomes callable from Rust as if it were defined as:
pub fn IsGreater(lhs: ffi::c_int, rhs: ffi::c_int) -> bool {...}
Note: There are some temporary restrictions on the API shape. For example, functions that are not extern "C", or that accept a type like std::string, can't be called from Rust directly via Crubit. These restrictions will be relaxed over time.
Here are some resources for getting started with Crubit:
Rust Bindings for C++ Libraries is a detailed walkthrough on how to use C++ from Rust using Crubit.
The examples/cpp/ directory has copy-pastable examples of calling C++ from Rust, together with snapshots of what the generated Rust interface looks like.
$ apt install clang lld bazel $ git clone git@github.com:google/crubit.git $ cd crubit $ bazel build --linkopt=-fuse-ld=/usr/bin/ld.lld //rs_bindings_from_cc:rs_bindings_from_cc_impl
$ git clone https://github.com/llvm/llvm-project $ cd llvm-project $ CC=clang CXX=clang++ cmake -S llvm -B build -DLLVM_ENABLE_PROJECTS='clang' -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install $ cmake --build build -j $ # wait... $ cmake --install build $ cd ../crubit $ LLVM_INSTALL_PATH=../llvm-project/install bazel build //rs_bindings_from_cc:rs_bindings_from_cc_impl