Skip to content
Ridgun
English

19 The Ridgun Book

The regex Lib — Linear-Time $O(N \cdot M)$ Thompson NFA Regular Expression Engine

19.1. Why Does the regex Lib Exist? (The Real-World Problem & Ridgun Philosophy)

"Why do I need a regex lib written from scratch in pure Ridgun instead of just linking a legacy C library?"

That is the first question every systems engineer asks when meeting regex. And the answer captures the entire philosophy of ridgun-libs:

Let's be honest: backtracking regex engines have caused famous global outages (at Cloudflare, StackOverflow, and countless APIs) the moment a pattern like (a+)+b meets thirty as and explodes into $O(2^N)$ exponential time.

The regex lib compiles patterns (., *, +, ?, |, (), [a-z], [^...], ^, $, \d, \w, \s) into a Thompson Non-Deterministic Finite Automaton (NFA) and steps the active state set in strict $O(N \cdot M)$ linear time, making ReDoS attacks mathematically impossible.

In a traditional ecosystem, solving REGEX tasks means pulling in external C dependencies, wrestling with raw pointers, opaque type conversions, unchecked exceptions, or unpredictable garbage-collector pauses. In Ridgun, the regex lib (src/main/ridgun/lib/regex.rg) tackles the problem with four non-negotiable principles:

  1. Declare import regex (or import regex as alias) at the top of your file: every lib defines its module :: regex namespace, and under --strict multi-word functions are always called with natural spaces.
  2. Chain your data pipelines left-to-right with ->: write input step one -> step two -> result, use (+ _ _ +) sequence masks to destructure tuples/lists, and omit _ = on sequential statements (or discard with -> ()).
  3. Tail-Call Optimization (TCO): all internal loops in regex are tail-recursive and compile into native hardware loops using $O(1)$ stack space.
  4. Deterministic Memory (RMM1 / RMM2): every intermediate allocation is reclaimed at the exact instruction where its last read finishes, with no Garbage Collector.

19.2. Native Artifacts, Imports, and Complete regex API Catalog

In ridgun-libs, regex is a first-class lib located at src/main/ridgun/lib/regex.rg (domain REGEX). When built with stable bundle, it compiles into three native artifacts:

ArtifactPathPurpose
Ridgun Bundletarget/bundles/regex.rglibPortable distribution and direct import regex resolution
Compiled Archivetarget/regex.rgcType-checked intermediate artifact verified by ridgunc
ELF64 Shared Objecttarget/libregex.soNative dynamic shared library with zero C or libc dependencies

Every lib declares its own namespace via module :: regex: simply write import regex (or import regex as alias) at the top and call its functions with natural spaces (my fn x) and left-to-right -> pipelines (x my fn -> result).

19.2.1. Summary of regex Functional Families

Signature / Function / TypePurpose & Usage
regex match / regex is matchFull-string match and unanchored substring search in $O(N \cdot M)$
regex find / regex find allExtract the first or all non-overlapping matching substrings
regex replace / regex replace allReplace the first or all regex matches with a replacement string
regex split / regex escapeSplit text by a regex delimiter and escape metacharacters

19.2.2. Exhaustive Catalog of Types and Signatures in src/main/ridgun/lib/regex.rg

Below is the complete inventory of algebraic data types (type), mixfix operators (op ::), and function signatures (fn ::) defined in src/main/ridgun/lib/regex.rg (4 types, 0 operators, and 70 functions):

Algebraic Data Types & Records (type) in regex:

type RegexMatch = matched: Bool, match_start: Int, match_end: Int, text: String
type ReNode = ReEmpty | ReChar Int | ReAny | ReClass Bool [Int] | ReShort Int | ReBol | ReEol | ReStar ReNode | RePlus ReNode | ReOpt ReNode | ReSeq ReNode ReNode | ReAlt ReNode ReNode
type ReParseRes = ReParseRes ReNode Int
type NfaInst = InstChar Int Int | InstAny Int | InstClass Bool [Int] Int | InstShort Int Int | InstBol Int | InstEol Int | InstSplit Int Int | InstJump Int | InstMatch
#Function / Signature (fn ::)Return Type
1fn :: re is digit IntBool
2fn :: re is word IntBool
3fn :: re is space IntBool
4fn :: re match short Int IntBool
5fn :: re in ranges Int [Int]Bool
6fn :: re escape char IntReNode
7fn :: re class char String Int Int(Int Int)
8fn :: re fst int (Int Int)Int
9fn :: re snd int (Int Int)Int
10fn :: re parse class items String Int Int [Int]([Int] Int)
11fn :: re parse class item step String Int Int [Int]([Int] Int)
12fn :: re parse class range check String Int Int Int [Int]([Int] Int)
13fn :: re parse class range hi String Int Int Int [Int]([Int] Int)
14fn :: re fst ranges ([Int] Int)[Int]
15fn :: re snd pos ([Int] Int)Int
16fn :: re parse class String Int IntReParseRes
17fn :: re finish class Bool ([Int] Int)ReParseRes
18fn :: re res node ReParseResReNode
19fn :: re res pos ReParseResInt
20fn :: re parse group String Int IntReParseRes
21fn :: re close group ReNode String Int IntReParseRes
22fn :: re parse atom String Int IntReParseRes
23fn :: re parse postfix ReNode String Int IntReParseRes
24fn :: re parse factor String Int IntReParseRes
25fn :: re is seq stop IntBool
26fn :: re parse seq loop ReNode String Int IntReParseRes
27fn :: re parse seq step ReNode String Int IntReParseRes
28fn :: re parse seq String Int IntReParseRes
29fn :: re parse seq first String Int IntReParseRes
30fn :: re parse alt loop ReNode String Int IntReParseRes
31fn :: re parse alt branch ReNode String Int IntReParseRes
32fn :: re parse alt String Int IntReParseRes
33fn :: nfa len [NfaInst]Int
34fn :: re compile seq ReNode ReNode Int[NfaInst]
35fn :: re compile opt ReNode Int[NfaInst]
36fn :: re compile star ReNode Int[NfaInst]
37fn :: re compile plus ReNode Int[NfaInst]
38fn :: re compile alt ReNode ReNode Int[NfaInst]
39fn :: re compile node ReNode Int[NfaInst]
40fn :: re compile String[NfaInst]
41fn :: nfa inst at [NfaInst] IntNfaInst
42fn :: nfa set has [Int] IntBool
43fn :: nfa closure [NfaInst] [Int] Int Int [Int][Int]
44fn :: nfa closure inst [NfaInst] Int [Int] Int Int [Int] NfaInst[Int]
45fn :: nfa step one NfaInst Int[Int]
46fn :: nfa step [NfaInst] [Int] Int[Int]
47fn :: nfa is match inst NfaInstBool
48fn :: nfa has match [NfaInst] [Int]Bool
49fn :: nfa update last [NfaInst] [Int] Int IntInt
50fn :: nfa sim loop [NfaInst] String Int Int [Int] IntInt
51fn :: nfa sim step [NfaInst] String Int Int [Int] IntInt
52fn :: nfa longest from [NfaInst] String Int IntInt
53fn :: nfa full loop [NfaInst] String Int Int [Int]Bool
54fn :: nfa full step [NfaInst] String Int Int [Int]Bool
55fn :: regex match String StringBool
56fn :: nfa find from [NfaInst] String Int IntRegexMatch
57fn :: nfa find check [NfaInst] String Int Int IntRegexMatch
58fn :: regex find String StringRegexMatch
59fn :: regex is match String StringBool
60fn :: nfa find all loop [NfaInst] String Int Int [RegexMatch][RegexMatch]
61fn :: nfa find all step [NfaInst] String Int Int [RegexMatch] Int[RegexMatch]
62fn :: regex find all String String[RegexMatch]
63fn :: regex replace String String StringString
64fn :: re apply replace RegexMatch String StringString
65fn :: nfa replace all loop [NfaInst] String String Int Int StringString
66fn :: nfa replace all step [NfaInst] String String Int Int String IntString
67fn :: regex replace all String String StringString
68fn :: nfa split loop [NfaInst] String Int Int Int [String][String]
69fn :: nfa split step [NfaInst] String Int Int Int [String] Int[String]
70fn :: regex split String String[String]

19.3. Deep Dive into regex: Step-by-Step Examples for Every Feature

