nanojson-derive 0.4.0

Derive macros (Serialize, Deserialize) for the nanojson 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
use proc_macro::{Delimiter, Group, Ident, Span, TokenStream, TokenTree};
use crate::helpers::compiler_error;

// ---- Public types ----

pub(crate) struct ParsedItem {
    pub name: String,
    #[allow(dead_code)]
    pub name_span: Span,
    /// Raw generic params (everything between `<` and `>`, exclusive), or empty.
    pub generics: Vec<TokenTree>,
    pub kind: ItemKind,
}

pub(crate) enum ItemKind {
    Struct(Vec<ParsedField>),
    Enum(Vec<ParsedVariant>),
}

pub(crate) struct ParsedField {
    pub name: String,
    #[allow(dead_code)]
    pub name_span: Span,
    /// Raw token trees for the field type.
    pub ty: Vec<TokenTree>,
    /// JSON key name (from `#[nanojson(rename = "...")]` or the field ident).
    pub json_name: String,
    /// If `#[nanojson(default)]` is present, use `Default::default()` when the
    /// field is absent from JSON instead of returning `MissingField`.
    pub has_default: bool,
}

pub(crate) struct ParsedVariant {
    pub name: String,
    #[allow(dead_code)]
    pub name_span: Span,
    pub fields: VariantFields,
    pub json_name: String,
}

pub(crate) enum VariantFields {
    Unit,
    Named(Vec<ParsedField>),
}

// ---- Token iterator helpers ----

struct Tokens {
    inner: Vec<TokenTree>,
    pos: usize,
}

impl Tokens {
    fn new(ts: TokenStream) -> Self {
        Self { inner: ts.into_iter().collect(), pos: 0 }
    }

    fn peek(&self) -> Option<&TokenTree> {
        self.inner.get(self.pos)
    }

    fn next(&mut self) -> Option<TokenTree> {
        if self.pos < self.inner.len() {
            let t = self.inner[self.pos].clone();
            self.pos += 1;
            Some(t)
        } else {
            None
        }
    }

    fn next_ident(&mut self) -> Result<Ident, TokenStream> {
        match self.next() {
            Some(TokenTree::Ident(i)) => Ok(i),
            Some(other) => compiler_error!(other, "expected identifier, got `{other}`"),
            None => compiler_error!("unexpected end of input, expected identifier"),
        }
    }

    fn skip_visibility(&mut self) {
        // pub / pub(crate) / pub(super) / pub(in path)
        if let Some(TokenTree::Ident(i)) = self.peek() {
            if i.to_string() == "pub" {
                self.pos += 1;
                // absorb optional (...)
                if let Some(TokenTree::Group(g)) = self.peek() {
                    if g.delimiter() == Delimiter::Parenthesis {
                        self.pos += 1;
                    }
                }
            }
        }
    }

    /// Collect a type up to (not including) a `,` at angle-bracket depth 0, consuming
    /// any trailing `,`. Angle brackets in generic parameters (e.g. `HashMap<String, V>`)
    /// are tracked so their inner commas are not mistaken for field separators.
    fn collect_until_comma(&mut self) -> Vec<TokenTree> {
        let mut out = Vec::new();
        let mut depth = 0usize;
        loop {
            match self.peek() {
                None => break,
                Some(TokenTree::Punct(p)) if p.as_char() == ',' && depth == 0 => {
                    self.pos += 1;
                    break;
                }
                Some(TokenTree::Punct(p)) if p.as_char() == '<' => {
                    depth += 1;
                    out.push(self.next().unwrap());
                }
                Some(TokenTree::Punct(p)) if p.as_char() == '>' => {
                    depth = depth.saturating_sub(1);
                    out.push(self.next().unwrap());
                }
                _ => out.push(self.next().unwrap()),
            }
        }
        out
    }

    /// Collect generic params between `<` and matching `>`.
    /// Assumes we've already seen that the next token is `<`.
    fn collect_generics(&mut self) -> Result<Vec<TokenTree>, TokenStream> {
        // The proc_macro tokenizer may give us `<` as a Punct or might have
        // already grouped things. For simplicity we handle the common cases:
        // - No generics: return empty immediately.
        // - `<T, U>`: collect token trees tracking depth.
        let is_lt = match self.peek() {
            Some(TokenTree::Punct(p)) if p.as_char() == '<' => true,
            _ => false,
        };
        if !is_lt {
            return Ok(Vec::new());
        }
        self.next(); // consume `<`
        let mut out = Vec::new();
        let mut depth = 1usize;
        loop {
            match self.next() {
                None => return compiler_error!("unexpected end of input inside generics"),
                Some(TokenTree::Punct(p)) if p.as_char() == '<' => {
                    depth += 1;
                    out.push(TokenTree::Punct(p));
                }
                Some(TokenTree::Punct(p)) if p.as_char() == '>' => {
                    depth -= 1;
                    if depth == 0 { break; }
                    out.push(TokenTree::Punct(p));
                }
                Some(t) => out.push(t),
            }
        }
        Ok(out)
    }
}

