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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
// Copyright 2018 David Roundy <roundyd@physics.oregonstate.edu>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! This crate is custom derive for ClapMe. It should not be used
//! directly.

#![recursion_limit="256"]

extern crate proc_macro;
extern crate syn;
#[macro_use]
extern crate quote;
extern crate proc_macro2;

use syn::*;

fn get_doc_comment(attrs: &[syn::Attribute]) -> String {
    let mut doc_comments: Vec<_> = attrs
        .iter()
        .filter_map(|attr| {
            let path = &attr.path;
            if quote!(#path).to_string() == "doc" {
                attr.interpret_meta()
            } else {
                None
            }
        })
        .filter_map(|attr| {
            use Lit::*;
            use Meta::*;
            if let NameValue(MetaNameValue {ident, lit: Str(s), ..}) = attr {
                if ident != "doc" {
                    return None;
                }
                let value = s.value();
                let text = value
                    .trim_left_matches("//!")
                    .trim_left_matches("///")
                    .trim_left_matches("/*!")
                    .trim_left_matches("/**")
                    .trim_right_matches("*/")
                    .trim();
                if text.is_empty() {
                    Some("\n\n".to_string())
                } else {
                    Some(text.to_string())
                }
            } else {
                None
            }
        })
        .collect();
    if doc_comments.len() > 0 {
        doc_comments.pop().unwrap_or("".to_string())
    } else {
        "".to_string()
    }
}

fn one_field_name(f: syn::Fields) -> proc_macro2::TokenStream {
    let join_prefix = create_join_prefix();
    match f {
        syn::Fields::Named(ref fields) => {
            let f: Vec<_> = fields.named.clone().into_iter().collect();
            let names = f.iter().map(|x| snake_case_to_kebab(&x.ident.clone().unwrap().to_string()));
            let types = f.iter().map(|x| x.ty.clone());
            quote! {
                {
                    let mut flagname: Option<String> = None;
                    let join_prefix = #join_prefix;
                    #(
                        let thisname = join_prefix(&_prefix, #names);
                        let reqs = <#types as ::clapme::ClapMe>::requires_flags(&thisname);
                        if let Some(x) = reqs.first() {
                            flagname = Some(x.clone());
                        }
                    )*
                    flagname.expect("enum must have one required field!")
                }
            }
        },
        syn::Fields::Unit => {
            quote!{
                _name.to_string()
            }
        },
        syn::Fields::Unnamed(ref unnamed) => {
            let f = unnamed.unnamed.iter().next().expect("we should have one field");
            let mytype = f.ty.clone();
            quote!{{
                let reqs = <#mytype as ::clapme::ClapMe>::requires_flags(&_name);
                if let Some(x) = reqs.first() {
                    x.clone()
                } else {
                    panic!("enum {:?} must have one required field!", _name)
                }
            }}
        },
    }
}

