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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
#![allow(clippy::uninlined_format_args)]

use proc_macro2::TokenStream;
use quote::{
    quote,
    quote_spanned,
};
use syn::{
    parse_macro_input,
    spanned::Spanned,
    Data,
    DeriveInput,
    Error,
    Fields,
    LitStr,
    Result,
};

#[proc_macro_derive(FromOptions, attributes(pikadick_slash_framework))]
pub fn derive_from_options(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let name = input.ident;
    match extract_fields(&input.data) {
        Ok(fields) => {
            let from_options_impl =
                gen_from_options_impl(&fields).unwrap_or_else(Error::into_compile_error);
            let get_argument_params_impl =
                gen_get_argument_params_impl(&fields).unwrap_or_else(Error::into_compile_error);

            let expanded = quote! {
                impl ::pikadick_slash_framework::FromOptions for #name {
                    fn from_options(
                        interaction: &::serenity::model::application::CommandInteraction
                    ) -> ::std::result::Result<Self, ::pikadick_slash_framework::ConvertError> {
                        #from_options_impl
                    }

                    fn get_argument_params() -> ::std::result::Result<::std::vec::Vec<::pikadick_slash_framework::ArgumentParam>, ::pikadick_slash_framework::BuilderError> {
                        #get_argument_params_impl
                    }
                }
            };

            proc_macro::TokenStream::from(expanded)
        }
        Err(e) => Error::into_compile_error(e).into(),
    }
}

/// Extract Field s from a derive object
fn extract_fields(data: &syn::Data) -> Result<Vec<Field>> {
    let fields = match data {
        Data::Struct(data) => &data.fields,
        Data::Enum(data) => {
            return Err(Error::new(
                data.enum_token.span(),
                "enums are not supported",
            ))
        }
        Data::Union(data) => {
            return Err(Error::new(
                data.union_token.span(),
                "unions are not supported",
            ))
        }
    };

    // Only use named fields
    let fields = match fields {
        Fields::Named(fields) => fields,
        Fields::Unnamed(fields) => {
            return Err(Error::new(
                fields.span(),
                "unnamed fields are not supported",
            ))
        }
        Fields::Unit => return Err(Error::new(fields.span(), "unit structs are not supported")),
    };

    fields
        .named
        .iter()
        .map(|field| {
            let ident = field
                .ident
                .as_ref()
                .expect("named struct fields should have names for all fields");

            let mut maybe_rename = None;
            let mut maybe_description = None;

            for attr in field
                .attrs
                .iter()
                .filter(|field| matches!(field.style, syn::AttrStyle::Outer))
            {
                if attr.path().is_ident("doc") {
                    // doc comments show up here.
                    // TODO: Consider doing something with them
                    continue;
                }

                if attr.path().is_ident("pikadick_slash_framework") {
                    attr.parse_nested_meta(|meta| {
                        if meta.path.is_ident("rename") {
                            let value = meta.value()?;
                            let value: syn::LitStr = value.parse()?;

                            if maybe_rename.is_some() {
                                return Err(Error::new(attr.span(), "duplicate rename attribute"));
                            }

                            // TODO: Consider validating name
                            maybe_rename = Some((value.value(), value.span()));

                            return Ok(());
                        }

                        if meta.path.is_ident("description") {
                            let value = meta.value()?;
                            let value: syn::LitStr = value.parse()?;

                            if maybe_description.is_some() {
                                return Err(Error::new(
                                    attr.span(),
                                    "duplicate description attribute",
                                ));
                            }

                            // TODO: Consider validating description
                            maybe_description = Some((value.value(), value.span()));

                            return Ok(());
                        }

                        Err(Error::new(ident.span(), "unexpected ident"))
                    })?;
                }
            }

            Ok(Field {
                ident,
                span: field.span(),
                ty: &field.ty,

                rename: maybe_rename,
                description: maybe_description,
            })
        })
        .collect::<Result<Vec<Field>>>()
}

fn gen_from_options_impl(fields: &[Field]) -> Result<TokenStream> {
    let optional_field_recurse = fields.iter().map(|field| {
        let name = &field.ident;
        quote_spanned! {field.span=>
            let mut #name = ::std::option::Option::None;
        }
    });

    let match_recurse = fields.iter().map(|field| {
        let name = &field.ident;
        let name_lit = field.get_name_literal();
        let ty = &field.ty;
        quote_spanned! {field.span=>
            #name_lit => {
                #name = Some(
                    <#ty as ::pikadick_slash_framework::FromOptionValue>::from_option_value(
                        #name_lit,
                        &option.value
                    )?
                );
            }
        }
    });

    let unwrap_field_recurse = fields.iter().map(|field| {
        let name = &field.ident;
        let name_lit = field.get_name_literal();
        let ty = &field.ty;
        quote_spanned! {field.span=>
            let #name = #name
                .or_else(<#ty as ::pikadick_slash_framework::FromOptionValue>::get_missing_default)
                .ok_or(::pikadick_slash_framework::ConvertError::MissingRequiredField {
                    name: #name_lit,
                    expected: <#ty as ::pikadick_slash_framework::FromOptionValue>::get_expected_data_type()
                })?;
        }
    });

    let recurse = fields.iter().map(|field| {
        let name = &field.ident;
        quote_spanned! {field.span=>
            #name,
        }
    });

    Ok(quote! {
        #(#optional_field_recurse)*

        for option in interaction.data.options.iter() {
            match option.name.as_str() {
                #(#match_recurse)*
                _ => {}
            }
        }

        #(#unwrap_field_recurse)*

        Ok(Self { #(#recurse)* })
    })
}

fn gen_get_argument_params_impl(fields: &[Field]) -> Result<TokenStream> {
    let fields_len = fields.len();

    let args = fields.iter().map(|field| {
        let name_lit = field.get_name_literal();
        let description = field.get_description();
        let ty = &field.ty;
        quote_spanned! {field.span=>
            ret.push(
                ::pikadick_slash_framework::ArgumentParamBuilder::new()
                    .name(#name_lit)
                    .description(#description)
                    .kind(<#ty as ::pikadick_slash_framework::FromOptionValue>::get_expected_data_type())
                    .build()?
            );
        }
    });

    Ok(quote! {
        let mut ret = ::std::vec::Vec::with_capacity(#fields_len);
        #(#args)*
        Ok(ret)
    })
}

struct Field<'a> {
    ident: &'a proc_macro2::Ident,
    span: proc_macro2::Span,
    ty: &'a syn::Type,

    /// The renamed name of this field
    rename: Option<(String, proc_macro2::Span)>,

    /// The field description.
    ///
    /// This is different from documentation.
    description: Option<(String, proc_macro2::Span)>,
}

impl Field<'_> {
    /// Get the string literal name of this field.
    ///
    /// This will take into account field renames
    fn get_name_literal(&self) -> LitStr {
        match &self.rename {
            Some((name, span)) => LitStr::new(name, *span),
            None => LitStr::new(&self.ident.to_string(), self.ident.span()),
        }
    }

    /// Get the description of this field.
    ///
    /// This will autogenerate a description if one is missing.
    fn get_description(&self) -> LitStr {
        match &self.description {
            Some((description, span)) => LitStr::new(description, *span),
            None => LitStr::new(
                &format!(
                    "The `{}` parameter",
                    self.rename
                        .as_ref()
                        .map(|t| t.0.to_string())
                        .unwrap_or_else(|| self.ident.to_string())
                ),
                self.ident.span(),
            ),
        }
    }
}