#abi #cbindgen #cglue #ffi

app cglue-bindgen

cleanup cbindgen headers for CGlue

5 releases

0.2.3 Jun 23, 2023
0.2.2 Dec 19, 2021
0.2.1 Nov 26, 2021
0.2.0 Nov 26, 2021
0.1.0 Jun 21, 2021

#540 in Text processing

39 downloads per month

MIT license

81KB
2K SLoC

cglue-bindgen

Cleanup cbindgen output for CGlue.

This crate essentially wraps cbindgen and performs additional header cleanup steps on top for good out-of-the-box usage. Note that the program expects standard naming convention, and will likely break if there is any renaming happening in cbindgen config.

Install

cargo install cglue-bindgen

Also make sure cbindgen is installed:

cargo install cbindgen

Running

Run similarly to cbindgen:

cglue-bindgen +nightly -- --config cbindgen.toml --crate your_crate --output output_header.h

Configuring

Create a cglue.toml, and pass -c cglue.toml to cglue-bindgen before the --.

Several values can be set:

default_container - set the default container type. This will make C/C++ code less verbose for objects that match the container and context types. Supports out-of-the-box: Box, Mut, Ref.

default_context - set the default context type. This will make C/C++ code less verbose for objects that match the container and context types. Supports out-of-the-box: Arc, NoContext.

Using the bindings

Check the documentation for the respective language:

You can also check the code examples.

In case of an issue

Please check if any custom cbindgen options are influencing the way the code is generated in any way. This crate is very finicky, and for instance, even changing the documentation style is likely to break the code generation.

If you still have issues without any custom parameters, please report an issue, because then it is likely my fault or cbindgen update broke the binding generation.

Verified to work cbindgen version: v0.20.0.

Dependencies

~3–5MB
~89K SLoC