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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
//! [<img alt="github" src="https://img.shields.io/badge/github-udoprog/musli-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/musli)
//! [<img alt="crates.io" src="https://img.shields.io/crates/v/musli-macros.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/musli-macros)
//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-musli--macros-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/musli-macros)
//!
//! This crate provides the macros used in [Müsli].
//!
//! Please refer to <https://docs.rs/musli> for documentation.
//!
//! [Müsli]: <https://docs.rs/musli>

#![allow(clippy::too_many_arguments)]
#![allow(clippy::needless_late_init)]

use proc_macro::TokenStream;

mod de;
mod en;
mod expander;
mod internals;
#[cfg(feature = "sneaky-fields")]
mod sneaky_fields;
#[cfg(feature = "test")]
mod test;
mod types;
mod visit;
mod zero_copy;

/// Please refer to the main [musli documentation](https://docs.rs/musli).
#[proc_macro_derive(Encode, attributes(musli))]
pub fn derive_encode(input: TokenStream) -> TokenStream {
    let input = syn::parse_macro_input!(input as syn::DeriveInput);
    let expander = expander::Expander::new(&input);

    let dump = std::env::var("MUSLI_DUMP_ENCODE").ok();

    match expander.expand_encode() {
        Ok(tokens) => {
            if let Some((dump, out)) = dump.as_ref().and_then(|d| d.split_once('=')) {
                if input.ident.to_string().contains(dump) {
                    let _ = std::fs::write(out, format!("{}", tokens));
                }
            }

            tokens.into()
        }
        Err(()) => to_compile_errors(expander.into_errors()).into(),
    }
}

#[proc_macro_derive(Decode, attributes(musli))]
pub fn derive_decode(input: TokenStream) -> TokenStream {
    let input = syn::parse_macro_input!(input as syn::DeriveInput);
    let expander = expander::Expander::new(&input);

    let dump = std::env::var("MUSLI_DUMP_DECODE").ok();

    match expander.expand_decode() {
        Ok(tokens) => {
            if let Some((dump, out)) = dump.as_ref().and_then(|d| d.split_once('=')) {
                if input.ident.to_string().contains(dump) {
                    let _ = std::fs::write(out, format!("{}", tokens));
                }
            }

            tokens.into()
        }
        Err(()) => to_compile_errors(expander.into_errors()).into(),
    }
}

#[proc_macro_attribute]
pub fn decoder(attr: TokenStream, input: TokenStream) -> TokenStream {
    let attr = proc_macro2::TokenStream::from(attr);

    if !attr.is_empty() {
        return syn::Error::new_spanned(attr, "Arguments not supported")
            .to_compile_error()
            .into();
    }

    let input = syn::parse_macro_input!(input as types::Types);

    match input.expand(
        "decoder",
        &types::DECODER_TYPES,
        ["Error"],
        "__UseMusliDecoderAttributeMacro",
    ) {
        Ok(tokens) => tokens.into(),
        Err(err) => err.to_compile_error().into(),
    }
}

#[proc_macro_attribute]
pub fn encoder(attr: TokenStream, input: TokenStream) -> TokenStream {
    let attr = proc_macro2::TokenStream::from(attr);

    if !attr.is_empty() {
        return syn::Error::new_spanned(attr, "Arguments not supported")
            .to_compile_error()
            .into();
    }

    let input = syn::parse_macro_input!(input as types::Types);

    match input.expand(
        "encoder",
        &types::ENCODER_TYPES,
        ["Ok", "Error"],
        "__UseMusliEncoderAttributeMacro",
    ) {
        Ok(tokens) => tokens.into(),
        Err(err) => err.to_compile_error().into(),
    }
}

#[proc_macro_attribute]
pub fn visitor(attr: TokenStream, input: TokenStream) -> TokenStream {
    let attr = proc_macro2::TokenStream::from(attr);

    if !attr.is_empty() {
        return syn::Error::new_spanned(attr, "Arguments not supported")
            .to_compile_error()
            .into();
    }

    let input = syn::parse_macro_input!(input as types::Types);

    match input.expand(
        "visitor",
        &types::VISITOR_TYPES,
        ["Ok"],
        "__UseMusliVisitorAttributeMacro",
    ) {
        Ok(tokens) => tokens.into(),
        Err(err) => err.to_compile_error().into(),
    }
}

#[proc_macro_derive(ZeroCopy, attributes(zero_copy))]
pub fn zero_copy(input: TokenStream) -> TokenStream {
    let input = syn::parse_macro_input!(input as syn::DeriveInput);
    let expander = zero_copy::Expander::new(input);

    match expander.expand() {
        Ok(stream) => stream.into(),
        Err(errors) => to_compile_errors(errors).into(),
    }
}

#[proc_macro_derive(Visit, attributes(visit))]
pub fn visit(input: TokenStream) -> TokenStream {
    let input = syn::parse_macro_input!(input as syn::DeriveInput);
    let expander = visit::Expander::new(&input);

    match expander.expand() {
        Ok(stream) => stream.into(),
        Err(errors) => to_compile_errors(errors).into(),
    }
}

// NB: Only used in UI tests.
#[proc_macro_attribute]
#[doc(hidden)]
#[cfg(feature = "sneaky-fields")]
pub fn sneaky_fields(attr: TokenStream, item: TokenStream) -> TokenStream {
    sneaky_fields::expand(attr, item)
}

fn to_compile_errors(errors: Vec<syn::Error>) -> proc_macro2::TokenStream {
    let mut output = proc_macro2::TokenStream::new();

    for e in errors {
        output.extend(e.to_compile_error());
    }

    output
}

#[cfg(feature = "test")]
#[proc_macro_derive(Generate, attributes(generate))]
pub fn derive_generate(input: TokenStream) -> TokenStream {
    let input = syn::parse_macro_input!(input as syn::DeriveInput);

    let mut cx = test::Ctxt::default();

    if let Ok(stream) = test::expand(&mut cx, &input) {
        return stream.into();
    }

    let mut stream = proc_macro2::TokenStream::default();

    for error in cx.errors {
        stream.extend(error.to_compile_error());
    }

    stream.into()
}