herring-derive 0.1.2

Macro implementation of #[derive(Herring)]
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
use crate::parse::*;
use herring_automata::{Dfa, Nfa, Output, Pattern, State, StateRef, Transition};
use proc_macro2::{Span, TokenStream};
use quote::quote;
use std::collections::{BTreeMap, HashMap};
use syn::{Error, Expr, Ident};

pub(crate) const SKIP_NAME: &str = "skipped regex";

fn generate_dfa(tokens: Vec<herring_automata::Token>, enum_name: &Ident) -> syn::Result<Dfa> {
    let nfa = Nfa::new_tokenizer(tokens);
    crate::debug::graph(&nfa, &format!("{enum_name}_nfa"))?;

    let subset_dfa = match nfa.into_dfa() {
        Ok(dfa) => dfa,
        Err(err) => return Err(Error::new(Span::call_site(), err.message)),
    };
    crate::debug::graph(&subset_dfa, &format!("{enum_name}_dfa"))?;

    let minimal_dfa = subset_dfa.into_minimized();
    crate::debug::graph(&minimal_dfa, &format!("{enum_name}_min"))?;

    Ok(minimal_dfa)
}

macro_rules! ident {
    ($fmt:literal) => {
        Ident::new(&format!($fmt), Span::call_site())
    };
    ($fmt:literal, $($args:expr),*) => {
        Ident::new(&format!($fmt, $($args),*), Span::call_site())
    };
    ($s:expr) => {
        Ident::new(&$s, Span::call_site())
    };
}

