macro-string 0.1.4

macro-string
============

[<img alt="github" src="https://img.shields.io/badge/github-dtolnay/macro--string-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/macro-string)
[<img alt="crates.io" src="https://img.shields.io/crates/v/macro-string.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/macro-string)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-macro--string-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/macro-string)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/dtolnay/macro-string/ci.yml?branch=master&style=for-the-badge" height="20">](https://github.com/dtolnay/macro-string/actions?query=branch%3Amaster)

This crate is a helper library for procedural macros to perform eager evaluation
of standard library string macros like `concat!` and `env!` in macro input.

<table><tr><td>
<b>Supported macros:</b>
<code>concat!</code>,
<code>env!</code>,
<code>include!</code>,
<code>include_str!</code>,
<code>stringify!</code>
</td></tr></table>

For example, to implement a macro such as the following:

```rust
// Parses JSON at compile time and expands to a serde_json::Value.
let j = include_json!(concat!(env!("CARGO_MANIFEST_DIR"), "/manifest.json"));
```

the implementation of `include_json!` will need to parse and eagerly evaluate
the two macro calls within its input tokens.

```rust
use macro_string::MacroString;
use proc_macro::TokenStream;
use proc_macro2::Span;
use std::fs;
use syn::parse_macro_input;

#[proc_macro]
pub fn include_json(input: TokenStream) -> TokenStream {
    let MacroString(path) = parse_macro_input!(input);

    let content = match fs::read(&path) {
        Ok(content) => content,
        Err(err) => {
            return TokenStream::from(syn::Error::new(Span::call_site(), err).to_compile_error());
        }
    };

    let json: serde_json::Value = match serde_json::from_slice(&content) {
        Ok(json) => json,
        Err(err) => {
            return TokenStream::from(syn::Error::new(Span::call_site(), err).to_compile_error());
        }
    };

    /*TODO: print serde_json::Value to TokenStream*/
}
```

<br>

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>