A signature table alone is never enough: let's explore every capability of the regex lib through progressive, runnable Ridgun examples. We will start with two everyday tabular recipes and then walk through every functional scenario, transformation, and boundary condition verified in src/test/ridgun/test regex.rg.

19.3.1. Example 1: Core Tabular Workflow with regex

Notice how in Ridgun the = signs and transformation steps using regex align into a clean, scannable table without unnecessary mutable variables or hidden side effects:

import regex

fn :: extraer codigos postales String => [String]
      extraer codigos postales texto =
        regex find all "\d+" texto

19.3.2. Example 2: Safe Composition and Boundary Handling

Every function in the regex lib is designed to compose cleanly with boolean guards | and with the rest of the 32 libs in ridgun-libs:

import regex

fn :: censurar telefonos String => Bool String
      censurar telefonos comentario =
        regex is match "\d+-\d+" comentario -> tiene
        regex replace all "\d+-\d+" comentario "[TELEFONO]" -> limpio
        (tiene, limpio)

19.3.3. Example 3: Anchors (^, $), Quantifiers (*, +, ?), Alternation (|), Groups (...), Character Classes [a-z0-9], and Shorthands (\d, \w, \s)

In this hands-on walkthrough we thoroughly exercise how regex behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:

fn :: test regex operators and classes => ()
      test regex operators and classes =
        assert true (regex match "" "") "AC1: empty pattern matches empty string"
        assert false (regex match "" "nonempty") "AC1: empty pattern rejects non-empty on full match"
        assert true (regex match 'a(b|c)+d?e*' "abcbdeee") "AC1: alternation group plus opt star"
        assert true (regex match 'a(b|c)+d?e*' "ac") "AC1: opt and star match zero occurrences"
        assert false (regex match 'a(b|c)+d?e*' "ade") "AC1: plus requires at least one"
        assert true (regex match '(foo|bar|baz)+' "barfoobazbar") "AC1: multi-branch alternation with plus"
        assert false (regex match '(foo|bar|baz)+' "barquxfoo") "AC1: multi-branch alternation rejects unknown"
        assert true (regex match '[a-zA-Z_][a-zA-Z0-9_]*' "_valid_Identifier_99") "AC1: identifier character class"
        assert false (regex match '[a-zA-Z_][a-zA-Z0-9_]*' "9invalid") "AC1: identifier rejects leading digit"
        assert true (regex match '[^0-9]+' "hello_world") "AC1: negated char class"
        assert false (regex match '[^0-9]+' "hello42") "AC1: negated char class rejects digits"
        assert true (regex match '\w+\s+\d+' "agent   007") "AC1: shorthand escapes \\w \\s \\d"
        assert true (regex match '\D+\S+' "abc_123") "AC1: negated shorthand escapes \\D \\S"
        assert true (regex match 'v\d+\.\d+\.\d+' "v0.9.16") "AC1: escaped dot literal"
        assert false (regex match 'v\d+\.\d+\.\d+' "v0X9Y16") "AC1: escaped dot rejects non-dot"
        assert true (regex is match '^hello' "hello world") "AC1: bol anchor matches start"
        assert false (regex is match '^world' "hello world") "AC1: bol anchor rejects middle"
        assert true (regex is match 'world$' "hello world") "AC1: eol anchor matches end"
        assert false (regex is match 'hello$' "hello world") "AC1: eol anchor rejects prefix"
        assert true (regex is match '^exact$' "exact") "AC1: anchored ^exact$ matches full string"
        assert false (regex is match '^exact$' "not exact") "AC1: anchored ^exact$ rejects extra chars"
        -- Russ Cox pathological backtracking benchmarks (exponential in backtracking engines, O(N*M) in Thompson NFA)
        assert false (regex match '(a+)+b' "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaac") "AC1: Thompson NFA immune to (a+)+b ReDoS"
        assert false (regex match '(a|aa)+b' "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaac") "AC1: Thompson NFA immune to (a|aa)+b ReDoS"
        assert true (regex match 'a?a?a?a?a?a?a?a?aaaaaaaa' "aaaaaaaa") "AC1: Russ Cox a?^n a^n vector"
        ()

19.3.4. Example 4: Match Extraction (regex find, regex find all), Replacement (regex replace, regex replace all), and Splitting (regex split)

In this hands-on walkthrough we thoroughly exercise how regex behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:

fn :: test regex find replace split => ()
      test regex find replace split =
        m1 = regex find '\d+' "item #42 and #99"
        assert true (matched m1) "AC2: find matched"
        assert int equals (match_start m1) 6 "AC2: find start"
        assert int equals (match_end m1) 8 "AC2: find end"
        assert str eq (text m1) "42" "AC2: find text"

        m_none = regex find '\d+' "no digits here"
        assert false (matched m_none) "AC2: find returns matched=False when absent"

        all_m = regex find all '[a-z]+=\d+' "id=10, port=8080, ttl=60"
        assert int equals (re match count all_m) 3 "AC2: find all key=val count"
        assert str eq (text (re match at all_m 0)) "id=10" "AC2: find all first match"
        assert str eq (text (re match at all_m 1)) "port=8080" "AC2: find all second match"
        assert str eq (text (re match at all_m 2)) "ttl=60" "AC2: find all third match"

        r1 = regex replace '\d+' "X" "v1.2.3"
        assert str eq r1 "vX.2.3" "AC3: replace first"
        r_no = regex replace '\d+' "X" "abc"
        assert str eq r_no "abc" "AC3: replace with no match returns original"
        r2 = regex replace all '\d+' "X" "v1.22.333"
        assert str eq r2 "vX.X.X" "AC3: replace all"

        parts = regex split '\s*[,;]\s*' "alpha, beta ;  gamma,delta"
        assert int equals (re str count parts) 4 "AC3: split count"
        assert str eq (re str at parts 0) "alpha" "AC3: split[0]"
        assert str eq (re str at parts 1) "beta" "AC3: split[1]"
        assert str eq (re str at parts 2) "gamma" "AC3: split[2]"
        assert str eq (re str at parts 3) "delta" "AC3: split[3]"
        ()

19.3.5. Example 5: Linear-Time $O(N \cdot M)$ Identifier Validator and Log Scrubber Using Thompson NFA (regex is match, regex replace all, regex split)

In this hands-on walkthrough we thoroughly exercise how regex behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:

import regex

fn :: limpiar traza y validar id (usuario_id : String) (linea_log : String) => (Bool, String, [String])
      limpiar traza y validar id usuario_id linea_log =
        id_valido = regex is match "^usr_[a-z0-9]+$" usuario_id
        sin_ips   = regex replace all "\d+\.\d+\.\d+\.\d+" linea_log "[IP-REDACTADA]"
        tokens    = regex split "\s+" sin_ips
        (id_valido, sin_ips, tokens)

19.4. Under the Hood: How regex Is Built in Pure Ridgun (src/main/ridgun/lib/regex.rg)

One of the biggest advantages of ridgun-libs is that there are no C black boxes. You can open src/main/ridgun/lib/regex.rg and read exactly how every operation is implemented using pattern matching, | / |. guard trees, and tail-call optimization (TCO). Let's inspect the key building blocks of its real implementation:

19.4.1. Internal Implementation: Character Class & Shorthand Helpers

Observe how regex.rg declares explicit fn :: ... => ... contracts first and resolves each case through aligned equations and tail calls:

module :: regex

fn :: re is digit Int => Bool
      re is digit c = c >= 48 and c <= 57

fn :: re is word Int => Bool
      re is word c = (c >= 48 and c <= 57) or (c >= 65 and c <= 90) or (c >= 97 and c <= 122) or c == 95

fn :: re is space Int => Bool
      re is space c = c == 32 or c == 9 or c == 10 or c == 13 or c == 11 or c == 12

fn :: re match short Int Int => Bool
      re match short 100 c = re is digit c
      re match short 68 c = not (re is digit c)
      re match short 119 c = re is word c
      re match short 87 c = not (re is word c)
      re match short 115 c = re is space c
      re match short 83 c = not (re is space c)
      re match short _ _ = False

fn :: re in ranges Int [Int] => Bool
      re in ranges _ [] = False
      re in ranges _ (_:[]) = False
      re in ranges c (lo:hi:rs) =
        | c >= lo and c <= hi = True
        | otherwise = re in ranges c rs

19.4.2. Internal Implementation: Thompson NFA Compiler (ReNode -> [NfaInst])

Observe how regex.rg declares explicit fn :: ... => ... contracts first and resolves each case through aligned equations and tail calls:

fn :: nfa len [NfaInst] => Int
      nfa len [] = 0
      nfa len (_:rest) = 1 + (nfa len rest)

fn :: re compile seq ReNode ReNode Int => [NfaInst]
      re compile seq a b start_id =
        insts_a = re compile node a start_id
        mid_id = start_id + (nfa len insts_a)
        insts_b = re compile node b mid_id
        insts_a :: insts_b

fn :: re compile opt ReNode Int => [NfaInst]
      re compile opt a start_id =
        body = re compile node a (start_id + 1)
        end_id = start_id + 1 + (nfa len body)
        [InstSplit (start_id + 1) end_id] :: body

fn :: re compile star ReNode Int => [NfaInst]
      re compile star a start_id =
        body = re compile node a (start_id + 1)
        end_id = start_id + 2 + (nfa len body)
        ([InstSplit (start_id + 1) end_id] :: body) :: [InstJump start_id]

fn :: re compile plus ReNode Int => [NfaInst]
      re compile plus a start_id =
        body = re compile node a start_id
        split_id = start_id + (nfa len body)
        body :: [InstSplit start_id (split_id + 1)]

fn :: re compile alt ReNode ReNode Int => [NfaInst]
      re compile alt a b start_id =
        body_a = re compile node a (start_id + 1)
        jump_id = start_id + 1 + (nfa len body_a)
        start_b = jump_id + 1
        body_b = re compile node b start_b
        end_id = start_b + (nfa len body_b)
        (([InstSplit (start_id + 1) start_b] :: body_a) :: [InstJump end_id]) :: body_b

fn :: re compile node ReNode Int => [NfaInst]
      re compile node ReEmpty _ = []
      re compile node (ReChar c) start_id = [InstChar c (start_id + 1)]
      re compile node ReAny start_id = [InstAny (start_id + 1)]
      re compile node (ReClass neg rngs) start_id = [InstClass neg rngs (start_id + 1)]
      re compile node (ReShort k) start_id = [InstShort k (start_id + 1)]
      re compile node ReBol start_id = [InstBol (start_id + 1)]
      re compile node ReEol start_id = [InstEol (start_id + 1)]
      re compile node (ReOpt a) start_id = re compile opt a start_id
      re compile node (ReStar a) start_id = re compile star a start_id
      re compile node (RePlus a) start_id = re compile plus a start_id
      re compile node (ReSeq a b) start_id = re compile seq a b start_id
      re compile node (ReAlt a b) start_id = re compile alt a b start_id

fn :: re compile String => [NfaInst]
      re compile pat =
        re parse alt pat 0 (str len pat) -> parsed
        (re compile node (re res node parsed) 0) :: [InstMatch]

19.4.3. Internal Implementation: Linear-Time Thompson NFA State-Set Simulation

Observe how regex.rg declares explicit fn :: ... => ... contracts first and resolves each case through aligned equations and tail calls:

fn :: nfa inst at [NfaInst] Int => NfaInst
      nfa inst at [] _ = InstMatch
      nfa inst at (i:_) 0 = i
      nfa inst at (_:rest) idx = nfa inst at rest (idx - 1)

fn :: nfa set has [Int] Int => Bool
      nfa set has [] _ = False
      nfa set has (x:xs) v =
        | x == v = True
        | otherwise = nfa set has xs v

fn :: nfa closure [NfaInst] [Int] Int Int [Int] => [Int]
      nfa closure _ [] _ _ visited = visited
      nfa closure prog (s:ss) pos len visited =
        | nfa set has visited s = nfa closure prog ss pos len visited
        | otherwise = nfa closure inst prog s ss pos len (visited :: [s]) (nfa inst at prog s)

fn :: nfa closure inst [NfaInst] Int [Int] Int Int [Int] NfaInst => [Int]
      nfa closure inst prog _ ss pos len vis (InstJump out) = nfa closure prog ([out] :: ss) pos len vis
      nfa closure inst prog _ ss pos len vis (InstSplit o1 o2) = nfa closure prog ([o1, o2] :: ss) pos len vis
      nfa closure inst prog _ ss pos len vis (InstBol out) =
        | pos == 0 = nfa closure prog ([out] :: ss) pos len vis
        | otherwise = nfa closure prog ss pos len vis
      nfa closure inst prog _ ss pos len vis (InstEol out) =
        | pos == len = nfa closure prog ([out] :: ss) pos len vis
        | otherwise = nfa closure prog ss pos len vis
      nfa closure inst prog _ ss pos len vis _ = nfa closure prog ss pos len vis

