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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
#![doc = include_str!("../README.md")]
#![warn(missing_docs)]
#![allow(clippy::let_and_return)]

use std::{collections::HashSet, env};

use proc_macro::TokenStream;
use proc_macro2::{Span, TokenTree};
use quote::quote;
use syn::{
    parse::{Parse, ParseStream},
    parse_macro_input,
    punctuated::Punctuated,
    AttrStyle, Attribute, Data, DeriveInput, Expr, Fields, Ident, Meta, MetaList, Token, Type,
};

/// Parsed input to the `cvars!` macro.
struct CvarsDef {
    attrs: Vec<Attribute>,
    cvars: Vec<CvarDef>,
}

impl Parse for CvarsDef {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let attrs = input.call(Attribute::parse_inner)?;

        let punctuated = Punctuated::<CvarDef, Token![,]>::parse_terminated(input)?;
        let cvars = punctuated.into_iter().collect();

        Ok(CvarsDef { attrs, cvars })
    }
}

/// Definition of one cvar from the `cvars!` macro.
struct CvarDef {
    attrs: Vec<Attribute>,
    /// Whether `#[cvars(skip)]` was present.
    /// It has to be removed from the list of attributes before passing them on
    /// so we save it here separately.
    skip: bool,
    name: Ident,
    ty: Type,
    value: Expr,
}

impl Parse for CvarDef {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let attrs_raw = input.call(Attribute::parse_outer)?;
        let mut attrs = Vec::new();
        let mut skip = false;
        for attr in attrs_raw {
            if is_skip(&attr) {
                skip = true;
            } else {
                attrs.push(attr);
            }
        }
        let name = input.parse()?;
        let _: Token![:] = input.parse()?;
        let ty = input.parse()?;
        let _: Token![=] = input.parse()?;
        let value = input.parse()?;
        Ok(CvarDef {
            attrs,
            skip,
            name,
            ty,
            value,
        })
    }
}

/// Generate the `Cvars` struct and its impls. Each cvar and its default value is defined on one line.
///
/// All types used as cvars have to impl `FromStr` and `Display`.
///
/// # Generated code
///
/// The macro generates:
/// - the struct definition
/// - `impl Default for Cvars` which sets the initial values
/// - `impl Cvars` with methods for interacting with cvars
///
/// The generated methods:
/// - `get_string` - take cvar name as string and return its value as a `String`
/// - `set_str` - take cvar name as string and its new value as a `&str`
/// - `get` - take cvar name as string and return its value as the correct type
/// - `set` - take cvar name as string and its new value as the correct type
///
/// See your IDE or [the SetGet trait](https://docs.rs/cvars/latest/cvars/trait.SetGet.html)
/// for their exact signatures.
///
/// # Example
///
/// ```rust
/// use cvars::cvars;
///
/// cvars! {
///     g_rocket_launcher_ammo_max: i32 = 20,
///     g_rocket_launcher_damage: f32 = 75.0,
/// }
/// ```
///
/// # Attributes and doc-comments
///
/// To add attributes or doc-comments to the generated struct,
/// use _inner_ attributes and _inner_ comments.
///
/// ```rust
/// use cvars::cvars;
///
/// cvars! {
///     //! Documentation for the generated struct
///
///     #![derive(Debug, Clone)]
///
///     /// Documentation for the cvar
///     cl_projectile_render_distance: f64 = 2048.0,
/// }
/// ```
#[proc_macro]
pub fn cvars(input: TokenStream) -> TokenStream {
    let begin = std::time::Instant::now();

    let cvars_def: CvarsDef = parse_macro_input!(input);

    let mut cvars_attrs = cvars_def.attrs;
    for attr in &mut cvars_attrs {
        attr.style = AttrStyle::Outer;
    }

    let mut attrss = Vec::new();
    let mut skips = Vec::new();
    let mut names = Vec::new();
    let mut tys = Vec::new();
    let mut values = Vec::new();
    for cvar_def in cvars_def.cvars {
        attrss.push(cvar_def.attrs);
        skips.push(cvar_def.skip);
        names.push(cvar_def.name);
        tys.push(cvar_def.ty);
        values.push(cvar_def.value);
    }

    let struct_name = Ident::new("Cvars", Span::call_site());
    let generated = generate(struct_name, &skips, &names, &tys);

    let expanded = quote! {
        #(
            #cvars_attrs
        )*
        pub struct Cvars {
            #(
                #( #attrss )*
                pub #names: #tys,
            )*
            // __cvars_map: ::phf::Map<&'static str, usize>,
        }

        #[automatically_derived]
        impl ::core::default::Default for Cvars {
            fn default() -> Self {
                Self {
                    #( #names: #values, )*
                    // __cvars_map: ::phf::phf_map! {
                    //     #( #names => 0, )*
                    // },
                }
            }
        }

        #generated
    };
    let expanded = expanded.into();

    let end = std::time::Instant::now();
    if env::var("CVARS_STATS").is_ok() {
        eprintln!("cvars! took {:?}", end - begin);
    }

    expanded
}

