strid-macros 9.0.0

Implementation macros for the `strid` crate
Documentation
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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
use proc_macro2::Literal;
use quote::{ToTokens, TokenStreamExt};
use symbol::{parse_lit_into_string, parse_lit_into_type};
use unsynn::{IParse, ToTokenIter};

pub use self::{borrowed::RefCodeGen, owned::OwnedCodeGen};
use self::{
    check_mode::{CheckMode, IndefiniteCheckMode},
    impls::{DelegatingImplOption, ImplOption, Impls},
};

mod borrowed;
mod check_mode;
mod impls;
mod owned;
mod symbol;

pub type AttrList = Vec<crate::attr_grammar::AttrArg>;

#[derive(Clone, Debug)]
pub struct StdLib {
    core: proc_macro2::Ident,
    alloc: proc_macro2::Ident,
}

impl StdLib {
    pub fn no_std(span: proc_macro2::Span) -> Self {
        Self {
            core: proc_macro2::Ident::new("core", span),
            alloc: proc_macro2::Ident::new("alloc", span),
        }
    }

    pub fn core(&self) -> &proc_macro2::Ident {
        &self.core
    }

    pub fn alloc(&self) -> &proc_macro2::Ident {
        &self.alloc
    }
}

impl Default for StdLib {
    fn default() -> Self {
        Self {
            core: proc_macro2::Ident::new("std", proc_macro2::Span::call_site()),
            alloc: proc_macro2::Ident::new("std", proc_macro2::Span::call_site()),
        }
    }
}

pub struct Params {
    ref_ty: Option<crate::grammar::Type>,
    ref_doc: Vec<Literal>,
    ref_attrs: AttrList,
    owned_attrs: AttrList,
    std_lib: StdLib,
    check_mode: IndefiniteCheckMode,
    expose_inner: bool,
    impls: Impls,
}

impl Default for Params {
    fn default() -> Self {
        Self {
            ref_ty: None,
            ref_doc: Vec::new(),
            ref_attrs: AttrList::new(),
            owned_attrs: AttrList::new(),
            std_lib: StdLib::default(),
            check_mode: IndefiniteCheckMode::None,
            expose_inner: true,
            impls: Impls::default(),
        }
    }
}

impl Params {
    pub fn from_args(args: crate::attr_grammar::AttrArgs) -> Result<Self, String> {
        let mut params = Self::default();

        for delim in args.args.iter() {
            let arg = &delim.value;
            let name = arg.name();

            if name == symbol::REF {
                if let Some(lit) = arg.value() {
                    let type_str = parse_lit_into_string(symbol::REF, lit)?;
                    params.ref_ty = Some(parse_lit_into_type(symbol::REF, &type_str)?);
                } else {
                    return Err("expected ref_name = \"TypeName\"".to_string());
                }
            } else if name == symbol::VALIDATOR {
                let validator = if let Some(lit) = arg.value() {
                    let type_str = parse_lit_into_string(symbol::VALIDATOR, lit)?;
                    Some(parse_lit_into_type(symbol::VALIDATOR, &type_str)?)
                } else {
                    None
                };
                params.check_mode.try_set_validator(validator)?;
            } else if name == symbol::NORMALIZER {
                let normalizer = if let Some(lit) = arg.value() {
                    let type_str = parse_lit_into_string(symbol::NORMALIZER, lit)?;
                    Some(parse_lit_into_type(symbol::NORMALIZER, &type_str)?)
                } else {
                    None
                };
                params.check_mode.try_set_normalizer(normalizer)?;
            } else if name == symbol::REF_DOC {
                if let Some(lit) = arg.value() {
                    params.ref_doc.push(lit.clone());
                } else {
                    return Err("expected ref_doc = \"doc comment\"".to_string());
                }
            } else if name == symbol::REF_ATTR {
                // Store the raw list contents for now
                // In a real implementation, you'd parse these properly
                if let Some(_contents) = arg.list_contents() {
                    // For now, we'll skip storing ref_attrs
                    // A full implementation would parse these
                }
            } else if name == symbol::OWNED_ATTR {
                if let Some(_contents) = arg.list_contents() {
                    // For now, we'll skip storing owned_attrs
                }
            } else if name == symbol::DEBUG {
                if let Some(lit) = arg.value() {
                    params.impls.debug = parse_lit_into_string(symbol::DEBUG, lit)?
                        .parse::<DelegatingImplOption>()
                        .map_err(|e| e.to_string())?
                        .into();
                } else {
                    return Err("expected debug = \"impl|owned|omit\"".to_string());
                }
            } else if name == symbol::DISPLAY {
                if let Some(lit) = arg.value() {
                    params.impls.display = parse_lit_into_string(symbol::DISPLAY, lit)?
                        .parse::<DelegatingImplOption>()
                        .map_err(|e| e.to_string())?
                        .into();
                } else {
                    return Err("expected display = \"impl|owned|omit\"".to_string());
                }
            } else if name == symbol::ORD {
                if let Some(lit) = arg.value() {
                    params.impls.ord = parse_lit_into_string(symbol::ORD, lit)?
                        .parse::<DelegatingImplOption>()
                        .map_err(|e| e.to_string())?
                        .into();
                } else {
                    return Err("expected ord = \"impl|owned|omit\"".to_string());
                }
            } else if name == symbol::CLONE {
                if let Some(lit) = arg.value() {
                    params.impls.clone = parse_lit_into_string(symbol::CLONE, lit)?
                        .parse::<ImplOption>()
                        .map_err(|e| e.to_string())?
                        .into();
                } else {
                    return Err("expected clone = \"impl|omit\"".to_string());
                }
            } else if name == symbol::SERDE {
                if let Some(lit) = arg.value() {
                    params.impls.serde = parse_lit_into_string(symbol::SERDE, lit)?
                        .parse::<ImplOption>()
                        .map_err(|e| e.to_string())?
                        .into();
                } else {
                    params.impls.serde = ImplOption::Implement.into();
                }
            } else if name == symbol::NO_STD {
                params.std_lib = StdLib::no_std(proc_macro2::Span::call_site());
            } else if name == symbol::NO_EXPOSE {
                params.expose_inner = false;
            } else {
                return Err(format!("unsupported argument `{}`", name));
            }
        }

        Ok(params)
    }
}