// ---- Attribute parsing ----

struct FieldAttrs {
    rename: Option<String>,
    has_default: bool,
}

/// Accumulates `#[nanojson(...)]` attributes from a field's attribute list.
fn parse_attrs(attrs: &[TokenTree]) -> Result<FieldAttrs, TokenStream> {
    let mut result = FieldAttrs { rename: None, has_default: false };
    let mut i = 0;
    while i < attrs.len() {
        // Look for `# [ ... ]`
        if let TokenTree::Punct(p) = &attrs[i] {
            if p.as_char() == '#' {
                i += 1;
                if i >= attrs.len() { break; }
                if let TokenTree::Group(g) = &attrs[i] {
                    if g.delimiter() == Delimiter::Bracket {
                        parse_nanojson_attr(g.stream(), &mut result)?;
                    }
                }
            }
        }
        i += 1;
    }
    Ok(result)
}

/// Parse the inside of `#[nanojson(...)]` and merge results into `out`.
fn parse_nanojson_attr(ts: TokenStream, out: &mut FieldAttrs) -> Result<(), TokenStream> {
    let mut toks = Tokens::new(ts);
    // First ident must be "nanojson"
    match toks.peek() {
        Some(TokenTree::Ident(i)) if i.to_string() == "nanojson" => { toks.next(); }
        _ => return Ok(()), // not our attribute
    }
    // Expect `(...)`
    match toks.next() {
        Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Parenthesis => {
            let mut inner = Tokens::new(g.stream());
            while inner.peek().is_some() {
                let key = inner.next_ident()?;
                let key_str = key.to_string();
                match key_str.as_str() {
                    "default" => {
                        out.has_default = true;
                    }
                    "rename" => {
                        // consume `=`
                        match inner.next() {
                            Some(TokenTree::Punct(p)) if p.as_char() == '=' => {}
                            Some(other) => return compiler_error!(other, "expected `=` after `rename`"),
                            None => return compiler_error!("expected `=` after `rename`"),
                        }
                        let value = match inner.next() {
                            Some(TokenTree::Literal(lit)) => {
                                let s = lit.to_string();
                                if s.starts_with('"') && s.ends_with('"') {
                                    s[1..s.len()-1].to_string()
                                } else {
                                    return compiler_error!(lit, "expected string literal for `rename`");
                                }
                            }
                            Some(other) => return compiler_error!(other, "expected string literal for `rename`"),
                            None => return compiler_error!("expected string literal for `rename`"),
                        };
                        out.rename = Some(value);
                    }
                    other => return compiler_error!(key, "unknown nanojson attribute `{other}`"),
                }
                // skip optional comma between attributes
                if let Some(TokenTree::Punct(p)) = inner.peek() {
                    if p.as_char() == ',' { inner.next(); }
                }
            }
            Ok(())
        }
        Some(other) => compiler_error!(other, "expected `(...)` after `nanojson`"),
        None => Ok(()),
    }
}

// ---- Field parsing ----

fn parse_named_fields(group: Group) -> Result<Vec<ParsedField>, TokenStream> {
    let mut toks = Tokens::new(group.stream());
    let mut fields = Vec::new();

    loop {
        // Collect leading attributes
        let mut attrs: Vec<TokenTree> = Vec::new();
        loop {
            match toks.peek() {
                Some(TokenTree::Punct(p)) if p.as_char() == '#' => {
                    attrs.push(toks.next().unwrap());
                    match toks.next() {
                        Some(t @ TokenTree::Group(_)) => attrs.push(t),
                        Some(other) => return compiler_error!(other, "expected `[...]` after `#`"),
                        None => return compiler_error!("unexpected end of input after `#`"),
                    }
                }
                _ => break,
            }
        }

        toks.skip_visibility();

        // End of fields?
        if toks.peek().is_none() { break; }

        // Field name
        let name_ident = toks.next_ident()?;
        let name_str = name_ident.to_string();
        let name_span = name_ident.span();

        // `:`
        match toks.next() {
            Some(TokenTree::Punct(p)) if p.as_char() == ':' => {}
            Some(other) => return compiler_error!(other, "expected `:` after field `{name_str}`"),
            None => return compiler_error!("expected `:` after field `{name_str}`"),
        }

        // Type tokens (up to `,`)
        let ty = toks.collect_until_comma();

        let (json_name, has_default) = match parse_attrs(&attrs) {
            Ok(attrs) => (attrs.rename.unwrap_or(name_str.clone()), attrs.has_default),
            Err(tt) => return Err(tt),
        };

        fields.push(ParsedField { name: name_str, name_span, ty, json_name, has_default });
    }

    Ok(fields)
}

