build_compile 0.2.0

Helper crate for build scripts which compile to Rust
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

# BuildCompile

This is a small crate which allows you to hook compilers which compile to Rust
into your Cargo build scripts.

Suppose you have written some kind of DSL which compiles to rust code. Now you
want to provide users of your library a nice way to set up a Cargo build
script. With BuildCompile this is as simple as:

``` rust
extern crate build_compile as build;

use std::io::Write;
use std::path::Path;

struct Processor;

impl build::Processor for Processor {
    fn process<O: Write>(&self, input: build::FileText, output: &mut O) -> Result<(), build::Error> {
        try!(write!(output, "hello"));
        Err(build::Error(input, "it's not even implemented yet", build::Span(1, 3)));
    }
}

pub fn process_root() {
    build::process_root("someextension", &Processor)
}

pub fn process_dir<P: AsRef<Path>>(path: P) {
    build::process_dir(path, "someextension", &Processor)
}
```

Inside the `process` function you can do whatever you want. BuildCompile
handles all the directory traversing for you. It also generates nice looking
error message with highlighted errors for you.

Now users of your library can use your processor in their own crates with ease:

``` rust
extern crate some_crate;

fn main() {
    some_crate::process_root();
}
```

BuildCompile is extracted from
[LALRPOP](https://github.com/nikomatsakis/lalrpop) by Niko Matsakis.