crustal 0.3.6

A library for generating C/C++ code.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# CRustAL: The C/C++ from Rust Assembly Library

This crate provides a library with builder API for assembling C/C++ code
from Rust.


## LICENSE

[MIT license](LICENSE)


## CONTRIBUTING

Code contributions are welcome. The submitter must use the *sign-off* feature
for all commits confirming that the submitter has all rights to contribute
the code under the [license](LICENSE) without any additional terms or conditions.

See the [AUTHORS](AUTHORS) file for a list of contributors.


## CREDIT

This crate is inspired by [codegen-rs`](https://crates.io/crates/codegen-rs)


## Installation

To use `crustal` clone the repository into the `lib` folder of your Rust project,
or use [crates.io](https://crates.io)


## Usage

You can use `crustal` by adding the following lines to `Cargo.toml` file.


```toml
[dependencies]
crustal
```

Next, create a `Scope` and use the builder API to create elements in the scope.
Lastly, call `Scope::to_string()` to get formatted C code as a string.

```rust
use crustal as CG;

let mut scope = CG::Scope::new();
scope.set_filename("include/my_file.hpp");

scope.push_doc_str("WARNING: This is auto-generated comment\n");
scope.new_include("stdio.h", true);

scope.new_class("MyClass")
        .set_base("StateBase", CG::Visibility::Public)
        .push_attribute(CG::Attribute::new(
        "name",
        CG::Type::new(CG::BaseType::new_int(8)),
    ));

println!("{}", scope.to_string());
```

produces the output

```cpp
/// WARNING: This is auto-generated comment
#include <stdio.h>
class MyClass : public StateBase {

    private:
    uint64_t name;
}
```