impl Params {
    pub fn build(self, mut body: crate::grammar::ItemStruct) -> Result<CodeGen, String> {
        let Params {
            ref_ty,
            ref_doc,
            ref_attrs,
            owned_attrs,
            std_lib,
            check_mode,
            expose_inner,
            impls,
        } = self;

        create_field_if_none(&mut body.fields);
        let (wrapped_type, field_ident, field_attrs) = get_field_info(&body.fields)?;
        let owned_ty = &body.ident;
        let ref_ty = ref_ty.unwrap_or_else(|| infer_ref_type_from_owned_name(owned_ty));
        let check_mode = check_mode.infer_validator_if_missing(owned_ty);
        let field = Field {
            attrs: field_attrs.to_vec(),
            name: field_ident
                .map(|i| FieldName::Named(i.clone()))
                .unwrap_or(FieldName::Unnamed),
            ty: wrapped_type.clone(),
        };

        Ok(CodeGen {
            check_mode,
            body,
            field,

            owned_attrs,

            ref_doc,
            ref_attrs,
            ref_ty,

            std_lib,
            expose_inner,
            impls,
        })
    }
}

pub struct ParamsRef {
    std_lib: StdLib,
    check_mode: IndefiniteCheckMode,
    impls: Impls,
}

impl Default for ParamsRef {
    fn default() -> Self {
        Self {
            std_lib: StdLib::default(),
            check_mode: IndefiniteCheckMode::None,
            impls: Impls::default(),
        }
    }
}

