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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// Copyright (c) 2020 Steve Jones
// SPDX-License-Identifier: MIT

use proc_macro::TokenStream;
use quote::quote;
use std::cell::RefCell;
use std::collections::HashMap;
use std::str::FromStr;
use syn::{
    braced,
    parse::{Parse, ParseStream, Result},
    parse_macro_input, Data, DataStruct, DeriveInput, Field, Fields, Ident, Token,
};

thread_local! {
    static TEMPLATES: RefCell<HashMap<String, String>> = RefCell::new(HashMap::new());
}

struct TemplateValidation {
    pub name: String,
}

impl Parse for TemplateValidation {
    fn parse(input: ParseStream) -> Result<Self> {
        parse_template(input, |name, _| TemplateValidation { name })
    }
}

struct TemplateInput {
    pub name: String,
    pub example: DeriveInput,
}

impl Parse for TemplateInput {
    fn parse(input: ParseStream) -> Result<Self> {
        parse_template(input, |name, example| TemplateInput { name, example })
    }
}

struct TemplateName {
    pub name: String,
}

impl Parse for TemplateName {
    fn parse(input: ParseStream) -> Result<Self> {
        let name = Ident::parse(input)?.to_string();
        Ok(TemplateName { name })
    }
}

fn parse_template<T>(input: ParseStream, builder: fn(String, DeriveInput) -> T) -> Result<T> {
    let name = Ident::parse(input)?.to_string();
    let _eq_token: Option<Token![=]> = input.parse()?;
    let content;
    let _brace_token = braced!(content in input);
    let input = DeriveInput::parse(&content)?;
    Ok(builder(name, input))
}

fn match_name(pattern: &str, name: &str) -> bool {
    let (name_prefix, name_suffix) = if pattern.contains("__") {
        let mut splitter = pattern.splitn(2, "__");
        let prefix = splitter.next().unwrap();
        let suffix = splitter.next().unwrap();
        (prefix, suffix)
    } else {
        (pattern, pattern)
    };

    name.starts_with(name_prefix) && name.ends_with(name_suffix)
}

/// Declare a named macro template
///
/// # Examples
///
/// ```
/// use macro_macro::{macro_macro, macro_template};
///
/// macro_template!(NAME = {
///     #[derive(Clone)] // Macros to add to strut when name matches
///     struct __ {
///         /*#[...]*/ __ : !, // Macros to add to field when name and type matches
///
///         /*#[...]*/ __ : !, // Macros to add to field when name and type matches
///     }
/// });
///
/// fn main() {
///   // ...
/// }
/// ```
///
/// # Panics
/// If the template input is not valid.
///
#[proc_macro]
pub fn macro_template(input: TokenStream) -> TokenStream {
    let input_str = input.to_string();
    let template = parse_macro_input!(input as TemplateValidation);

    TEMPLATES.with(|templates| -> () {
        let template_name = template.name.to_string();
        let mut templates_ref = templates.borrow_mut();
        templates_ref.insert(template_name, input_str);
    });

    TokenStream::new()
}

fn lookup_template(name: &str) -> String {
    TEMPLATES.with(|templates| {
        let templates_ref = templates.borrow();
        templates_ref
            .get(name)
            .expect("invalid template name")
            .clone()
    })
}

fn input_fields(input: &DeriveInput) -> Vec<Field> {
    match &input.data {
        Data::Struct(DataStruct {
            fields: Fields::Named(fields),
            ..
        }) => {
            let field_vec: Vec<Field> = fields.named.iter().map(|f| f.clone()).collect();
            field_vec
        }
        _ => panic!("expected a struct with named fields"),
    }
}

fn template_fields(template_input: &TemplateInput) -> Vec<&Field> {
    match &template_input.example.data {
        Data::Struct(DataStruct {
            fields: Fields::Named(fields),
            ..
        }) => {
            let field_vec: Vec<&Field> = fields.named.iter().collect();
            field_vec
        }
        _ => Vec::new(),
    }
}

fn update_fields(fields: &mut Vec<Field>, template_fields: &Vec<&Field>) {
    for field in fields {
        let field_name = field.ident.as_ref().map(|id| id.to_string()).unwrap();
        for template_field in template_fields {
            let template_field_name = template_field
                .ident
                .as_ref()
                .map(|id| id.to_string())
                .unwrap();
            let field_name_match = match_name(&template_field_name, &field_name);

            let field_type = &field.ty;
            let template_field_type = &template_field.ty;
            let type_desc = quote! {#field_type}.to_string();
            let template_type_desc = quote! {#template_field_type}.to_string().replace("!", "__");
            let field_type_match = match_name(&template_type_desc, &type_desc);

            if field_name_match && field_type_match {
                field
                    .attrs
                    .extend(template_field.attrs.iter().map(|f| f.clone()));
            }
        }
    }
}

/// Apply macros from a template
///
/// The `NAME` must be declared via `macro_template`.
///
/// # Examples
///
/// ```
/// use macro_macro::{macro_macro, macro_template};
///
/// macro_template!(NAME = {
///     struct __ { }
/// });
///
/// #[macro_macro(NAME)]
/// struct Structure {
///     // ...
/// }
///
/// fn main() {
///   // ...
/// }
/// ```
#[proc_macro_attribute]
pub fn macro_macro(args: TokenStream, input: TokenStream) -> TokenStream {
    let template_name = parse_macro_input!(args as TemplateName).name.to_string();
    let input = parse_macro_input!(input as DeriveInput);

    let template_str = lookup_template(&template_name);
    let template_ts = TokenStream::from_str(&template_str).expect("template");
    let template_input = parse_macro_input!(template_ts as TemplateInput);
    let template_struct_name = template_input.example.ident.to_string();

    let struct_name = input.ident.to_string();
    let structure_match = match_name(&template_struct_name, &struct_name);

    let mut fields = input_fields(&input);
    if structure_match {
        let template_fields: Vec<&Field> = template_fields(&template_input);
        update_fields(&mut fields, &template_fields);
    }

    let template_attrs = if structure_match {
        template_input.example.attrs
    } else {
        Vec::new()
    };

    // Output with any additional templated attributes and updated field attributes
    let attrs = input.attrs;
    let generics = input.generics;
    let name = input.ident;
    let vis = input.vis;
    (quote! {
        #(
          #template_attrs
        )*
        #(
          #attrs
        )*
        #vis struct #name #generics {
            #(
                #fields,
            )*
        }
    })
    .into()
}