fn generate_stacked_lut_pattern<'a>(
    pattern: &'a Pattern,
    luts: &mut BTreeMap<&'a Pattern, usize>,
) -> TokenStream {
    let index = if let Some(index) = luts.get(pattern) {
        *index
    } else {
        let index = luts.len();
        luts.insert(pattern, index);
        index
    };
    let lut_ident = ident!("LUT{}", index / 8);
    let mask = 1u8 << (index % 8);

    quote! { Some(b) if #lut_ident[b as usize] & #mask > 0 }
}

fn generate_byte_pattern(pattern: &Pattern) -> TokenStream {
    let mut ranges = vec![];
    for r in pattern.ranges().iter() {
        let start = r.start();
        let end = r.end();
        if start == end {
            ranges.push(quote! { #start });
        } else {
            ranges.push(quote! { #start ..= #end });
        }
    }
    quote! { Some(#(#ranges)|*) }
}

fn generate_pattern<'a>(
    transition: &'a Transition,
    luts: &mut BTreeMap<&'a Pattern, usize>,
) -> TokenStream {
    let range_count = transition
        .when()
        .ranges()
        .iter()
        .filter(|r| r.start() != r.end())
        .count();
    let single_count = transition
        .when()
        .ranges()
        .iter()
        .filter(|r| r.start() == r.end())
        .count();
    if range_count > 1 || (range_count == 1 && single_count > 0) {
        generate_stacked_lut_pattern(transition.when(), luts)
    } else {
        generate_byte_pattern(transition.when())
    }
}

fn generate_eof_jump(dfa: &Dfa, state_ref: StateRef) -> TokenStream {
    if dfa.start() == state_ref {
        quote! {
            lexer.offset -= 1;
            return None;
        }
    } else {
        quote! {
            lexer.offset -= 1;
            break 'fsm;
        }
    }
}

fn generate_state_jump(state_ref: StateRef, transition: &Transition) -> TokenStream {
    if transition.to() == state_ref {
        quote! { continue; }
    } else {
        let next_state = ident!("S{}", transition.to().value());
        quote! {
            state = State::#next_state;
            continue 'fsm;
        }
    }
}

fn generate_pattern_transitions<'a>(
    dfa: &'a Dfa,
    state_ref: StateRef,
    state: &'a State,
    luts: &mut BTreeMap<&'a Pattern, usize>,
) -> TokenStream {
    let mut transitions = vec![];
    for transition in state.transitions().iter() {
        let condition = generate_pattern(transition, luts);
        let jump = generate_state_jump(state_ref, transition);
        transitions.push(quote! {
           #condition => {
               #jump
           }
        });
    }
    let eof_jump = generate_eof_jump(dfa, state_ref);
    transitions.push(quote! { None => { #eof_jump } });
    quote! {
        match lexer.next_byte() {
            #(#transitions)*
            _ => {
                let offset = lexer.offset - 1;
                if offset != lexer.start {
                    lexer.offset = offset;
                }
                break 'fsm;
            }
        }
    }
}

fn generate_lut_transitions(dfa: &Dfa, state_ref: StateRef, state: &State) -> TokenStream {
    let mut entries = vec![];
    'outer: for b in u8::MIN..=u8::MAX {
        for t in state.transitions().iter() {
            if t.when().contains(b) {
                let ident = ident!("J{}", t.to().value());
                entries.push(quote! { #ident });
                continue 'outer;
            }
        }
        entries.push(quote! { __ });
    }
    let eof_jump = generate_eof_jump(dfa, state_ref);
    let mut targets = vec![];
    let mut jumps = vec![];
    for transition in state.transitions().iter() {
        targets.push(ident!("J{}", transition.to().value()));
        jumps.push(generate_state_jump(state_ref, transition));
    }
    quote! {
        #[derive(Clone, Copy)]
        enum Jumps {
            #(#targets,)*
            __,
        }
        const LUT: [Jumps; 256] = {
            use Jumps::*;
            [
                #(#entries),*
            ]
        };
        if let Some(byte) = lexer.next_byte() {
            match LUT[byte as usize] {
                #(Jumps::#targets => {
                    #jumps
                })*
                Jumps::__ => {
                    let offset = lexer.offset - 1;
                    if offset != lexer.start {
                        lexer.offset = offset;
                    }
                    break 'fsm;
                }
            }
        }
        #eof_jump
    }
}

fn generate_transitions<'a>(
    dfa: &'a Dfa,
    state_ref: StateRef,
    state: &'a State,
    luts: &mut BTreeMap<&'a Pattern, usize>,
) -> TokenStream {
    if state.transitions().len() >= 3
        && state
            .transitions()
            .iter()
            .any(|t| t.when().ranges().iter().any(|p| p.start() != p.end()))
    {
        generate_lut_transitions(dfa, state_ref, state)
    } else {
        generate_pattern_transitions(dfa, state_ref, state, luts)
    }
}

fn generate_callback_def(
    enum_name: &Ident,
    output: &Option<Output>,
    callbacks: &HashMap<(String, usize), Expr>,
    is_skip: bool,
) -> TokenStream {
    if let Some(output) = output {
        if let Some(callback) = callbacks.get(output.value()) {
            return if is_skip {
                quote! {
                    let callback: fn(&mut herring::Lexer<'source, #enum_name>) = #callback;
                }
            } else {
                quote! {
                    let callback: fn(
                        &mut herring::Lexer<'source, #enum_name>
                    ) -> Result<#enum_name, <Self as Herring<'source>>::Error> = #callback;
                }
            };
        }
    }
    quote! {}
}

fn generate_last_accept(
    callback_def: &TokenStream,
    output: &Option<Output>,
    enum_name: &Ident,
    is_skip: bool,
) -> TokenStream {
    if let Some(output) = output {
        if callback_def.is_empty() {
            if is_skip {
                quote! { last_accept = LastAccept::Skip(lexer.offset); }
            } else {
                let enumerator = ident!(output.value().0);
                quote! { last_accept = LastAccept::Token(#enum_name::#enumerator, lexer.offset); }
            }
        } else if is_skip {
            quote! { last_accept = LastAccept::SkipCallback(callback, lexer.offset); }
        } else {
            quote! { last_accept = LastAccept::TokenCallback(callback, lexer.offset); }
        }
    } else {
        quote! {}
    }
}

fn generate_final_state_branch(
    enum_name: &Ident,
    output: &Output,
    callback_def: TokenStream,
    is_skip: bool,
    state_ident: Ident,
    log_state: TokenStream,
) -> TokenStream {
    let jump = if callback_def.is_empty() {
        if is_skip {
            quote! { continue 'skip; }
        } else {
            let enumerator = ident!(output.value().0);
            quote! { return Some(Ok(#enum_name::#enumerator)); }
        }
    } else if is_skip {
        quote! {
            callback(lexer);
            continue 'skip;
        }
    } else {
        quote! { return Some(callback(lexer)); }
    };
    quote! {
        State::#state_ident => {
            #callback_def
            #log_state
            #jump
        }
    }
}

fn generate_state_branches<'a>(
    dfa: &'a Dfa,
    enum_name: &Ident,
    callbacks: HashMap<(String, usize), Expr>,
    luts: &mut BTreeMap<&'a Pattern, usize>,
) -> syn::Result<Vec<TokenStream>> {
    let mut branches = vec![];
    for (num, state) in dfa.states().iter().enumerate() {
        let state_ref = StateRef::new(num);
        let state_ident = ident!("S{num}");
        let log_state = crate::debug::log_state(num);
        let output = dfa.accepts().get(&state_ref).unwrap_or(&None);
        let is_skip = output
            .as_ref()
            .is_some_and(|output| output.value().0 == SKIP_NAME);
        let callback_def = generate_callback_def(enum_name, output, &callbacks, is_skip);

        branches.push(if !state.transitions().is_empty() {
            let last_accept = generate_last_accept(&callback_def, output, enum_name, is_skip);
            let transitions = generate_transitions(dfa, state_ref, state, luts);
            let loop_edge = if state.transitions().iter().any(|t| t.to() == state_ref) {
                quote! { loop }
            } else {
                quote! {}
            };
            quote! {
                State::#state_ident => {
                    #callback_def
                    #loop_edge {
                        #log_state
                        #last_accept
                        #transitions
                    }
                }
            }
        } else if let Some(output) = output {
            generate_final_state_branch(
                enum_name,
                output,
                callback_def,
                is_skip,
                state_ident,
                log_state,
            )
        } else {
            panic!("non-accepting state has no outgoing transitions, please report this bug")
        });
    }
    Ok(branches)
}

fn generate_stacked_lut_defs(luts: BTreeMap<&Pattern, usize>) -> Vec<TokenStream> {
    let mut lut_defs = vec![];
    let mut tables = vec![[0u8; 256]; (luts.len() + 7) / 8];
    for patterns in luts.into_iter().collect::<Vec<_>>().chunks(8) {
        for (p, i) in patterns.iter() {
            for b in u8::MIN..=u8::MAX {
                tables[i / 8][b as usize] |= if p.contains(b) { 1 << (i % 8) } else { 0 };
            }
        }
    }
    for (num, table) in tables.into_iter().enumerate() {
        let lut_ident = ident!("LUT{num}");
        lut_defs.push(quote! { const #lut_ident: [u8; 256] = [ #(#table),* ]; });
    }
    lut_defs
}

pub(crate) fn generate_impl(tokens: TokenStream) -> syn::Result<TokenStream> {
    let token_enum = parse_enum(tokens)?;
    let enum_name = token_enum.name;
    let enum_attrs = token_enum.attrs;
    let enum_variants = token_enum.variants;
    let dfa = generate_dfa(enum_variants.tokens, &enum_name)?;

    let states = (0..dfa.states().len())
        .map(|i| {
            let state = ident!("S{i}");
            quote! { #state }
        })
        .collect::<Vec<_>>();

    let mut luts = BTreeMap::new();
    let branches = generate_state_branches(&dfa, &enum_name, enum_variants.callbacks, &mut luts)?;

    let lut_defs = generate_stacked_lut_defs(luts);
    let ignore_call = enum_attrs.ignore_cb.map_or(quote! {}, |callback| {
        quote! {
            use herring::Source;
            let callback: fn(&mut herring::Lexer<'source, #enum_name>) = #callback;
            callback(lexer)
        }
    });
    let initial_call = enum_attrs.initial_cb.map_or(quote! {}, |callback| {
        quote! {
            let callback: fn(
                &mut herring::Lexer<'source, #enum_name>
            ) -> Option<Result<#enum_name, <Self as Herring<'source>>::Error>> = #callback;
            if let Some(tok) = callback(lexer) {
                return Some(tok);
            }
        }
    });
    let (error_ty, extras_ty, source_ty) = (
        enum_attrs.error_ty,
        enum_attrs.extras_ty,
        syn::Type::Verbatim(if enum_attrs.source_ty.is_empty() {
            if token_enum.binary {
                quote! { &'source [u8] }
            } else {
                quote! { &'source str }
            }
        } else {
            enum_attrs.source_ty
        }),
    );
    let lexer_impl = quote! {
        #[allow(dead_code, unused_imports, unused_labels, clippy::type_complexity)]
        impl<'source> Herring<'source> for #enum_name {
            type Error = #error_ty;
            type Extras = #extras_ty;
            type Source = #source_ty;

            #[inline]
            fn ignore(lexer: &mut herring::Lexer<'source, #enum_name>) { #ignore_call }
            #[inline]
            fn lex(
                lexer: &mut herring::Lexer<'source, #enum_name>
            ) -> Option<Result<#enum_name, <Self as Herring<'source>>::Error>> {
                enum LastAccept<TokenCallback, SkipCallback> {
                    None,
                    Token(#enum_name, usize),
                    TokenCallback(TokenCallback, usize),
                    Skip(usize),
                    SkipCallback(SkipCallback, usize),
                }
                enum State {
                    #(#states,)*
                }
                #(#lut_defs)*

                'skip: loop {
                    lexer.start = lexer.offset;
                    #initial_call

                    let mut state = State::S0;
                    let mut last_accept: LastAccept<
                        fn(
                            &mut herring::Lexer<'source, #enum_name>
                        ) -> Result<#enum_name, <Self as Herring<'source>>::Error>,
                        fn(&mut herring::Lexer<'source, #enum_name>)
                    > = LastAccept::None;
                    'fsm: loop {
                        match state {
                            #(#branches)*
                        }
                    }
                    match last_accept {
                        LastAccept::None => {
                            use herring::Source;
                            while !lexer.source.is_boundary(lexer.offset) {
                                lexer.offset += 1;
                            }
                            return Some(Err(Default::default()));
                        }
                        LastAccept::Token(token, offset) => {
                            lexer.offset = offset;
                            return Some(Ok(token));
                        }
                        LastAccept::TokenCallback(callback, offset) => {
                            lexer.offset = offset;
                            return Some(callback(lexer));
                        }
                        LastAccept::Skip(offset) => {
                            lexer.offset = offset;
                        }
                        LastAccept::SkipCallback(callback, offset) => {
                            lexer.offset = offset;
                            callback(lexer);
                        }
                    }
                }
            }
        }
    };
    crate::debug::expand_or_skip(lexer_impl, &enum_name)
}