| commit | 32791bddfadedf11e568ff485dd7a7885e80973a | [log] [tgz] |
|---|---|---|
| author | Yongheng Chen <yongheng@google.com> | Wed Sep 04 11:15:03 2024 -0700 |
| committer | Copybara-Service <copybara-worker@google.com> | Wed Sep 04 11:15:46 2024 -0700 |
| tree | fe637de2ee4b0b029fbb7d6013f81c669a5c30ec | |
| parent | a860cb5082a9d76eaa98fadbd6f436ff39f9a61d [diff] |
Suffix field names with underscore if their names conflict with other member function names.
In Rust, the following is allowed:
```
struct X {
a: i32
}
impl X {
fn a(self: &Self) -> i32 {
self.a
}
}
```
But C++ doesn't allow the fields and the member functions to have the same names in Class/Struct. When the conflicts happen, we rename the fields assuming that the member functions serve as getters/setters.
PiperOrigin-RevId: 671035288
Change-Id: I72bfaa607971bd64aa8db3a02068dcd5a8257a9c
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