venial 0.6.1

A very small syn
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
use crate::error::Error;
use crate::parse_utils::{
    consume_colon2, consume_comma, consume_ident, consume_outer_attributes, consume_punct,
    consume_stuff_until, consume_vis_marker, parse_any_ident, parse_punct,
};
use crate::types::{
    EnumVariant, EnumVariantValue, Fields, GenericArg, GenericArgList, GenericBound, GenericParam,
    GenericParamList, GroupSpan, Lifetime, NamedField, NamedFields, Punctuated, TupleField,
    TupleFields, TypeExpr, WhereClause, WhereClausePredicate,
};
use proc_macro2::{Delimiter, Group, Ident, Punct, TokenStream, TokenTree};
use std::iter::Peekable;

type TokenIter = Peekable<proc_macro2::token_stream::IntoIter>;

pub(crate) fn consume_item_name(tokens: &mut TokenIter) -> Ident {
    parse_any_ident(tokens, "item")
}

pub(crate) fn consume_bound(
    tokens: &mut TokenIter,
    mut end_predicate: impl FnMut(&TokenTree) -> bool,
) -> Option<GenericBound> {
    match tokens.peek().unwrap() {
        TokenTree::Punct(punct) if punct.as_char() == ':' => {
            let colon = punct.clone();
            // consume ':'
            tokens.next();

            let bound_tokens = consume_stuff_until(tokens, end_predicate, false);

            Some(GenericBound {
                tk_colon: colon,
                tokens: bound_tokens,
            })
        }
        token if end_predicate(token) => None,
        token => {
            panic!("cannot parse generic bound: unexpected token {:?}", token)
        }
    }
}

pub(crate) fn consume_generic_params(tokens: &mut TokenIter) -> Option<GenericParamList> {
    let mut generic_params = Punctuated::new();

    let gt = consume_punct(tokens, '<')?;

    let lt: Punct;
    loop {
        let token = tokens
            .peek()
            .expect("cannot parse generic params: expected token after '<'");
        let prefix = match token {
            TokenTree::Punct(punct) if punct.as_char() == '>' => {
                lt = punct.clone();
                break;
            }
            TokenTree::Punct(punct) if punct.as_char() == '\'' => Some(tokens.next().unwrap()),
            TokenTree::Ident(ident) if ident == "const" => Some(tokens.next().unwrap()),
            TokenTree::Ident(_ident) => None,
            token => {
                panic!("cannot parse generic params: unexpected token {:?}", token)
            }
        };

        let name = parse_any_ident(tokens, "generic param name");

        let bound = consume_bound(
            tokens,
            |token| matches!(token, TokenTree::Punct(punct) if punct.as_char() == ',' || punct.as_char() == '>'),
        );
        let comma = consume_comma(tokens);

        generic_params.push(
            GenericParam {
                tk_prefix: prefix,
                name,
                bound,
            },
            comma,
        );
    }

    // consume '>'
    tokens.next();

    Some(GenericParamList {
        tk_l_bracket: gt,
        params: generic_params,
        tk_r_bracket: lt,
    })
}

fn parse_generic_arg(tokens: Vec<TokenTree>) -> GenericArg {
    // Note: method not called if tokens is empty
    let mut tokens = tokens.into_iter().peekable();

    if let Some(lifetime) = consume_lifetime(&mut tokens, true) {
        return GenericArg::Lifetime { lifetime };
    }

    // Then, try parsing Item = ...
    // (there is at least 1 token, so unwrap is safe)
    // TODO also handle generic bindings (eg `LendingIterator<Item<'_> = XXX>`)
    let before_ident = tokens.clone();
    if let TokenTree::Ident(ident) = tokens.next().unwrap() {
        if let Some(TokenTree::Punct(punct)) = tokens.next() {
            if punct.as_char() == '=' {
                let remaining: Vec<TokenTree> = tokens.collect();

                return GenericArg::Binding {
                    ident,
                    tk_equals: punct,
                    ty: TypeExpr { tokens: remaining },
                };
            }
        }
    }

    // Last, all the rest is just tokens
    let remaining: Vec<TokenTree> = before_ident.collect();

    GenericArg::TypeOrConst {
        expr: TypeExpr { tokens: remaining },
    }
}