fn :: nfa step one NfaInst Int => [Int]
      nfa step one (InstChar expected out) c =
        | c == expected = [out]
        | otherwise = []
      nfa step one (InstAny out) c =
        | c != 10 = [out]
        | otherwise = []
      nfa step one (InstClass neg rngs out) c =
        | (re in ranges c rngs) != neg = [out]
        | otherwise = []
      nfa step one (InstShort kind out) c =
        | re match short kind c = [out]
        | otherwise = []
      nfa step one _ _ = []

fn :: nfa step [NfaInst] [Int] Int => [Int]
      nfa step _ [] _ = []
      nfa step prog (s:ss) c = (nfa step one (nfa inst at prog s) c) :: (nfa step prog ss c)

fn :: nfa is match inst NfaInst => Bool
      nfa is match inst InstMatch = True
      nfa is match inst _ = False

fn :: nfa has match [NfaInst] [Int] => Bool
      nfa has match _ [] = False
      nfa has match prog (s:ss) =
        | nfa is match inst (nfa inst at prog s) = True
        | otherwise = nfa has match prog ss

fn :: nfa update last [NfaInst] [Int] Int Int => Int
      nfa update last prog active cand cur =
        | nfa has match prog active = cand
        | otherwise = cur

fn :: nfa sim loop [NfaInst] String Int Int [Int] Int => Int
      nfa sim loop _ _ _ _ [] last_m = last_m
      nfa sim loop prog input pos len active last_m =
        | pos >= len = last_m
        | otherwise = nfa sim step prog input pos len active last_m

fn :: nfa sim step [NfaInst] String Int Int [Int] Int => Int
      nfa sim step prog input pos len active last_m =
        str char at input pos -> c
        nfa closure prog (nfa step prog active c) (pos + 1) len [] -> next_act
        nfa update last prog next_act (pos + 1) last_m -> next_last
        nfa sim loop prog input (pos + 1) len next_act next_last

fn :: nfa longest from [NfaInst] String Int Int => Int
      nfa longest from prog input pos len =
        nfa closure prog [0] pos len [] -> init_act
        nfa update last prog init_act pos (0 - 1) -> init_last
        nfa sim loop prog input pos len init_act init_last

fn :: nfa full loop [NfaInst] String Int Int [Int] => Bool
      nfa full loop _ _ _ _ [] = False
      nfa full loop prog input pos len active =
        | pos >= len = nfa has match prog active
        | otherwise = nfa full step prog input pos len active

fn :: nfa full step [NfaInst] String Int Int [Int] => Bool
      nfa full step prog input pos len active =
        str char at input pos -> c
        nfa closure prog (nfa step prog active c) (pos + 1) len [] -> next_act
        nfa full loop prog input (pos + 1) len next_act

19.4.4. Internal Implementation: Public Regex API (API-REGEX-001)

Observe how regex.rg declares explicit fn :: ... => ... contracts first and resolves each case through aligned equations and tail calls:

fn :: regex match String String => Bool
      regex match pat input =
        pat re compile -> prog
        input str len -> len
        nfa closure prog [0] 0 len [] -> init_act
        nfa full loop prog input 0 len init_act

fn :: nfa find from [NfaInst] String Int Int => RegexMatch
      nfa find from prog input pos len =
        | pos > len = RegexMatch False (0 - 1) (0 - 1) ""
        | otherwise = nfa find check prog input pos len (nfa longest from prog input pos len)

fn :: nfa find check [NfaInst] String Int Int Int => RegexMatch
      nfa find check prog input pos len end_pos =
        | end_pos >= pos = RegexMatch True pos end_pos (str slice input pos end_pos)
        | otherwise = nfa find from prog input (pos + 1) len

fn :: regex find String String => RegexMatch
      regex find pat input =
        pat re compile -> prog
        nfa find from prog input 0 (str len input)

fn :: regex is match String String => Bool
      regex is match pat input = regex find pat input -> matched

