From 07497c020b53bb95ec0d74fa1672c3d74f5ce945 Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Sun, 1 Aug 2021 21:38:20 -0700 Subject: Added code layout --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4d4445a..ea1fb12 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,22 @@ Testing for these grammar files (other than `builtins`) is iffy at this point, so use at your own risk! These grammar files are only approximations of syntax. +## Code Layout + +File | Description +----------------|----------------------------------------------------- +[bp.c] | The main program. +[definitions.c] | Defining pattern rules. +[explain.c] | Printing a visual explanation of a match. +[files.c] | Loading files and match memoization. +[json.c] | JSON output of matches. +[match.c] | Pattern matching code (match a pattern against an input string). +[pattern.c] | Pattern loading code (build a pattern out of an input string). +[print.c] | Print pattern match results. +[utf8.c] | UTF-8 helper code. +[utils.c] | Miscellaneous helper functions. + + ## Performance Currently, `bp` is super slow compared to hyper-optimized regex tools like -- cgit v1.2.3