krakjoe/phathom-ext

A multi-engine parser framework, for phathoming texty things.

dev-main 2026-06-26 06:48 UTC

Requires

• php: >=8.4

BSD-3-Clause

Extension name: ext-phathom

Supports Zend Thread Safety (ZTS): ✅

Supports non-Thread Safe mode (NTS): ✅

Supported operating systems: no restrictions

Configure flags:

• --with-phathom-coverage Build phathom with gcov coverage support
• --with-phathom-sanitize Build phathom with AddressSanitizer support

README

This extension re-implements the internal API of pharos\phathom\Earley, mirroring the userland implementation but removing the cost of object allocation (in this namespace).

The following classes are implemented (only):

• pharos\phathom\Earley\Chart
• pharos\phathom\Earley\Evaluator
• pharos\phathom\GLR\Chart
• pharos\phathom\GLR\Evaluator

When the extension is loaded, they will usurp the function of the userland implementations transparently.

This extension is intended to be a faithful mirror; A competent PHP programmer ought to be able to navigate this C code if they are familiar with the PHP implementation and they like to fix or add a thing.

Install

To configure the extension for normal installation

./configure

Run a normal build:

make

Install:

make install

Testing

To configure the extension with coverage:

./configure --with-phathom-coverage

Run a normal build:

make

To run coverage collection with lcov over phpunit tests:

TEST_PHP_EXECUTABLE=/usr/bin/php make phathom-test-coverage-html

Will generate a coverage directory with html and coverage.info with data.

Note: the coverage recipe from Makefile.frag does not require installation of the extension

Notes

It's important that the extension and PHP code are kept in sync; The extension treats the layout of PHP objects as stable ABI (ie, the properties must not change order).

Note that, PHP objects do have a stable ABI with regard to the property layout, since NG.

!WIP!