ppx 0.4.0

C-style pre-processor library
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

# PPX

[![Crates.io Version](https://img.shields.io/crates/v/ppx?style=flat-square&label=ppx)](https://crates.io/crates/ppx)
[![Crates.io License](https://img.shields.io/crates/l/ppx?style=flat-square)](https://github.com/jomy10/ppx/blob/master/LICENSE)
[![docs.rs](https://img.shields.io/docsrs/ppx?style=flat-square)](https://docs.rs/ppx/0.1.2/ppx/)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Jomy10/ppx/test.yml?branch=master&style=flat-square&label=tests)

Small C-style macro expansion library.

## Example

```rust
let result = ppx::parse_string(
    "
    #param A
    #define B hello
    #define fn(name) name!
    
    B A fn(John)
    ",
    base_dir,
    ["world"].into_iter()
);
// result = "hello world John!"
```

More examples in the [tests folder](tests/).

## Features

- `#param`: A parameter that can be passed when including the file, or from the
  `parse*` functions.
- `#define`: Define a simple substition, or a function-like macro
- `#include`: Include another file and parse it as well. Optionally accepts
  parameters which will be used for substituting the names specified by `#param`.

**Optional features**:
- Macros `include_ppx!` and `include_ppx_string!`: Parse a template at compile time
  instead of at runtime. Enable macros with feature `macro` or `macro-stable`.
- `vfs` feature: allows using virtual filesystem from the [vfs crate](https://docs.rs/vfs/latest/vfs/)
  as the input.

**planned**
- `#if`

## Versioning

Breaking canges will be introduced in minor versions as long as this crate has not reached 1.0.
Version 1.0 will be reached once `#if` has been implemented.

## Development

### Running tests

```sh
cargo test --workspace
```

Or better, with the [`cargo-all-features`](https://github.com/frewsxcv/cargo-all-features) subcommand:

```sh
cargo +nightly all-features test --workspace
```

## License

MIT or Apache-2.0.