ferroni 1.2.8

Pure-Rust Oniguruma regex engine with SIMD-accelerated search
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

# Contributing to Ferroni

Thanks for your interest in contributing! Ferroni is a 1:1 Rust port of the
[Oniguruma](https://github.com/kkos/oniguruma) regex engine, and contributions
that maintain that structural fidelity are welcome.

## Getting Started

```bash
git clone https://github.com/sebastian-software/ferroni.git
cd ferroni
cargo build
```

## Running Tests

Debug builds require increased stack size:

```bash
# Full UTF-8 test suite (1,554 tests)
RUST_MIN_STACK=268435456 cargo test --test compat_utf8 -- --test-threads=1

# Other suites
cargo test --test compat_syntax
cargo test --test compat_options
cargo test --test compat_regset
RUST_MIN_STACK=268435456 cargo test --test compat_back -- --test-threads=1
```

> **Warning:** Never run `cargo test -- --ignored` -- the
> `conditional_recursion_complex` test intentionally hangs.

## Running Benchmarks

Benchmarks require the C original for comparison (via the `ffi` feature):

```bash
cargo bench --features ffi
```

## Guidelines

1. **Read the ADRs first.** The [`docs/adr/`](docs/adr/) directory documents
   all major architectural decisions. In particular:
   - [ADR-001](docs/adr/001-one-to-one-parity-with-c-original.md): the 1:1
     parity goal -- same module mapping, same function names, same control flow.
   - [ADR-004](docs/adr/004-c-to-rust-translation-patterns.md): the canonical
     C-to-Rust translation patterns used throughout the codebase.
   - [ADR-002](docs/adr/002-unsafe-code-policy.md): the `unsafe` code policy.

2. **Cross-reference the C original.** When modifying `regcomp.rs`,
   `regexec.rs`, or `regparse.rs`, always compare against the corresponding
   C source file in `oniguruma-orig/src/`.

3. **US English only.** All code, comments, commit messages, and documentation
   must be in English.

4. **Test your changes.** Run the full test suite before submitting a PR.

5. **Keep it focused.** One concern per PR. Don't mix bug fixes with
   refactoring or feature additions.

## Reporting Issues

Please open an issue on GitHub with:
- The regex pattern and input string that triggers the bug
- Expected vs. actual behavior
- If possible, the corresponding C Oniguruma behavior for comparison

## License

By contributing, you agree that your contributions will be licensed under the
[BSD-2-Clause License](LICENSE).