pub(crate) fn consume_lifetime(
    tokens: &mut Peekable<impl Iterator<Item = TokenTree>>,
    expect_end: bool,
) -> Option<Lifetime> {
    // Try parsing 'lifetime
    let tk_apostrophe = match tokens.peek() {
        Some(TokenTree::Punct(punct)) if punct.as_char() == '\'' => {
            let apostrophe = punct.clone();
            tokens.next(); // consume '
            apostrophe
        }
        _ => return None,
    };

    // after the ', there must be a single identifier
    match tokens.next() {
        Some(TokenTree::Ident(name)) => {
            if expect_end {
                assert!(
                    tokens.next().is_none(),
                    "cannot parse lifetime generic argument"
                );
            }

            Some(Lifetime {
                tk_apostrophe,
                name,
            })
        }
        Some(other) => {
            panic!(
                "expected identifier after ' lifetime symbol, got {:?}",
                other
            );
        }
        None => {
            panic!("expected identifier after ' lifetime symbol, but ran out of tokens")
        }
    }
}

pub(crate) fn consume_generic_args(tokens: &mut TokenIter) -> Option<GenericArgList> {
    // TODO consider multiple-lookahead instead of potentially cloning many tokens
    let before_start = tokens.clone();
    let tk_turbofish_colons = consume_colon2(tokens);

    let tk_l_bracket = match tokens.peek() {
        Some(TokenTree::Punct(punct)) if punct.as_char() == '<' => {
            let gt = punct.clone();
            tokens.next();
            gt
        }
        _ => {
            *tokens = before_start;
            return None;
        }
    };

    let mut generic_args = Punctuated::new();
    loop {
        // Tokenize until next comma (skips nested <>)
        let arg_tokens = consume_stuff_until(
            tokens,
            |tk| matches!(tk, TokenTree::Punct(punct) if punct.as_char() == ','),
            false,
        );
        let comma = consume_comma(tokens);

        // Exit when end reached
        if arg_tokens.is_empty() {
            break;
        }

        generic_args.push(parse_generic_arg(arg_tokens), comma);
    }

    let tk_r_bracket = parse_punct(tokens, '>', "end of generic argument list");

    Some(GenericArgList {
        tk_turbofish_colons,
        tk_l_bracket,
        args: generic_args,
        tk_r_bracket,
    })
}

pub(crate) fn consume_where_clause(tokens: &mut TokenIter) -> Option<WhereClause> {
    let where_token = consume_ident(tokens, "where")?;

    let mut items = Punctuated::new();
    loop {
        let token = tokens
            .peek()
            .expect("cannot parse where clause: expected tokens");

        match token {
            TokenTree::Group(group) if group.delimiter() == Delimiter::Brace => break,
            TokenTree::Punct(punct) if punct.as_char() == ';' => break,
            _ => (),
        };

        let left_side = consume_stuff_until(
            tokens,
            |token| match token {
                TokenTree::Punct(punct) if punct.as_char() == ':' => true,
                _ => false,
            },
            false,
        );

        let colon = match tokens.next() {
            Some(TokenTree::Punct(punct)) if punct.as_char() == ':' => punct.clone(),
            Some(token) => panic!(
                "cannot parse where clause: expected ':', found token {:?}",
                token
            ),
            None => {
                panic!("cannot parse where clause: expected colon, found end of stream")
            }
        };
        let bound_tokens = consume_stuff_until(
            tokens,
            |token| match token {
                TokenTree::Punct(punct) if punct.as_char() == ',' => true,
                TokenTree::Group(group) if group.delimiter() == Delimiter::Brace => true,
                TokenTree::Punct(punct) if punct.as_char() == ';' => true,
                _ => false,
            },
            true,
        );

        let comma = consume_comma(tokens);

        items.push(
            WhereClausePredicate {
                left_side,
                bound: GenericBound {
                    tk_colon: colon,
                    tokens: bound_tokens,
                },
            },
            comma,
        );
    }

    Some(WhereClause {
        tk_where: where_token,
        items,
    })
}

pub(crate) fn consume_field_type(tokens: &mut TokenIter) -> Vec<TokenTree> {
    let field_type_tokens = consume_stuff_until(
        tokens,
        |token| match token {
            TokenTree::Punct(punct) if punct.as_char() == ',' => true,
            _ => false,
        },
        false,
    );

    if field_type_tokens.is_empty() && consume_comma(tokens).is_some() {
        panic!("cannot parse type: unexpected token ','");
    } else if field_type_tokens.is_empty() {
        panic!("cannot parse type: expected tokens, found end-of-stream");
    }

    field_type_tokens
}

