# scripts
Two maintainer tools. Neither runs during a build or a test; both produce
committed artifacts, so a user of the crate never needs them.
## `vendor_libraries.py`
Cross-compiles `libirgx.a` for every target the crate vendors and writes them
to `vendor/<rust-target-triple>/`. Zig cross-compiles, so one machine produces
the whole set.
```bash
python3 scripts/vendor_libraries.py # all targets
python3 scripts/vendor_libraries.py --target x86_64-apple-darwin
python3 scripts/vendor_libraries.py --list
```
Needs `zig` on PATH and an engine checkout above this directory. For each target
it builds with an explicit minimum platform version, strips debug info with
`llvm-strip --strip-debug`, merges the PCRE2 C floor into the archive when the
Zig build left it out, and then link-tests the result with a small C program that
compiles a pattern and runs a search. A target that fails the link test is not
written, because an archive that only fails at the consumer's link step is worse
than a missing one.
The pinned minimum platform versions are what make the archives portable:
macOS 11.0, and glibc 2.17 on Linux so the archives work on anything from
CentOS 7 forward.
## `python_oracle.py`
Drives the reference Python binding over a corpus of pattern / flag / text
triples and writes what it reports to `testdata/python_oracle.json`, which
`tests/oracle.rs` asserts against.
```bash
IRGX_LIB=/path/to/libirgx.dylib python3 scripts/python_oracle.py
```
`IRGX_LIB` is only needed when the Python package was installed without its
bundled shared library, which is the case in a source checkout. Add a case by
appending to `CASES` and re-running; the JSON is committed so the Rust test suite
needs no Python.
Everything is recorded in bytes. The Python binding reports codepoint indices for
a `str` pattern and byte offsets for a `bytes` one, and the generator asks in
bytes because that is the coordinate system Rust `str` uses.