impl ParamsRef {
    pub fn from_args(args: crate::attr_grammar::AttrArgs) -> Result<Self, String> {
        let mut params = Self::default();

        for delim in args.args.iter() {
            let arg = &delim.value;
            let name = arg.name();

            if name == symbol::VALIDATOR {
                let validator = if let Some(lit) = arg.value() {
                    let type_str = parse_lit_into_string(symbol::VALIDATOR, lit)?;
                    Some(parse_lit_into_type(symbol::VALIDATOR, &type_str)?)
                } else {
                    None
                };
                params.check_mode.try_set_validator(validator)?;
            } else if name == symbol::DEBUG {
                if let Some(lit) = arg.value() {
                    params.impls.debug = parse_lit_into_string(symbol::DEBUG, lit)?
                        .parse::<ImplOption>()
                        .map_err(|e| e.to_string())
                        .map(DelegatingImplOption::from)?
                        .into();
                } else {
                    return Err("expected debug = \"impl|omit\"".to_string());
                }
            } else if name == symbol::DISPLAY {
                if let Some(lit) = arg.value() {
                    params.impls.display = parse_lit_into_string(symbol::DISPLAY, lit)?
                        .parse::<ImplOption>()
                        .map_err(|e| e.to_string())
                        .map(DelegatingImplOption::from)?
                        .into();
                } else {
                    return Err("expected display = \"impl|omit\"".to_string());
                }
            } else if name == symbol::ORD {
                if let Some(lit) = arg.value() {
                    params.impls.ord = parse_lit_into_string(symbol::ORD, lit)?
                        .parse::<ImplOption>()
                        .map_err(|e| e.to_string())
                        .map(DelegatingImplOption::from)?
                        .into();
                } else {
                    return Err("expected ord = \"impl|omit\"".to_string());
                }
            } else if name == symbol::SERDE {
                if let Some(lit) = arg.value() {
                    params.impls.serde = parse_lit_into_string(symbol::SERDE, lit)?
                        .parse::<ImplOption>()
                        .map_err(|e| e.to_string())?
                        .into();
                } else {
                    params.impls.serde = ImplOption::Implement.into();
                }
            } else if name == symbol::NO_STD {
                params.std_lib = StdLib::no_std(proc_macro2::Span::call_site());
            } else {
                return Err(format!("unsupported argument `{}`", name));
            }
        }

        Ok(params)
    }
}

impl ParamsRef {
    pub fn build(
        self,
        body: &mut crate::grammar::ItemStruct,
    ) -> Result<proc_macro2::TokenStream, String> {
        let ParamsRef {
            std_lib,
            check_mode,
            impls,
        } = self;

        create_ref_field_if_none(&mut body.fields);
        let (wrapped_type, field_ident, field_attrs) = get_field_info(&body.fields)?;
        let ref_ty = &body.ident;
        let check_mode = check_mode.infer_validator_if_missing(ref_ty);
        let field = Field {
            attrs: field_attrs.to_vec(),
            name: field_ident
                .map(|i| FieldName::Named(i.clone()))
                .unwrap_or(FieldName::Unnamed),
            ty: wrapped_type.clone(),
        };

        // Create a verbatim type from the ident
        let ty_tokens = body.ident.to_token_stream();
        let mut ty_iter = ty_tokens.to_token_iter();
        let ty = ty_iter
            .parse::<crate::grammar::Type>()
            .map_err(|e| format!("failed to parse type: {}", e))?;

        let code_gen = RefCodeGen {
            doc: &[],
            common_attrs: &body.attrs,
            attrs: &vec![],
            vis: body.vis.as_ref(),
            ty: &ty,
            ident: body.ident.clone(),
            field,
            check_mode: &check_mode,
            owned_ty: None,
            std_lib: &std_lib,
            impls: &impls,
        }
        .tokens();

        Ok(code_gen)
    }
}

pub struct CodeGen {
    check_mode: CheckMode,
    body: crate::grammar::ItemStruct,
    field: Field,

    owned_attrs: AttrList,

    ref_doc: Vec<Literal>,
    ref_attrs: AttrList,
    ref_ty: crate::grammar::Type,

    std_lib: StdLib,
    expose_inner: bool,
    impls: Impls,
}

impl CodeGen {
    pub fn generate(&self) -> proc_macro2::TokenStream {
        let owned = self.owned().tokens();
        let ref_ = self.borrowed().tokens();

        quote::quote! {
            #owned
            #ref_
        }
    }

    pub fn owned(&self) -> OwnedCodeGen<'_> {
        OwnedCodeGen {
            common_attrs: &self.body.attrs,
            check_mode: &self.check_mode,
            body: &self.body,
            field: &self.field,
            attrs: &self.owned_attrs,
            ty: &self.body.ident,
            ref_ty: &self.ref_ty,
            std_lib: &self.std_lib,
            expose_inner: self.expose_inner,
            impls: &self.impls,
        }
    }

    pub fn borrowed(&self) -> RefCodeGen<'_> {
        RefCodeGen {
            doc: &self.ref_doc,
            common_attrs: &self.body.attrs,
            check_mode: &self.check_mode,
            vis: self.body.vis.as_ref(),
            field: self.field.clone(),
            attrs: &self.ref_attrs,
            ty: &self.ref_ty,
            ident: {
                let tokens = self.ref_ty.to_token_stream();
                let mut iter = tokens.to_token_iter();
                iter.parse::<unsynn::Ident>().unwrap_or_else(|_| {
                    unsynn::Ident::from(proc_macro2::Ident::new(
                        "UnknownType",
                        proc_macro2::Span::call_site(),
                    ))
                })
            },
            owned_ty: Some(&self.body.ident),
            std_lib: &self.std_lib,
            impls: &self.impls,
        }
    }
}