pub(crate) fn consume_enum_discriminant(
    tokens: &mut TokenIter,
) -> Result<Option<EnumVariantValue>, Error> {
    let tk_equal = if let Some(token) = consume_punct(tokens, '=') {
        token
    } else {
        return Ok(None);
    };

    let value_token = tokens.next().unwrap();

    // If the value expression has more than one token, we output an error.
    match tokens.peek() {
        None => (),
        Some(TokenTree::Punct(punct)) if punct.as_char() == ',' => (),
        Some(_token) => {
            let span = value_token.span();
            return Err(Error::new_at_span(span,"Complex values for enum variants are not supported unless they are between parentheses."));
        }
    }

    Ok(Some(EnumVariantValue {
        tk_equal,
        value: value_token,
    }))
}

pub(crate) fn parse_tuple_fields(token_group: Group) -> TupleFields {
    let mut fields = Punctuated::new();

    let mut tokens = token_group.stream().into_iter().peekable();
    loop {
        if tokens.peek().is_none() {
            break;
        }

        let attributes = consume_outer_attributes(&mut tokens);
        let vis_marker = consume_vis_marker(&mut tokens);

        let ty_tokens = consume_field_type(&mut tokens);

        let comma = consume_comma(&mut tokens);

        fields.push(
            TupleField {
                attributes,
                vis_marker,
                ty: TypeExpr { tokens: ty_tokens },
            },
            comma,
        );
    }

    TupleFields {
        fields,
        tk_parens: GroupSpan::new(&token_group),
    }
}

pub(crate) fn parse_named_fields(token_group: Group) -> NamedFields {
    let mut fields = Punctuated::new();

    let mut tokens = token_group.stream().into_iter().peekable();
    loop {
        if tokens.peek().is_none() {
            break;
        }

        let attributes = consume_outer_attributes(&mut tokens);
        let vis_marker = consume_vis_marker(&mut tokens);

        let field_name = parse_any_ident(&mut tokens, "field name");
        let colon = parse_punct(&mut tokens, ':', "named fields");

        let ty_tokens = consume_field_type(&mut tokens);
        let comma = consume_comma(&mut tokens);

        fields.push(
            NamedField {
                attributes,
                vis_marker,
                name: field_name,
                tk_colon: colon,
                ty: TypeExpr { tokens: ty_tokens },
            },
            comma,
        );
    }

    NamedFields {
        fields,
        tk_braces: GroupSpan::new(&token_group),
    }
}

pub(crate) fn parse_enum_variants(tokens: TokenStream) -> Result<Punctuated<EnumVariant>, Error> {
    let mut variants = Punctuated::new();

    let mut tokens = tokens.into_iter().peekable();
    loop {
        if tokens.peek().is_none() {
            break;
        }

        let attributes = consume_outer_attributes(&mut tokens);
        let vis_marker = consume_vis_marker(&mut tokens);

        let variant_name = parse_any_ident(&mut tokens, "enum variant name");

        let contents = match tokens.peek() {
            None => Fields::Unit,
            Some(TokenTree::Punct(punct)) if punct.as_char() == ',' => Fields::Unit,
            Some(TokenTree::Punct(punct)) if punct.as_char() == '=' => Fields::Unit,
            Some(TokenTree::Group(group)) if group.delimiter() == Delimiter::Parenthesis => {
                let group = group.clone();
                // Consume group
                tokens.next();
                Fields::Tuple(parse_tuple_fields(group))
            }
            Some(TokenTree::Group(group)) if group.delimiter() == Delimiter::Brace => {
                let group = group.clone();
                // Consume group
                tokens.next();
                Fields::Named(parse_named_fields(group))
            }
            token => panic!("cannot parse enum variant: unexpected token {:?}", token),
        };

        let enum_discriminant = consume_enum_discriminant(&mut tokens);

        let comma = consume_comma(&mut tokens);

        variants.push(
            EnumVariant {
                attributes,
                vis_marker,
                name: variant_name,
                fields: contents,
                value: enum_discriminant?,
            },
            comma,
        );
    }

    Ok(variants)
}