README.md 2.2 KB
Newer Older
Ryan Hunt's avatar
Ryan Hunt committed
1
2
3
4
5
6
# `cbindgen`   [![Build Status]][travis] [![Latest Version]][crates.io]

[Build Status]: https://api.travis-ci.org/rlhunt/cbindgen.svg?branch=master
[travis]: https://travis-ci.org/rlhunt/cbindgen
[Latest Version]: https://img.shields.io/crates/v/cbindgen.svg
[crates.io]: https://crates.io/crates/cbindgen
Kartikaya Gupta's avatar
Kartikaya Gupta committed
7

Ryan Hunt's avatar
Ryan Hunt committed
8
This project can be used to generate C bindings for Rust code. It is currently being developed to support creating bindings for [WebRender](https://github.com/servo/webrender/), but has been designed to support any project.
Kartikaya Gupta's avatar
Kartikaya Gupta committed
9

10
11
12
13
## Features

  * Builds bindings for a crate, its mods, its dependent crates, and their mods
  * Only the necessary types for exposed functions are given bindings
Ryan Hunt's avatar
Ryan Hunt committed
14
  * Can specify annotations for controlling some aspects of binding
15
  * Generic structs can be exposed using `type IntFoo = Foo<i32>;`
Ryan Hunt's avatar
Ryan Hunt committed
16
  * Customizable formatting, can be used in C or C++ projects
17

Ryan Hunt's avatar
Ryan Hunt committed
18
## Use
Kartikaya Gupta's avatar
Kartikaya Gupta committed
19

20
21
### Command line

Ryan Hunt's avatar
Ryan Hunt committed
22
`cbindgen crate/ -o crate/bindings.h`
Ryan Hunt's avatar
Ryan Hunt committed
23

24
25
26
27
28
29
30
31
32
33
See `cbindgen --help` for more options.

### `build.rs`

`cbindgen` can also be used in build scripts. How this fits into compiling the native code depends on your project.

Here's an example build.rs script:
```rust
extern crate cbindgen;

34
use std::env;
35
36
37
use cbindgen::{Config, Library};

fn main() {
38
39
    let root = env::var("CARGO_MANIFEST_DIR").unwrap();
    let config = Config::from_root_or_default(&root);
40

41
    Library::load(&root, &config)
42
        .generate().unwrap()
Ryan Hunt's avatar
Ryan Hunt committed
43
        .write_to_file("bindings.h");
44
}
Ryan Hunt's avatar
Ryan Hunt committed
45

46
47
```

48
49
## Examples

Ryan Hunt's avatar
Ryan Hunt committed
50
See `compile-tests/` for some examples of rust source that can be handled.
51

Ryan Hunt's avatar
Ryan Hunt committed
52
53
54
55
## How it works

1. All the structs, enums, type aliases, and functions that are representable in C are gathered
2. A dependency graph is built using the extern "C" functions as roots
56
    * This removes unneeded types from the bindings and sorts the structs that depend on each other
Ryan Hunt's avatar
Ryan Hunt committed
57
58
59
60
61
3. Some code generation is done to specialize generics that are specified as type aliases
3. The items are printed in dependency order in C syntax

## Future work

Ryan Hunt's avatar
Ryan Hunt committed
62
63
64
65
1. Add a validation step to catch common issues
2. Better support for types with fully specified names
3. Better support for finding dependencies managed by Cargo
4. Support for generating a FFI interface for a Struct+Impl
Ryan Hunt's avatar
Ryan Hunt committed
66
5. ...