// ---- Variant parsing ----

fn parse_variants(group: Group) -> Result<Vec<ParsedVariant>, TokenStream> {
    let mut toks = Tokens::new(group.stream());
    let mut variants = Vec::new();

    loop {
        // Attributes
        let mut attrs: Vec<TokenTree> = Vec::new();
        loop {
            match toks.peek() {
                Some(TokenTree::Punct(p)) if p.as_char() == '#' => {
                    attrs.push(toks.next().unwrap());
                    match toks.next() {
                        Some(t @ TokenTree::Group(_)) => attrs.push(t),
                        Some(other) => return compiler_error!(other, "expected `[...]` after `#`"),
                        None => return compiler_error!("unexpected end of input after `#`"),
                    }
                }
                _ => break,
            }
        }

        if toks.peek().is_none() { break; }

        let name_ident = toks.next_ident()?;
        let name_str = name_ident.to_string();
        let name_span = name_ident.span();

        // Named fields `{ ... }`, tuple `( ... )`, or unit
        let fields = match toks.peek() {
            Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Brace => {
                let g = match toks.next() {
                    Some(TokenTree::Group(g)) => g,
                    Some(other) => return compiler_error!(other, "internal error: expected `{{...}}`"),
                    None        => return compiler_error!("internal error: unexpected end of input"),
                };
                let f = parse_named_fields(g)?;
                VariantFields::Named(f)
            }
            Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Parenthesis => {
                return compiler_error!(
                    name_ident,
                    "tuple variants are not supported by nanojson-derive (variant `{name_str}`)"
                );
            }
            _ => VariantFields::Unit,
        };

        // consume trailing comma
        if let Some(TokenTree::Punct(p)) = toks.peek() {
            if p.as_char() == ',' { toks.next(); }
        }

        let json_name = match parse_attrs(&attrs)?.rename  {
            Some(rename) => rename,
            None => name_str.clone(),
        };

        variants.push(ParsedVariant { name: name_str, name_span, fields, json_name });
    }

    Ok(variants)
}

// ---- Top-level parse ----

pub(crate) fn parse_item(input: TokenStream) -> Result<ParsedItem, TokenStream> {
    let mut toks = Tokens::new(input);

    // Skip any outer attributes (e.g. #[derive(...)])
    loop {
        match toks.peek() {
            Some(TokenTree::Punct(p)) if p.as_char() == '#' => {
                toks.next();
                toks.next(); // consume the `[...]`
            }
            _ => break,
        }
    }

    toks.skip_visibility();

    // struct or enum
    let kw = toks.next_ident()?;
    let kw_str = kw.to_string();
    if kw_str != "struct" && kw_str != "enum" {
        return compiler_error!(kw, "nanojson-derive only supports `struct` and `enum`");
    }

    let name_ident = toks.next_ident()?;
    let name_str = name_ident.to_string();
    let name_span = name_ident.span();

    // Optional generics
    let generics = toks.collect_generics()?;

    // Skip where clause if present
    if let Some(TokenTree::Ident(i)) = toks.peek() {
        if i.to_string() == "where" {
            // consume until `{`
            loop {
                match toks.peek() {
                    Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Brace => break,
                    None => return compiler_error!("unexpected end of input in where clause"),
                    _ => { toks.next(); }
                }
            }
        }
    }

    // Body `{ ... }`
    let body = match toks.next() {
        Some(TokenTree::Group(g)) if g.delimiter() == Delimiter::Brace => g,
        Some(other) => return compiler_error!(other, "expected `{{...}}` body"),
        None => return compiler_error!("expected `{{...}}` body"),
    };

    let kind = match kw_str.as_str() {
        "struct" => ItemKind::Struct(parse_named_fields(body)?),
        "enum"   => ItemKind::Enum(parse_variants(body)?),
        _ => return compiler_error!(kw, "nanojson-derive: unexpected keyword `{kw_str}`"),
    };

    Ok(ParsedItem { name: name_str, name_span, generics, kind })
}