Skip to content

CHICKEN Scheme wrapper for POSIX regular expression matching

License

Notifications You must be signed in to change notification settings

nmeum/posix-regex

Repository files navigation

posix-regex

CHICKEN egg for POSIX regular expressions supporting POSIX EREs and BREs.

Motivation

CHICKEN's default regex library only supports POSIX EREs with PCRE extensions. Unfourtunatly, I needed a strict POSIX-compliant BRE implementation, without any extensions, for my implementation of the ed text editor in CHICKEN Scheme. For this reason, I originally used CHICKEN's Foreign Function Interface to use the POSIX regcomp(3) and regexec(3) functions directly in the codebase of my editor. However, the code for wrapping these functions became more complex over time (e.g. due to support for better error messages via regerror(3)). As such, I decided to move it to a dedicated library which may be useful for other CHICKEN Schemers which are looking for a pure POSIX BRE or ERE implementation.

Features

  • Thin wrappers for regcomp(3) and regexec(3)
  • Error handling via R7RS exceptions and a regerror(3) wrapper
  • API with strict CHICKEN type annotations
  • Support for submatches via R7RS bytevectors

Installation

This library is available in the CHICKEN egg repository and can be installed using:

$ chicken-install posix-regex

Documentation

The documentation is maintained separately in the CHICKEN wiki.

Initially, the documentation was partially generated with schematic from inline comments using:

$ schematic-wiki -c ';;>' < posix-regex.scm

Usage

For an elaborate usage example, refer to the source code of the edward text editor.

License

This library is licensed under GPL-3.0-only.