/// Generate setters and getters that take cvar names as string.
/// This does the same thing as `cvars!` but you can use it on an existing struct.
///
/// Initial/default values have to be specified separately.
///
/// All types used as cvars have to impl `FromStr` and `Display`.
///
/// See [`cvars!`](cvars!#generated-code) for more details about the generated code.
///
/// # Example
///
/// ```rust
/// use cvars::SetGet;
///
/// #[derive(SetGet)]
/// pub struct Cvars {
///     g_rocket_launcher_ammo_max: i32,
///     g_rocket_launcher_damage: f32,
/// }
///
/// impl Cvars {
///     pub fn new() -> Self {
///         Self {
///             g_rocket_launcher_ammo_max: 20,
///             g_rocket_launcher_damage: 75.0,
///         }
///     }
/// }
/// ```
#[proc_macro_derive(SetGet, attributes(cvars))]
pub fn derive(input: TokenStream) -> TokenStream {
    let begin = std::time::Instant::now();

    let input: DeriveInput = parse_macro_input!(input);
    let struct_name = input.ident;

    let named_fields = match input.data {
        Data::Struct(struct_data) => match struct_data.fields {
            Fields::Named(named_fields) => named_fields,
            Fields::Unnamed(_) => panic!("tuple structs are not supported, use named fields"),
            Fields::Unit => panic!("unit structs are not supported, use curly braces"),
        },
        Data::Enum(_) => panic!("enums are not supported, use a struct"),
        Data::Union(_) => panic!("unions are not supported, use a struct"),
    };

    // Get the list of all cvars and their types
    let mut skips = Vec::new();
    let mut names = Vec::new();
    let mut tys = Vec::new();
    for field in named_fields.named {
        skips.push(contains_skip(&field.attrs));
        names.push(field.ident.expect("ident was None"));
        tys.push(field.ty);
    }

    let expanded = generate(struct_name, &skips, &names, &tys);
    let expanded = expanded.into();

    let end = std::time::Instant::now();
    if env::var("CVARS_STATS").is_ok() {
        eprintln!("derive(SetGet) took {:?}", end - begin);
    }

    expanded
}