fn :: nfa find all loop [NfaInst] String Int Int [RegexMatch] => [RegexMatch]
      nfa find all loop prog input pos len acc =
        | pos > len = acc
        | otherwise = nfa find all step prog input pos len acc (nfa longest from prog input pos len)

fn :: nfa find all step [NfaInst] String Int Int [RegexMatch] Int => [RegexMatch]
      nfa find all step prog input pos len acc end_pos =
        | end_pos > pos = nfa find all loop prog input end_pos len (acc :: [RegexMatch True pos end_pos (str slice input pos end_pos)])
        | end_pos == pos = nfa find all loop prog input (pos + 1) len (acc :: [RegexMatch True pos pos ""])
        | otherwise = nfa find all loop prog input (pos + 1) len acc

fn :: regex find all String String => [RegexMatch]
      regex find all pat input =
        pat re compile -> prog
        nfa find all loop prog input 0 (str len input) []

fn :: regex replace String String String => String
      regex replace pat repl input =
        regex find pat input -> m
        re apply replace m repl input

fn :: re apply replace RegexMatch String String => String
      re apply replace m repl input =
        | not (matched m) = input
        | otherwise = (str slice input 0 (match_start m)) + repl + (str slice input (match_end m) (str len input))

fn :: nfa replace all loop [NfaInst] String String Int Int String => String
      nfa replace all loop prog repl input pos len acc =
        | pos >= len = acc
        | otherwise = nfa replace all step prog repl input pos len acc (nfa longest from prog input pos len)

fn :: nfa replace all step [NfaInst] String String Int Int String Int => String
      nfa replace all step prog repl input pos len acc end_pos =
        | end_pos > pos = nfa replace all loop prog repl input end_pos len (acc + repl)
        | otherwise = nfa replace all loop prog repl input (pos + 1) len (acc + (str slice input pos (pos + 1)))

fn :: regex replace all String String String => String
      regex replace all pat repl input =
        pat re compile -> prog
        nfa replace all loop prog repl input 0 (str len input) ""

fn :: nfa split loop [NfaInst] String Int Int Int [String] => [String]
      nfa split loop prog input pos len last_s acc =
        | pos >= len = acc :: [str slice input last_s len]
        | otherwise = nfa split step prog input pos len last_s acc (nfa longest from prog input pos len)

fn :: nfa split step [NfaInst] String Int Int Int [String] Int => [String]
      nfa split step prog input pos len last_s acc end_pos =
        | end_pos > pos = nfa split loop prog input end_pos len end_pos (acc :: [str slice input last_s pos])
        | otherwise = nfa split loop prog input (pos + 1) len last_s acc

fn :: regex split String String => [String]
      regex split pat input =
        pat re compile -> prog
        nfa split loop prog input 0 (str len input) 0 []

19.5. Algorithmic Guarantees, RMM1/RMM2 Memory, and the 5 Golden Rules of regex

  • Algorithmic & Safety Guarantee: Lockstep NFA state-set simulation with zero stack-overflow risk and guaranteed $O(N \cdot M)$ runtime even on pathological (a+)+b inputs.
  • $O(1)$ Stack Complexity via TCO: Every recursive loop in src/main/ridgun/lib/regex.rg is in tail position, so ridgunc compiles them into native jumps with zero stack growth.
  • Deterministic Memory (RMM1/RMM2): Zero garbage-collector pauses; all intermediate allocations are reclaimed deterministically on scope exit.
  • Continuous Verification: Statically checked via stable check and tested by the automated suite in src/test/ridgun/test regex.rg.

The 5 Golden Rules When Programming with regex

  1. Declare import regex at the top of your file and take advantage of space/underscore equivalence so your code reads like natural prose.
  2. Align your data pipelines with =: chain regex calls into named intermediate steps and let stable format align the columns.
  3. Leverage regex's total functions inside | guards: inspect return values or unwrap ADTs via pattern matching rather than assuming external input is valid.
  4. Avoid cloning large structures when only reading: remember that under RMM2, function input arguments incur zero reference-count overhead (+0 / -0).
  5. Pair regex with test (import test): always lock in your domain invariants with assert equals or assert true.

In Chapter 20, we will explore the glob lib in full depth (The glob Lib — Wildcard Patterns (*, ?, [a-z]) and List Filtering).