fn return_with_fields(f: syn::Fields,
                      name: proc_macro2::TokenStream) -> proc_macro2::TokenStream {
    let join_prefix = create_join_prefix();
    match f {
        syn::Fields::Named(ref fields) => {
            let f: Vec<_> = fields.named.clone().into_iter().collect();
            let names = f.iter().map(|x| snake_case_to_kebab(&x.ident.clone().unwrap().to_string()));
            let types = f.iter().map(|x| x.ty.clone());
            let idents = f.iter().map(|x| x.ident.clone().unwrap());
            quote! {
                let join_prefix = #join_prefix;
                return Some( #name {
                    #( #idents:
                        <#types as ::clapme::ClapMe>::from_clap(&join_prefix(&_prefix, #names),
                                                                _matches)?,  )*
                });
            }
        },
        syn::Fields::Unit => {
            quote!( return Some( #name ); )
        },
        syn::Fields::Unnamed(ref unnamed) if unnamed.unnamed.len() == 1 => {
            let f = unnamed.unnamed.iter().next().expect("we should have one field");
            let mytype = f.ty.clone();
            quote!{
                return Some( #name(<#mytype as ::clapme::ClapMe>::from_clap(&_name, _matches)? ) );
            }
        },
        _ => {
            panic!("ClapMe only supports named fields so far!")
        },
    }
}

fn with_clap_fields(f: syn::Fields, mdoc: Option<String>) -> proc_macro2::TokenStream {
    match f {
        syn::Fields::Named(ref fields) => {
            let f: Vec<_> = fields.named.clone().into_iter().collect();
            let names = f.iter().rev().map(|x| snake_case_to_kebab(&x.ident.clone().unwrap().to_string()));
            let types = f.iter().rev().map(|x| x.ty.clone());
            let names1 = names.clone();
            let types1 = f.iter().rev().map(|x| x.ty.clone());

            let docs: Vec<_> = f.iter().rev().map(|x| get_doc_comment(&x.attrs)).collect();
            let join_prefix = create_join_prefix();
            quote!{
                let join_prefix = #join_prefix;
                let mut flags: Vec<String> = Vec::new();
                if !info.required {
                    // only add dependencies on flags required by this
                    // set of fields, but not absolutely required.
                    #(flags.extend(<#types1 as ::clapme::ClapMe>::requires_flags(&join_prefix(&_prefix, #names1)));)*
                    // println!("   my flags are {:?}", flags);
                }
                let mut new_req: Vec<&str> = flags.iter().map(AsRef::as_ref).collect();
                new_req.extend(info.required_flags);

                #( let argname = join_prefix(&_prefix, #names);
                   let my_req: Vec<&str>
                   = new_req.iter().map(|&s| s).filter(|s| *s != argname).collect();
                   let newinfo = ::clapme::ArgInfo {
                       name: &argname,
                       help: #docs,
                       required_flags: &my_req,
                       required_unless_one: info.required_unless_one.clone(),
                       conflicted_flags: info.conflicted_flags.clone(),
                       ..info
                   };
                   let f = |app: ::clapme::clap::App| {
                       <#types as ::clapme::ClapMe>::with_clap(newinfo, app, f)
                   };
                )*
            }
        },
        syn::Fields::Unit => {
            let doc = mdoc.unwrap_or("".to_string());
            quote!{
                let newinfo = info.clone();
                let f = |app: ::clapme::clap::App| {
                    let conflicts: Vec<_> = newinfo.conflicted_flags.iter().map(AsRef::as_ref).collect();
                    let ruo: Vec<_> = newinfo.required_unless_one.iter().map(AsRef::as_ref).collect();
                    if ruo.len() > 0 {
                        f(app.arg(::clapme::clap::Arg::with_name(&_name).long(&_name)
                                  .requires_all(newinfo.required_flags)
                                  .conflicts_with_all(&conflicts)
                                  .required_unless_one(&ruo)
                                  .help(#doc)))
                    } else {
                        f(app.arg(::clapme::clap::Arg::with_name(&_name).long(&_name)
                                  .requires_all(newinfo.required_flags)
                                  .conflicts_with_all(&conflicts)
                                  .help(#doc)))
                    }
                };
            }
        },
        syn::Fields::Unnamed(ref unnamed) if unnamed.unnamed.len() == 1 => {
            let f = unnamed.unnamed.iter().next().unwrap();
            let mytype = f.ty.clone();
            let doc = mdoc.unwrap_or("".to_string());
            quote!{
                let newinfo = ::clapme::ArgInfo {
                    name: &_name,
                    help: #doc,
                    required_flags: &info.required_flags,
                    required_unless_one: info.required_unless_one.clone(),
                    conflicted_flags: info.conflicted_flags.clone(),
                    ..info
                };
                let f = |app: ::clapme::clap::App| {
                    <#mytype as ::clapme::ClapMe>::with_clap(newinfo, app, f)
                };
            }
        },
        _ => {
            panic!("ClapMe only supports named fields, unit, and singular tuple so far!")
        },
    }
}

fn create_join_prefix() -> proc_macro2::TokenStream {
    quote!{
        |prefix: &str, name: &str| -> String {
            if name.len() == 0 {
                let mut x = prefix.to_string();
                x.pop();
                x
            } else {
                format!("{}{}", prefix, name)
            }
        }
    }
}
fn create_find_prefix() -> proc_macro2::TokenStream {
    quote!{
        |name: &str| -> String {
            match name.chars().next() {
                None | Some('_') | Some('-') => "".to_string(),
                _ => format!("{}-", name),
            }
        }
    }
}

/// Generates the `ClapMe` impl.
#[proc_macro_derive(ClapMe)]
pub fn clapme(raw_input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    use syn::Data::*;
    let input: DeriveInput = syn::parse(raw_input.clone()).unwrap();

    let name = &input.ident;
    let generics = &input.generics;
    let find_prefix = create_find_prefix();
    let join_prefix = create_join_prefix();
    let myimpl = match input.data {
        Struct(DataStruct {
            fields: syn::Fields::Named(ref fields),
            ..
        }) => {
            let f: Vec<_> = fields.named.clone().into_iter().collect();
            let types3 = f.iter().rev().map(|x| x.ty.clone());
            let names3 = f.iter().rev().map(|x| snake_case_to_kebab(&x.ident.clone().unwrap().to_string()));
            let with_clap_stuff = with_clap_fields(syn::Fields::Named(fields.clone()),
                                                   None);
            let return_struct = return_with_fields(syn::Fields::Named(fields.clone()),
                                                   quote!(#name));
            quote!{
                fn with_clap<ClapMeT>(mut info: ::clapme::ArgInfo,
                                app: ::clapme::clap::App,
                                f: impl FnOnce(::clapme::clap::App) -> ClapMeT)
                                -> ClapMeT {
                    info.multiple = false;
                    let _name = info.name;
                    let _prefix = #find_prefix(_name);
                    #with_clap_stuff
                    f(app)
                }
                fn from_clap<'a,'b>(_name: &str, _matches: &::clapme::clap::ArgMatches) -> Option<Self> {
                    let _prefix = #find_prefix(_name);
                    #return_struct
                }
                #[allow(unused_mut)]
                fn requires_flags(_name: &str) -> Vec<String> {
                    let _prefix = #find_prefix(_name);
                    let mut flags: Vec<String> = Vec::new();
                    let join_prefix = #join_prefix;
                    #(flags.extend(<#types3 as ::clapme::ClapMe>::requires_flags(&join_prefix(&_prefix, #names3)));)*;
                    flags
                }
            }
        },
        Struct(DataStruct {
            fields: syn::Fields::Unit,
            ..
        }) => {
            quote!{
                fn with_clap<ClapMeT>(mut _info: ::clapme::ArgInfo,
                                app: ::clapme::clap::App,
                                f: impl FnOnce(::clapme::clap::App) -> ClapMeT)
                                      -> ClapMeT {
                    f(app)
                }
                fn from_clap<'a,'b>(_name: &str, _matches: &::clapme::clap::ArgMatches) -> Option<Self> {
                    Some( #name )
                }
                fn requires_flags(_name: &str) -> Vec<String> {
                    Vec::new()
                }
            }
        },
        Struct(DataStruct {
            fields: syn::Fields::Unnamed(ref unnamed),
            ..
        }) => {
            if unnamed.unnamed.len() != 1 {
                panic!("ClapMe does not handle tuple structs with more than one field");
            }
            let with_clap_stuff = with_clap_fields(syn::Fields::Unnamed(unnamed.clone()),
                                                   None);
            let return_struct = return_with_fields(syn::Fields::Unnamed(unnamed.clone()),
                                                   quote!(#name));
            let f = unnamed.unnamed.iter().next().expect("There should be a field here!");
            let mytype = f.ty.clone();
            quote!{
                fn with_clap<ClapMeT>(mut info: ::clapme::ArgInfo,
                                app: ::clapme::clap::App,
                                f: impl FnOnce(::clapme::clap::App) -> ClapMeT)
                                      -> ClapMeT {
                    let _name = info.name;
                    #with_clap_stuff
                    f(app)
                }
                fn from_clap<'a,'b>(_name: &str, _matches: &::clapme::clap::ArgMatches) -> Option<Self> {
                    #return_struct
                }
                fn requires_flags(_name: &str) -> Vec<String> {
                    <#mytype as ::clapme::ClapMe>::requires_flags(_name)
                }
            }
        },
        Enum(ref e) => {
            let v: Vec<_> = e.variants.iter().collect();
            let vnames: Vec<_> = e.variants.iter().map(|v| camel_case_to_kebab(&v.ident.to_string())).collect();
            let only_one_variant = vnames.len() == 1;
            // If only_one_variant is true, this is a special case,
            // and the code below won't work, because required_unless
            // logic fails when the list of "unless" fields is empty.
            // Really, we should treat this thing as a struct with an
            // additional layer of prefixing going on.
            let vnames2 = vnames.clone();
            let vnames3 = vnames.clone();
            let vnames4 = vnames.clone();
            let vnames5 = vnames.clone();
            let vnames6 = vnames.clone();
            // println!("variant names are {:?}", names);
            let fields: Vec<_> = v.iter().map(|x| x.fields.clone()).collect();
            let with_claps: Vec<_> = v.iter().map(|v| {
                let d = get_doc_comment(&v.attrs);
                with_clap_fields(v.fields.clone(), Some(d))
            }).collect();
            // println!("variant with_claps are {:?}", with_claps);
            let one_field: Vec<_> = fields.iter().map(|f| one_field_name(f.clone())).collect();
            let one_field2 = one_field.clone();
            let one_field3 = one_field.clone();
            let return_enum = v.iter().map(|v| {
                let variant_name = v.ident.clone();
                return_with_fields(v.fields.clone(), quote!(#name::#variant_name))
            });
            let find_prefix = create_find_prefix();
            let s = quote! {
                fn with_clap<ClapMeT>(mut info: ::clapme::ArgInfo,
                                app: ::clapme::clap::App,
                                f: impl FnOnce(::clapme::clap::App) -> ClapMeT)
                                -> ClapMeT {
                    let _name = info.name;
                    let find_prefix = #find_prefix;
                    let _prefix = find_prefix(_name);
                    let orig_prefix = _prefix.clone();
                    let join_prefix = #join_prefix;
                    info.multiple = false;

                    let mut conflicts: Vec<String> = Vec::new();
                    #(
                        let _name = join_prefix(&orig_prefix, #vnames3);
                        let _prefix = find_prefix(&join_prefix(&orig_prefix, #vnames4));
                        conflicts.push(#one_field2);
                    )*

                    let original_conflicted = info.conflicted_flags.clone();
                    let original_required_unless = info.required_unless_one.clone();
                    let am_required = info.required || original_required_unless.len() > 0;
                    info.required = #only_one_variant && am_required;
                    #(
                        let _name = join_prefix(&orig_prefix, #vnames);
                        let _prefix = find_prefix(&join_prefix(&orig_prefix, #vnames2));
                        let myself = #one_field3;
                        info.required_unless_one = original_required_unless.clone();
                        info.conflicted_flags = original_conflicted.clone();
                        conflicts.iter().filter(|s| **s != myself).map(|s| {
                            info.conflicted_flags.push(s.clone());
                            if am_required {
                                info.required_unless_one.push(s.clone());
                            }
                        }).count();
                        // println!("required_unless_one is {:?} for {:?} with {:?} and conflicted {:?}",
                        //          info.required_unless_one, _name, info.required, info.conflicted_flags);

                        #with_claps
                    )*
                    f(app)
                }
                fn from_clap<'a,'b>(_name: &str, _matches: &::clapme::clap::ArgMatches) -> Option<Self> {
                    let find_prefix = #find_prefix;
                    let _prefix = find_prefix(_name);
                    let orig_prefix = _prefix;
                    let _join_prefix = #join_prefix;
                    #(
                        let _name = _join_prefix(&orig_prefix, #vnames5);
                        let _prefix = find_prefix(&_join_prefix(&orig_prefix, #vnames6));
                        // println!("this is good: {:?} and {:?}", &name, &_prefix);
                        if _matches.is_present(#one_field) {
                            #return_enum
                        }
                    )*
                    panic!("Some version of the enum should be present!")
                }
                fn requires_flags(_name: &str) -> Vec<String> {
                    // This is a little hokey, but we just list an
                    // enum as having no required flags.  That is an
                    // understatement, but I don't know how to use
                    // clap to specify a set of flags as a
                    // requirement.  One would hope an ArgGroup would
                    // achieve this, but I don't think it does.
                    Vec::new()
                }
            };
            s
        },
        _ => panic!("ClapMe only supports non-tuple structs"),
    };

    let generic_types = input.generics.type_params();
    let bounds = quote!{
        <#(#generic_types: ::clapme::ClapMe),*>
    };

    let tokens2: proc_macro2::TokenStream = quote!{
        impl#bounds ::clapme::ClapMe for #name#generics {
            #myimpl
        }
    };
    // println!("\n\n{}", tokens2);
    tokens2.into()
}

fn camel_case_to_kebab(name: &str) -> String {
    if name.chars().next() == Some('_') {
        "".to_string()
    } else if name.contains('_') {
        let mut out = name.to_string().replace("_", "-");
        if out.chars().last() == Some('-') {
            out.pop();
        }
        out
    } else {
        let mut out = String::new();
        let mut am_on_cap = true;
        for c in name.chars() {
            if !am_on_cap && c.is_ascii_uppercase() {
                out.push('-');
            }
            am_on_cap = c.is_ascii_uppercase();
            out.push(c.to_ascii_lowercase());
        }
        out
    }
}

fn snake_case_to_kebab(name: &str) -> String {
    if name.chars().next() == Some('_') {
        "".to_string()
    } else {
        name.to_string().replace("_", "-")
    }
}