fn generate(
    struct_name: Ident,
    skips: &[bool],
    names_all: &[Ident],
    tys_all: &[Type],
) -> proc_macro2::TokenStream {
    let mut names = Vec::new();
    let mut tys = Vec::new();
    for i in 0..skips.len() {
        if skips[i] {
            continue;
        }

        names.push(&names_all[i]);
        tys.push(&tys_all[i]);
    }

    let cvar_count = names.len();

    let set_get_impl = impl_set_get(&struct_name);

    // Get the set of types used as cvars.
    // We need to impl SetGetType for them and it needs to be done
    // once per type, not once per cvar.
    // Note: I benchmarked this against FnvHashSet and it doesn't make a difference.
    let unique_tys: HashSet<_> = tys.iter().collect();
    let mut trait_impls = Vec::new();
    for unique_ty in unique_tys {
        let mut getter_arms = Vec::new();
        let mut setter_arms = Vec::new();

        for i in 0..names.len() {
            let field = names[i];
            let ty = tys[i];
            // Each `impl SetGetType for X` block only generates match arms for cvars of type X
            // so that the getters and setters typecheck.
            if ty == *unique_ty {
                let getter_arm = quote! {
                    stringify!(#field) => ::core::result::Result::Ok(cvars.#field.clone()),
                };
                getter_arms.push(getter_arm);

                let setter_arm = quote! {
                    stringify!(#field) => ::core::result::Result::Ok(cvars.#field = value),
                };
                setter_arms.push(setter_arm);
            }
        }

        // LATER Is there a sane way to automatically convert? (even fallibly)
        //       e.g. integers default to i32 even though cvar type is usize
        //       At the very least, it should suggest specifying the type.
        let trait_impl = quote! {
            #[automatically_derived]
            impl SetGetType for #unique_ty {
                fn get(cvars: &Cvars, cvar_name: &str) -> ::core::result::Result<Self, String> {
                    match cvar_name {
                        #( #getter_arms )*
                        _ => ::core::result::Result::Err(format!(
                            "Cvar named {} with type {} not found",
                            cvar_name,
                            stringify!(#unique_ty)
                        )),
                    }
                }

                fn set(cvars: &mut Cvars, cvar_name: &str, value: Self) -> ::core::result::Result<(), String> {
                    match cvar_name {
                        #( #setter_arms )*
                        _ => ::core::result::Result::Err(format!(
                            "Cvar named {} with type {} not found",
                            cvar_name,
                            stringify!(#unique_ty),
                        )),
                    }
                }
            }
        };
        trait_impls.push(trait_impl);
    }

    quote! {
        #[automatically_derived]
        impl #struct_name {
            /// Finds the cvar whose name matches `cvar_name` and returns its value.
            ///
            /// Returns `Err` if the cvar doesn't exist.
            pub fn get<T: SetGetType>(&self, cvar_name: &str) -> ::core::result::Result<T, String> {
                // We can't generate all the match arms here because we don't know what concrete type T is.
                // Instead, we statically dispatch it through the SetGetType trait and then only look up
                // fields of the correct type in each impl block.
                SetGetType::get(self, cvar_name)
            }

            /// Finds the cvar whose name matches `cvar_name` and returns its value as a `String`.
            ///
            /// Returns `Err` if the cvar doesn't exist.
            pub fn get_string(&self, cvar_name: &str) -> ::core::result::Result<String, String> {
                // This doesn't need to be dispatched via SetGetType, it uses Display instead.

                // Separate function - see set_str for why.
                #[inline(never)]
                fn get_string<T: ::core::fmt::Display>(cvar: &T) -> ::core::result::Result<String, String> {
                    ::core::result::Result::Ok(cvar.to_string())
                }
                match cvar_name {
                    #( stringify!(#names) => get_string(&self.#names), )*
                    _ => ::core::result::Result::Err(format!(
                        "Cvar named {} not found",
                        cvar_name,
                    )),
                }
            }

            /// Finds the cvar whose name matches `cvar_name` and sets it to `value`.
            ///
            /// Returns `Err` if the cvar doesn't exist or its type doesn't match that of `value`.
            ///
            /// **Note**: Rust can't infer the type of `value` based on the type of the cvar
            /// because `cvar_name` is resolved to the right struct field only at runtime.
            /// This means integer literals default to `i32` and float literals to `f64`.
            /// This in turn means if the cvar's type is e.g. usize and you try
            /// `cvars.set("sometihng_with_type_usize", 123);`, it will fail
            /// because at compile time, `123` is inferred to be `i32`.
            /// Use `123_usize` to specify the correct type.
            ///
            /// This limitation doesn't apply to `set_str` since it determines which type to parse to
            /// *after* looking up the right field at runtime.
            pub fn set<T: SetGetType>(&mut self, cvar_name: &str, value: T) -> ::core::result::Result<(), String> {
                SetGetType::set(self, cvar_name, value)
            }

            /// Finds the cvar whose name matches `cvar_name`, tries to parse `str_value` to its type and sets it to the parsed value.
            ///
            /// Returns `Err` if the cvar doesn't exist or if `str_value` fails to parse to its type.
            pub fn set_str(&mut self, cvar_name: &str, str_value: &str) -> ::core::result::Result<(), String> {
                // This doesn't need to be dispatched via SetGetType, it uses FromStr instead.

                // Put most of the logic in a separate function
                // so that the repeated code is only a single function call.
                // This roughly halves incremental compilation time
                // when the Cvars struct is modified for 1k cvars.
                #[inline(never)]
                fn set_str<T>(cvar: &mut T, mut str_value: &str) -> ::core::result::Result<(), String>
                where
                    T: ::core::str::FromStr,
                    T::Err: ::core::fmt::Display,
                {
                    if ::std::any::type_name::<T>() == "bool" {
                        if str_value == "t" || str_value == "1" {
                            str_value = "true";
                        } else if str_value == "f" || str_value == "0" {
                            str_value = "false";
                        }
                    }
                    match str_value.parse() {
                        ::core::result::Result::Ok(val) => ::core::result::Result::Ok(*cvar = val),
                        ::core::result::Result::Err(err) => ::core::result::Result::Err(format!("failed to parse {} as type {}: {}",
                            str_value,
                            ::std::any::type_name::<T>(),
                            err,
                        ))
                    }
                }
                match cvar_name {
                    #( stringify!(#names) => set_str(&mut self.#names, str_value), )*
                    _ => ::core::result::Result::Err(format!(
                        "Cvar named {} not found",
                        cvar_name
                    )),
                }
            }

            /// Returns the number of cvars.
            pub fn cvar_count(&self) -> usize {
                #cvar_count
            }

            /// The number of cvars.
            pub const CVAR_COUNT: usize = #cvar_count;
        }

        #set_get_impl

        /// This trait is needed to dispatch cvar get/set based on its type.
        /// You're not meant to impl it yourself, it's done automatically
        /// for all types used as cvars.
        pub trait SetGetType {
            fn get(cvars: &Cvars, cvar_name: &str) -> ::core::result::Result<Self, String>
                where Self: Sized;
            fn set(cvars: &mut Cvars, cvar_name: &str, value: Self) -> ::core::result::Result<(), String>;
        }

        #( #trait_impls )*
    }
}

/// Check whether the field has the `#[cvars(skip)]` attribute
fn contains_skip(attrs: &[Attribute]) -> bool {
    attrs.iter().any(is_skip)
}

fn is_skip(attr: &Attribute) -> bool {
    if let Meta::List(MetaList { path, tokens, .. }) = &attr.meta {
        if !path.is_ident("cvars") {
            return false;
        }

        // Is it #[cvars(skip)]?
        let mut tokens = tokens.clone().into_iter();
        let nested = tokens.next().expect("expected #[cvars(skip)]");
        assert!(tokens.next().is_none(), "expected #[cvars(skip)]");
        if let TokenTree::Ident(ident) = nested {
            if ident == "skip" {
                true
            } else {
                panic!("expected #[cvars(skip)]");
            }
        } else {
            panic!("expected #[cvars(skip)]");
        }
    } else {
        false
    }
}

/// Dummy version of SetGet for debugging how much cvars add to _incremental_ compile times of your project.
///
/// Generates the 4 setters and getters like SetGet but they contain only `unimplemented!()`,
/// therefore the code to dispatch from string to struct field is not generated.
/// This exists only to test how using SetGet affects the total compile time of downstream crates.
/// Simply replace SetGet with SetGetDummy and compare how long `cargo build` takes.
/// The resulting code should compile but will crash if the generated methods are used.
#[doc(hidden)]
#[proc_macro_derive(SetGetDummy, attributes(cvars))]
pub fn derive_dummy(input: TokenStream) -> TokenStream {
    let begin = std::time::Instant::now();

    let input: DeriveInput = parse_macro_input!(input);
    let struct_name = input.ident;
    let set_get_impl = impl_set_get(&struct_name);

    let expanded = quote! {
        #[automatically_derived]
        impl #struct_name {
            pub fn get<T>(&self, cvar_name: &str) -> ::core::result::Result<T, String> {
                unimplemented!("SetGetDummy is only for compile time testing.");
            }
            pub fn get_string(&self, cvar_name: &str) -> ::core::result::Result<String, String> {
                unimplemented!("SetGetDummy is only for compile time testing.");
            }
            pub fn set<T>(&mut self, cvar_name: &str, value: T) -> ::core::result::Result<(), String> {
                unimplemented!("SetGetDummy is only for compile time testing.");
            }
            pub fn set_str(&mut self, cvar_name: &str, str_value: &str) -> ::core::result::Result<(), String> {
                unimplemented!("SetGetDummy is only for compile time testing.");
            }
            pub fn cvar_count(&self) -> usize {
                unimplemented!("SetGetDummy is only for compile time testing.");
            }
        }

        #set_get_impl
    };
    let expanded = TokenStream::from(expanded);

    let end = std::time::Instant::now();
    if env::var("CVARS_STATS").is_ok() {
        eprintln!("derive(SetGetDummy) took {:?}", end - begin);
    }

    expanded
}

fn impl_set_get(struct_name: &Ident) -> proc_macro2::TokenStream {
    quote! {
        #[automatically_derived]
        impl ::cvars::SetGet for #struct_name {
            fn get_string(&self, cvar_name: &str) -> ::core::result::Result<String, String> {
                self.get_string(cvar_name)
            }

            fn set_str(&mut self, cvar_name: &str, cvar_value: &str) -> ::core::result::Result<(), String> {
                self.set_str(cvar_name, cvar_value)
            }

            fn cvar_count(&self) -> usize {
                self.cvar_count()
            }
        }
    }
}