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
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
// What: `use resharp::Regex;` imports the resharp regex type.
// Used inside `load_ruleset` for the (smaller) regex bucket
// on rules that use set-algebra; rules without set-algebra
// go through the `regex` crate via `CompiledRegex::Plain`.
// Why: Hybrid engine dispatch: this module owns the per-rule
// routing decision via `requires_resharp`.
// TS map: `import { Regex } from "resharp";`.
//
// In TS you'd write (pseudocode):
// ```ts
// import { Regex } from "resharp";
// ```
use Regex;
// What: `use std::panic::{catch_unwind, AssertUnwindSafe};` brings
// the panic-recovery primitives into scope for the
// compile-time wrap on `Regex::new`. Full primer at the
// same import in `src/rules/engine.rs`. Short version:
// `catch_unwind(closure)` runs the closure with an unwind
// barrier; an inner `panic!` becomes the outer `Err` arm
// instead of propagating through the call stack.
// `AssertUnwindSafe(...)` asserts to the compiler that
// the captures are sound across the panic boundary --
// `&str` already is `UnwindSafe`, but `catch_unwind` still
// wants the wrapper at the closure boundary for the
// future-`Send` requirement, so we keep the symmetric
// shape with `engine.rs`.
// Why: Resharp 0.5.x through 0.6.x `Regex::new` panics on some
// rule shapes the fuzzer discovered (e.g. `(?:\w|$)(?:(?![1g]
// \_X)& a)` triggers an arithmetic overflow inside
// resharp-algebra's `attempt_rw_concat_2` at
// `resharp-algebra/src/lib.rs:2470`; verified unchanged
// between 0.5.3 and 0.6.0 by `/tmp/probe-resharp-06`).
// Without `catch_unwind` the
// panic aborts the scanner process during the parallel
// regex-compile phase, taking every other in-flight
// compile down with it. With `catch_unwind` the bad rule
// returns a normal `Err(String)` that the loader bubbles
// up to the user with the same `rule on line N (resharp): ...`
// prefix as every other compile failure.
// TS map: `try { ... } catch (e) { ... }`.
//
// In TS you'd write (pseudocode):
// ```ts
// // No equivalent. Rust requires catch_unwind + AssertUnwindSafe to
// // intercept panics across a closure boundary.
// ```
use ;
// What: `use super::{...};` imports helpers re-exported by the
// parent `rules` module. `super` means "the module above
// this one".
// Why: The compile pipeline applies engine routing and every
// structural pre-validator before constructing a regex, and
// importing through `super` keeps the parent public surface
// marked as used in normal builds.
// TS map: `import { requiresResharp, stackedQuantifier } from "./rules";`.
//
// In TS you'd write (pseudocode):
// ```ts
// import { requiresResharp, stackedQuantifier } from "./rules";
// ```
use ;
// What: The byte alternation that matches every Unicode whitespace
// code point as its UTF-8 byte sequence. Each `\xHH` literal
// in the regex source compiles to one byte under the regex
// crate's `unicode(false)` mode; the alternation is then a
// cheap NFA branch (no per-codepoint table). Coverage:
// - U+00A0 NBSP `\xc2\xa0`
// - U+1680 OGHAM SPACE MARK `\xe1\x9a\x80`
// - U+180E MONGOLIAN VOWEL SEPARATOR `\xe1\xa0\x8e`
// - U+2000..U+200A (en quad..hair) `\xe2\x80[\x80-\x8a]`
// - U+2028 LINE SEPARATOR `\xe2\x80\xa8`
// - U+2029 PARAGRAPH SEPARATOR `\xe2\x80\xa9`
// - U+202F NARROW NO-BREAK SPACE `\xe2\x80\xaf`
// - U+205F MEDIUM MATH SPACE `\xe2\x81\x9f`
// - U+3000 IDEOGRAPHIC SPACE `\xe3\x80\x80`
// - U+FEFF ZERO-WIDTH NO-BREAK SPACE `\xef\xbb\xbf`
// Why: Closes BUG 8 without forcing rules onto `unicode(true)`
// compile. Pre-fix, `(?i)adafruit[\s]+=` against `adafruit\xc2\xa0=`
// silently missed because `unicode(false)` treats `\s` as the
// ASCII subset `[\t\n\v\f\r\x20]`. The previous fix forced
// those rules to `unicode(true)` -- correct but ~90x more
// expensive to compile (224 rules -> 478 ms phase 1, 64x
// wall-time regression). Source-level expansion keeps every
// rule on the `unicode(false)` fast path while widening the
// class to cover the Unicode whitespace bytes.
// TS map: `const UNICODE_WS_ALT = "\\xc2\\xa0|...";`.
//
// In TS you'd write (pseudocode):
// ```ts
// const UNICODE_WS_ALT = String.raw`\xc2\xa0|...`;
// ```
const UNICODE_WS_ALT: &str = r"\xc2\xa0|\xe1\x9a\x80|\xe1\xa0\x8e|\xe2\x80[\x80-\x8a\xa8\xa9\xaf]|\xe2\x81\x9f|\xe3\x80\x80|\xef\xbb\xbf";
// What: `fn scan_class(bytes, start) -> Option<(usize, bool)>`
// walks a character class starting at `bytes[start] == b'['`
// and returns `(close_offset, contains_s)` -- the index of
// the matching `]` AND whether the class contains an
// unescaped `\s` shorthand. Handles the corner cases:
// - Leading `[^` (negation flag) does not start a body.
// - A literal `]` at body-start position (`[]a-z]` or
// `[^]a-z]`) is not the terminator.
// - `\X` escapes consume two bytes (so `\]` inside the class
// does NOT terminate it).
// Why: The source rewrite below needs to know two things about
// each class: where it ends (so we can splice in the
// Unicode-WS alternation around it) and whether it actually
// contains `\s` (so we only widen classes that need it).
// Returns `None` for an unterminated class -- the caller
// treats this as "do not rewrite; let the regex compiler
// emit its own parse error."
// TS map: `function scanClass(bytes: Uint8Array, start: number)
// : { close: number; containsS: boolean } | null`.
// What: `fn utf8_width(leading: u8) -> usize` returns how many
// bytes the UTF-8 sequence starting with `leading` occupies.
// ASCII (< 0x80) -> 1, two-byte leading (0xc0-0xdf) -> 2,
// three-byte (0xe0-0xef) -> 3, four-byte (0xf0-0xf7) -> 4.
// A continuation byte (0x80-0xbf) is not a valid leading byte
// in well-formed UTF-8; the function returns 1 defensively so
// a single-byte step advances the cursor and the caller does
// not stall on malformed input.
// Why: The source rewrite must copy multi-byte UTF-8 sequences
// verbatim. A bare `bytes[i] as char` cast would mojibake
// non-ASCII bytes; using `&src[i..i+width]` preserves the
// UTF-8 encoding.
// TS map: `function utf8Width(b: number): number`.
// What: `fn expand_unicode_whitespace(src) -> String` rewrites the
// regex source so `\s` matches Unicode whitespace under
// `unicode(false)` compile mode. Transformations:
// - `\s` outside a character class -> `(?:\s|<UNICODE_WS_ALT>)`.
// The `\s` inside the group still expands to ASCII WS
// under `unicode(false)`; the alternation adds the
// multi-byte UTF-8 sequences for the remaining whitespace
// code points.
// - `[...\s...]` (class containing unescaped `\s`) ->
// `(?:[...\s...]|<UNICODE_WS_ALT>)`. The class itself is
// preserved (matches its ASCII subset under
// `unicode(false)`); the wrapping group adds the
// multi-byte sequences. Semantic shift: under PCRE/Unicode
// a class character takes one position, while the
// expanded multi-byte UTF-8 here also occupies one
// alternation slot. Quantifiers on the wrapped group
// treat NBSP as a single match, which is closer to
// author intent than the pre-fix "single byte" view.
// - Other escape sequences (`\X`, `\n`, `\xHH`) and literal
// characters pass through verbatim. Multi-byte UTF-8
// literals are preserved using `utf8_width`.
// Why: Source-level expansion keeps every rule on the
// `unicode(false)` fast path (~5ms phase 1) while making
// `\s` honour the user's authoring intent that a rule like
// `(?i)adafruit[\s]+=` matches `adafruit<NBSP>=`. The
// previous BUG 8 fix forced these rules to `unicode(true)`,
// costing ~478 ms phase 1 (95x regression). The rewrite
// costs microseconds and lands the same correctness.
// `\S` is intentionally NOT expanded: a sound "not Unicode
// whitespace" would require subtracting multi-byte byte
// sequences from a negated byte class, which has no clean
// source representation. Rules using `\S` keep ASCII-only
// semantics; document in PERF.md.
// TS map: `function expandUnicodeWhitespace(src: string): string`.
//
// In TS you'd write (pseudocode):
// ```ts
// function expandUnicodeWhitespace(src: string): string {
// let out = "";
// let i = 0;
// while (i < src.length) {
// // ... handle \s, [...], escapes, multi-byte literals ...
// }
// return out;
// }
// ```
// What: `pub fn compile_rule_src(src: &str) -> Result<CompiledRegex, String>`
// is the single source of truth for the regex compile
// decision. It walks the routing classifier
// (`requires_resharp`), runs the lookaround-in-complement
// pre-flight guard when routing to resharp, and dispatches
// to the resharp `Regex::new` or the unicode-fallback
// `regex` builder. Returns `CompiledRegex` directly --
// callers that need a line-indexed `RegexRule` (the
// production loader) wrap it with the `idx` themselves.
// Why: The plan requires fuzz_api and production to share the
// same compile path so the AC-gate soundness fuzzer
// exercises identical behaviour. Splitting into a thin
// "wrap with idx" outer layer + a `compile_rule_src`
// core gives both call sites that property.
// TS map: `function compileRuleSrc(src: string): CompiledRegex`.
//
// In TS you'd write (pseudocode):
// ```ts
// function compileRuleSrc(src: string): CompiledRegex {
// if (requiresResharp(src)) {
// const reason = lookaroundInComplement(src);
// if (reason) throw new Error(`(resharp): ${reason}`);
// try { return { kind: "resharp", re: new Regex(src) }; }
// catch (e) { throw new Error(`(resharp): ${e}`); }
// }
// return compilePlainToCompiled(src);
// }
// ```
// What: `fn compile_plain_rule_to_compiled(src: &str) -> Result<CompiledRegex, String>`
// is the unicode-off / unicode-on fallback compile path
// for rules that did NOT route to resharp. Identical to
// the previous `compile_plain_rule` body, but returns a
// `CompiledRegex` without the rule index so it composes
// into `compile_rule_src`.
// Why: Keep the "fast path -> retry with unicode" mechanic
// in one place. `compile_plain_rule` is now a thin
// wrapper that calls this and decorates the error
// with `rule on line N` for diagnostics.
// TS map: `function compilePlainToCompiled(src: string): CompiledRegex`.
//
// In TS you'd write (pseudocode):
// ```ts
// function compilePlainToCompiled(src: string): CompiledRegex { ... }
// ```