fn infer_ref_type_from_owned_name(name: &unsynn::Ident) -> crate::grammar::Type {
    let name_str = name.to_string();
    let ref_name = if name_str.ends_with("Buf") || name_str.ends_with("String") {
        &name_str[..name_str.len() - 3]
    } else {
        &format!("{}Ref", name_str)
    };

    // Parse the ref name as a type
    let tokens: proc_macro2::TokenStream = ref_name.parse().unwrap();
    let mut iter = tokens.to_token_iter();
    iter.parse::<crate::grammar::Type>()
        .expect("failed to parse ref type")
}

fn create_field_if_none(fields: &mut crate::grammar::Fields) {
    use crate::grammar::Fields;

    // If it's a unit struct, convert it to an unnamed tuple struct with String
    if matches!(fields, Fields::Unit(_)) {
        // Parse a dummy struct to extract the fields structure
        let dummy_struct: proc_macro2::TokenStream = "struct Dummy(String);".parse().unwrap();
        let mut iter = dummy_struct.to_token_iter();
        let parsed = iter
            .parse::<crate::grammar::ItemStruct>()
            .expect("failed to parse dummy struct");

        // Extract the fields from the parsed struct
        if let Fields::Unnamed(ref unnamed) = parsed.fields {
            *fields = Fields::Unnamed(unnamed.clone());
        }
    }
}

fn create_ref_field_if_none(fields: &mut crate::grammar::Fields) {
    // For unsynn, if fields is empty, we don't need to create a default field
    // The parsing should have already handled this, or we can just leave it empty
    // This function is kept for compatibility but may not be needed
    let _ = fields; // Suppress unused warning
}

fn get_field_info<'a>(
    fields: &'a crate::grammar::Fields,
) -> Result<
    (
        &'a crate::grammar::Type,
        Option<&'a unsynn::Ident>,
        &'a [crate::grammar::Attribute],
    ),
    String,
> {
    use crate::grammar::Fields;

    match fields {
        Fields::Named(f) => {
            if f.content.is_empty() {
                return Err("struct must have at least one field".to_string());
            }
            if f.content.len() > 1 {
                return Err("typed string can only have one field".to_string());
            }
            let field = &f.content[0].value;
            Ok((&field.ty, Some(&field.ident), &field.attrs))
        }
        Fields::Unnamed(f) => {
            if f.content.is_empty() {
                return Err("struct must have at least one field".to_string());
            }
            if f.content.len() > 1 {
                return Err("typed string can only have one field".to_string());
            }
            let field = &f.content[0].value;
            Ok((&field.ty, None, &field.attrs))
        }
        Fields::Unit(_) => {
            Err("unit structs are not supported - struct must have at least one field".to_string())
        }
    }
}

#[derive(Clone)]
pub struct Field {
    pub attrs: Vec<crate::grammar::Attribute>,
    pub name: FieldName,
    pub ty: crate::grammar::Type,
}

impl Field {
    fn self_constructor(&self) -> SelfConstructorImpl<'_> {
        SelfConstructorImpl(self)
    }
}

#[derive(Clone)]
pub enum FieldName {
    Named(unsynn::Ident),
    Unnamed,
}

impl FieldName {
    fn constructor_delimiter(&self) -> proc_macro2::Delimiter {
        match self {
            FieldName::Named(_) => proc_macro2::Delimiter::Brace,
            FieldName::Unnamed => proc_macro2::Delimiter::Parenthesis,
        }
    }

    fn input_name(&self) -> proc_macro2::Ident {
        match self {
            FieldName::Named(name) => name.clone(),
            FieldName::Unnamed => proc_macro2::Ident::new("raw", proc_macro2::Span::call_site()),
        }
    }
}

impl ToTokens for FieldName {
    fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
        match self {
            Self::Named(ident) => ident.to_tokens(tokens),
            Self::Unnamed => tokens.append(Literal::u8_unsuffixed(0)),
        }
    }
}

struct SelfConstructorImpl<'a>(&'a Field);

impl<'a> ToTokens for SelfConstructorImpl<'a> {
    fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
        let Self(field) = self;
        tokens.append(proc_macro2::Ident::new(
            "Self",
            proc_macro2::Span::call_site(),
        ));
        tokens.append(proc_macro2::Group::new(
            field.name.constructor_delimiter(),
            field.name.input_name().into_token_stream(),
        ));
    }
}