ress 0.11.7

A scanner/tokenizer for JS files
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
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
use crate::tokenizer::{RawKeyword, RawToken, Res, Tokenizer};

type MaybeKeyword = Res<Option<RawToken>>;

impl<'a> Tokenizer<'a> {
    /// Detect if an ident is a keyword starting from and id_start
    /// character
    ///
    /// note: the expectation of the start char is that if it were a
    /// unicode escape, it would already have been parsed to its approprate
    /// character
    pub(crate) fn keyword(&mut self, start: char) -> MaybeKeyword {
        match start {
            'a' => self.a_keywords(),
            'b' => self.b_keywords(),
            'c' => self.c_keywords(),
            'd' => self.d_keywords(),
            'e' => self.e_keywords(),
            'f' => self.f_keywords(),
            'i' => self.i_keywords(),
            'l' => self.l_keywords(),
            'n' => self.n_keywords(),
            'p' => self.p_keywords(),
            'r' => self.r_keywords(),
            's' => self.s_keywords(),
            't' => self.t_keywords(),
            'v' => self.v_keywords(),
            'w' => self.w_keywords(),
            'y' => self.y_keywords(),
            _ => Ok(None),
        }
    }
    /// attempt to parse `await`
    fn a_keywords(&mut self) -> MaybeKeyword {
        self.suffix_for_token("wait", RawToken::Keyword(RawKeyword::Await))
    }
    /// attempt to parse `break`
    fn b_keywords(&mut self) -> MaybeKeyword {
        self.suffix_for_token("reak", RawToken::Keyword(RawKeyword::Break))
    }
    /// attempt to parse `case`, `catch`, `class`, `const` or
    /// `continue`
    fn c_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('a')? {
            if self.eat_ch_or_escaped('s')? {
                self.suffix_for_token("e", RawToken::Keyword(RawKeyword::Case))
            } else if self.eat_ch_or_escaped('t')? {
                self.suffix_for_token("ch", RawToken::Keyword(RawKeyword::Catch))
            } else {
                Ok(None)
            }
        } else if self.eat_ch_or_escaped('l')? {
            self.suffix_for_token("ass", RawToken::Keyword(RawKeyword::Class))
        } else if self.eat_ch_or_escaped('o')? && self.eat_ch_or_escaped('n')? {
            if self.eat_ch_or_escaped('s')? {
                self.suffix_for_token("t", RawToken::Keyword(RawKeyword::Const))
            } else if self.eat_ch_or_escaped('t')? {
                self.suffix_for_token("inue", RawToken::Keyword(RawKeyword::Continue))
            } else {
                Ok(None)
            }
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `debugger`, `default`, `delete` or `do`
    fn d_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('e')? {
            if self.eat_ch_or_escaped('b')? {
                self.suffix_for_token("ugger", RawToken::Keyword(RawKeyword::Debugger))
            } else if self.eat_ch_or_escaped('f')? {
                self.suffix_for_token("ault", RawToken::Keyword(RawKeyword::Default))
            } else if self.eat_ch_or_escaped('l')? {
                self.suffix_for_token("ete", RawToken::Keyword(RawKeyword::Delete))
            } else {
                Ok(None)
            }
        } else if self.eat_ch_or_escaped('o')? && self.at_ident_end() {
            Ok(Some(RawToken::Keyword(RawKeyword::Do)))
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `else`, `enum`, `export`, or `extends`
    fn e_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('l')? {
            self.suffix_for_token("se", RawToken::Keyword(RawKeyword::Else))
        } else if self.eat_ch_or_escaped('n')? {
            self.suffix_for_token("um", RawToken::Keyword(RawKeyword::Enum))
        } else if self.eat_ch_or_escaped('x')? {
            if self.eat_ch_or_escaped('p')? {
                self.suffix_for_token("ort", RawToken::Keyword(RawKeyword::Export))
            } else if self.eat_ch_or_escaped('t')? {
                self.suffix_for_token("ends", RawToken::Keyword(RawKeyword::Extends))
            } else {
                Ok(None)
            }
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `false`, `finally`, `for` or `function`
    fn f_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('a')? {
            self.suffix_for_token("lse", RawToken::Boolean(false))
        } else if self.eat_ch_or_escaped('i')? {
            self.suffix_for_token("nally", RawToken::Keyword(RawKeyword::Finally))
        } else if self.eat_ch_or_escaped('o')? {
            self.suffix_for_token("r", RawToken::Keyword(RawKeyword::For))
        } else if self.eat_ch_or_escaped('u')? {
            self.suffix_for_token("nction", RawToken::Keyword(RawKeyword::Function))
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `if`, `implements`, `import`, `in`, `instanceof`,
    /// or `interface`
    fn i_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('f')? && self.at_ident_end() {
            Ok(Some(RawToken::Keyword(RawKeyword::If)))
        } else if self.eat_ch_or_escaped('m')? && self.eat_ch_or_escaped('p')? {
            if self.eat_ch_or_escaped('l')? {
                self.suffix_for_token("ements", RawToken::Keyword(RawKeyword::Implements))
            } else if self.eat_ch_or_escaped('o')? {
                self.suffix_for_token("rt", RawToken::Keyword(RawKeyword::Import))
            } else {
                Ok(None)
            }
        } else if self.eat_ch_or_escaped('n')? {
            if self.eat_ch_or_escaped('s')? {
                self.suffix_for_token("tanceof", RawToken::Keyword(RawKeyword::InstanceOf))
            } else if self.eat_ch_or_escaped('t')? {
                self.suffix_for_token("erface", RawToken::Keyword(RawKeyword::Interface))
            } else if self.at_ident_end() {
                Ok(Some(RawToken::Keyword(RawKeyword::In)))
            } else {
                Ok(None)
            }
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `let`
    fn l_keywords(&mut self) -> MaybeKeyword {
        self.suffix_for_token("et", RawToken::Keyword(RawKeyword::Let))
    }
    /// attempt to parse `new` or `null`
    fn n_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('e')? {
            self.suffix_for_token("w", RawToken::Keyword(RawKeyword::New))
        } else if self.eat_ch_or_escaped('u')? {
            self.suffix_for_token("ll", RawToken::Null)
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `package`, `private`, `protected`, or
    /// `public`,
    fn p_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('a')? {
            self.suffix_for_token("ckage", RawToken::Keyword(RawKeyword::Package))
        } else if self.eat_ch_or_escaped('r')? {
            if self.eat_ch_or_escaped('i')? {
                self.suffix_for_token("vate", RawToken::Keyword(RawKeyword::Private))
            } else if self.eat_ch_or_escaped('o')? {
                self.suffix_for_token("tected", RawToken::Keyword(RawKeyword::Protected))
            } else {
                Ok(None)
            }
        } else if self.eat_ch_or_escaped('u')? {
            self.suffix_for_token("blic", RawToken::Keyword(RawKeyword::Public))
        } else {
            Ok(None)
        }
    }

    fn r_keywords(&mut self) -> MaybeKeyword {
        self.suffix_for_token("eturn", RawToken::Keyword(RawKeyword::Return))
    }
    /// attempt to parse `static`, `super`, or `switch`
    fn s_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('t')? {
            self.suffix_for_token("atic", RawToken::Keyword(RawKeyword::Static))
        } else if self.eat_ch_or_escaped('u')? {
            self.suffix_for_token("per", RawToken::Keyword(RawKeyword::Super))
        } else if self.eat_ch_or_escaped('w')? {
            self.suffix_for_token("itch", RawToken::Keyword(RawKeyword::Switch))
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `this`, `throw`, `true`,
    /// `try`, or `typeof`
    fn t_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('h')? {
            if self.eat_ch_or_escaped('i')? {
                self.suffix_for_token("s", RawToken::Keyword(RawKeyword::This))
            } else if self.eat_ch_or_escaped('r')? {
                self.suffix_for_token("ow", RawToken::Keyword(RawKeyword::Throw))
            } else {
                Ok(None)
            }
        } else if self.eat_ch_or_escaped('r')? {
            if self.eat_ch_or_escaped('u')? {
                self.suffix_for_token("e", RawToken::Boolean(true))
            } else if self.eat_ch_or_escaped('y')? && self.at_ident_end() {
                Ok(Some(RawToken::Keyword(RawKeyword::Try)))
            } else {
                Ok(None)
            }
        } else if self.eat_ch_or_escaped('y')? {
            self.suffix_for_token("peof", RawToken::Keyword(RawKeyword::TypeOf))
        } else {
            Ok(None)
        }
    }
    /// ttempt to parse `var` or `void`,
    fn v_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('a')? {
            self.suffix_for_token("r", RawToken::Keyword(RawKeyword::Var))
        } else if self.eat_ch_or_escaped('o')? {
            self.suffix_for_token("id", RawToken::Keyword(RawKeyword::Void))
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `while` or `with`
    fn w_keywords(&mut self) -> MaybeKeyword {
        if self.eat_ch_or_escaped('h')? {
            self.suffix_for_token("ile", RawToken::Keyword(RawKeyword::While))
        } else if self.eat_ch_or_escaped('i')? {
            self.suffix_for_token("th", RawToken::Keyword(RawKeyword::With))
        } else {
            Ok(None)
        }
    }
    /// attempt to parse `yield`
    fn y_keywords(&mut self) -> MaybeKeyword {
        self.suffix_for_token("ield", RawToken::Keyword(RawKeyword::Yield))
    }
    /// This will attempt to consumer the suffix, if successful and
    /// the stream is at the end of an identifier, it will return
    /// the `tok` provided
    ///
    /// This is useful for when we have reached a leaf on a trie
    fn suffix_for_token(&mut self, suffix: &str, tok: RawToken) -> MaybeKeyword {
        if self.eat_chs_or_escaped(suffix)? {
            if self.at_ident_end() {
                Ok(Some(tok))
            } else {
                Ok(None)
            }
        } else {
            Ok(None)
        }
    }
    /// Test if the stream has moved past the end of an identifier
    fn at_ident_end(&mut self) -> bool {
        if self.look_ahead_matches(r"\u") {
            false
        } else if let Some(c) = self.stream.next_char() {
            if !Self::is_id_continue(c) && c != '\u{200C}' && c != '\u{200D}' {
                let _ = self.stream.prev_char();
                true
            } else {
                false
            }
        } else {
            true
        }
    }
    /// If the characters in the provided &str matche the look ahead _bytes_
    /// or a unicode escape of the characters, it will move
    /// the stream's index forward to the approrate position
    /// it will stop moving forward after at the first failed
    /// match (this means it will consume any leading positive matches)
    ///
    /// note: the character provided must be an ascii character
    /// to get a positive match
    fn eat_chs_or_escaped(&mut self, chars: &str) -> Res<bool> {
        for c in chars.chars() {
            if !self.eat_ch_or_escaped(c)? {
                return Ok(false);
            }
        }
        Ok(true)
    }
    /// If the character provided matches the look ahead _byte_
    /// or a unicode escape of the character, it will move
    /// the stream's index forward to the approrate position
    ///
    /// note: the character provided must be an ascii character
    /// to get a positive match
    pub(crate) fn eat_ch_or_escaped(&mut self, ch: char) -> Res<bool> {
        debug_assert!(
            ch.len_utf8() == 1,
            "cannot use eat_ch_or_escaped with characters larger than 1 byte wide"
        );
        Ok(if self.look_ahead_byte_matches(ch) {
            self.stream.skip_bytes(1);
            true
        } else if self.look_ahead_matches("\\u") {
            let start = self.stream.idx;
            self.stream.skip_bytes(1); // skip the slash only
            let c = self.escaped_ident_part()?;
            if c != ch {
                self.stream.idx = start;
                false
            } else {
                true
            }
        } else {
            false
        })
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn keyword_await() {
        test_with_escapes("await", RawToken::Keyword(RawKeyword::Await));
    }

    #[test]
    fn keyword_break() {
        test_with_escapes("break", RawToken::Keyword(RawKeyword::Break));
    }

    #[test]
    fn keyword_case() {
        test_with_escapes("case", RawToken::Keyword(RawKeyword::Case));
    }

    #[test]
    fn keyword_catch() {
        test_with_escapes("catch", RawToken::Keyword(RawKeyword::Catch));
    }
    #[test]
    fn keyword_const() {
        test_with_escapes("const", RawToken::Keyword(RawKeyword::Const));
    }
    #[test]
    fn keyword_continue() {
        test_with_escapes("continue", RawToken::Keyword(RawKeyword::Continue));
    }
    #[test]
    fn keyword_class() {
        test_with_escapes("class", RawToken::Keyword(RawKeyword::Class));
    }
    #[test]
    fn keyword_debugger() {
        test_with_escapes("debugger", RawToken::Keyword(RawKeyword::Debugger));
    }
    #[test]
    fn keyword_default() {
        test_with_escapes("default", RawToken::Keyword(RawKeyword::Default));
    }
    #[test]
    fn keyword_delete() {
        test_with_escapes("delete", RawToken::Keyword(RawKeyword::Delete));
    }
    #[test]
    fn keyword_do() {
        test_with_escapes("do", RawToken::Keyword(RawKeyword::Do));
    }

    #[test]
    fn keyword_else() {
        test_with_escapes("else", RawToken::Keyword(RawKeyword::Else));
    }
    #[test]
    fn keyword_enum() {
        test_with_escapes("enum", RawToken::Keyword(RawKeyword::Enum));
    }
    #[test]
    fn keyword_export() {
        test_with_escapes("export", RawToken::Keyword(RawKeyword::Export));
    }
    #[test]
    fn keyword_extends() {
        test_with_escapes("extends", RawToken::Keyword(RawKeyword::Extends));
    }
    #[test]
    fn keyword_false() {
        test_with_escapes("false", RawToken::Boolean(false));
    }
    #[test]
    fn keyword_finally() {
        test_with_escapes("finally", RawToken::Keyword(RawKeyword::Finally));
    }
    #[test]
    fn keyword_for() {
        test_with_escapes("for", RawToken::Keyword(RawKeyword::For));
    }
    #[test]
    fn keyword_function() {
        test_with_escapes("function", RawToken::Keyword(RawKeyword::Function));
    }
    #[test]
    fn keyword_if() {
        test_with_escapes("if", RawToken::Keyword(RawKeyword::If));
    }
    #[test]
    fn keyword_implements() {
        test_with_escapes("implements", RawToken::Keyword(RawKeyword::Implements));
    }
    #[test]
    fn keyword_import() {
        test_with_escapes("import", RawToken::Keyword(RawKeyword::Import));
    }
    #[test]
    fn keyword_in() {
        test_with_escapes("in", RawToken::Keyword(RawKeyword::In));
    }
    #[test]
    fn keyword_instance_of() {
        test_with_escapes("instanceof", RawToken::Keyword(RawKeyword::InstanceOf));
    }
    #[test]
    fn keyword_interface() {
        test_with_escapes("interface", RawToken::Keyword(RawKeyword::Interface));
    }
    #[test]
    fn keyword_let() {
        test_with_escapes("let", RawToken::Keyword(RawKeyword::Let));
    }
    #[test]
    fn keyword_new() {
        test_with_escapes("new", RawToken::Keyword(RawKeyword::New));
    }
    #[test]
    fn keyword_null() {
        test_with_escapes("null", RawToken::Null);
    }
    #[test]
    fn keyword_package() {
        test_with_escapes("package", RawToken::Keyword(RawKeyword::Package));
    }
    #[test]
    fn keyword_private() {
        test_with_escapes("private", RawToken::Keyword(RawKeyword::Private));
    }
    #[test]
    fn keyword_protected() {
        test_with_escapes("protected", RawToken::Keyword(RawKeyword::Protected));
    }
    #[test]
    fn keyword_public() {
        test_with_escapes("public", RawToken::Keyword(RawKeyword::Public));
    }
    #[test]
    fn keyword_return() {
        test_with_escapes("return", RawToken::Keyword(RawKeyword::Return));
    }
    #[test]
    fn keyword_static() {
        test_with_escapes("static", RawToken::Keyword(RawKeyword::Static));
    }
    #[test]
    fn keyword_super() {
        test_with_escapes("super", RawToken::Keyword(RawKeyword::Super));
    }
    #[test]
    fn keyword_switch() {
        test_with_escapes("switch", RawToken::Keyword(RawKeyword::Switch));
    }
    #[test]
    fn keyword_this() {
        test_with_escapes("this", RawToken::Keyword(RawKeyword::This));
    }
    #[test]
    fn keyword_throw() {
        test_with_escapes("throw", RawToken::Keyword(RawKeyword::Throw));
    }
    #[test]
    fn keyword_true() {
        test_with_escapes("true", RawToken::Boolean(true));
    }
    #[test]
    fn keyword_try() {
        test_with_escapes("try", RawToken::Keyword(RawKeyword::Try));
    }
    #[test]
    fn keyword_type_of() {
        test_with_escapes("typeof", RawToken::Keyword(RawKeyword::TypeOf));
    }
    #[test]
    fn keyword_var() {
        test_with_escapes("var", RawToken::Keyword(RawKeyword::Var));
    }
    #[test]
    fn keyword_void() {
        test_with_escapes("void", RawToken::Keyword(RawKeyword::Void));
    }
    #[test]
    fn keyword_while() {
        test_with_escapes("while", RawToken::Keyword(RawKeyword::While));
    }
    #[test]
    fn keyword_with() {
        test_with_escapes("with", RawToken::Keyword(RawKeyword::With));
    }
    #[test]
    fn keyword_yield() {
        test_with_escapes("yield", RawToken::Keyword(RawKeyword::Yield));
    }

    fn test_with_escapes(k: &str, expect: RawToken) {
        let start = k.chars().next().expect("empty keyword");
        let first = test_keyword(start, k)
            .unwrap_or_else(|e| panic!("failed to parse {}: {}", k, e))
            .unwrap_or_else(|| panic!("failed to parse {}", k));
        assert_eq!(first, expect);
        let mut escape_char_code;
        let mut escape_code_points;
        for i in 0..k.chars().count() {
            escape_char_code = String::new();
            escape_code_points = String::new();
            for (j, c) in k.chars().enumerate() {
                if j == i {
                    escape_char_code.push_str(&format!(r#"\u{:04X}"#, c as u8));
                    escape_code_points.push_str(&format!(r#"\u{{{:06X}}}"#, c as u8));
                } else {
                    escape_char_code.push(c);
                    escape_code_points.push(c);
                }
            }
            let second = test_keyword(start, &escape_char_code)
                .unwrap_or_else(|e| {
                    panic!(
                        "failed to parse escaped keyword {}: {}",
                        escape_char_code, e
                    )
                })
                .unwrap_or_else(|| panic!("failed to parse escaped keyword {}", escape_char_code));
            assert_eq!(
                second, expect,
                "{} doesn't match expected keyword",
                escape_char_code
            );
            let third = test_keyword(start, &escape_code_points)
                .unwrap_or_else(|e| {
                    panic!(
                        "failed to parse escaped keyword {}: {}",
                        escape_code_points, e
                    )
                })
                .unwrap_or_else(|| {
                    panic!("failed to parse escaped keyword {}", escape_code_points)
                });
            assert_eq!(
                third, expect,
                "{} doesn't match expected keyword",
                escape_code_points
            );
        }
        let not = format!("{}_not", k);
        assert_eq!(
            test_keyword(start, &not)
                .unwrap_or_else(|e| panic!("Failed to parse not keyword {}: {}", not, e)),
            None
        );
    }

    fn test_keyword(start: char, k: &str) -> MaybeKeyword {
        dbg!(start);
        dbg!(k);
        let mut t = Tokenizer::new(k);
        assert!(
            t.eat_ch_or_escaped(start)?,
            "start didn't match first character {}, {}",
            start,
            k
        );
        t.keyword(start)
    }
}