This is the regex Reference Manual, version 1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:33:23 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
regexA Regular Expression Engine
Michael Parker <mparker762@hotmail.com>
BSD-style
1
packages.lisp (file).
macs.lisp (file).
parser.lisp (file).
optimize.lisp (file).
gen.lisp (file).
closure.lisp (file).
regex.lisp (file).
regexp-test-suite.lisp (file).
retest.lisp (file).
regex.system (file).
regex.translations (file).
Files are sorted by type and then listed depth-first from the systems components trees.
regex/regex.asdregex/packages.lispregex/macs.lispregex/parser.lispregex/optimize.lispregex/gen.lispregex/closure.lispregex/regex.lispregex/regexp-test-suite.lispregex/retest.lispregex/macs.lisppackages.lisp (file).
regex (system).
allow-backmatch (function).
allow-nongreedy-quantifiers (function).
allow-nonregister-groups (function).
allow-rangematch (function).
alt-node-child (function).
alt-node-children (function).
alt-node-first (function).
alt-node-numchildren (function).
alt-node-p (function).
alt-node-second (function).
backmatch-node-p (function).
backmatch-node-regnum (function).
char-node-char (function).
char-node-p (function).
charclass-node-chars (function).
charclass-node-negated-p (function).
charclass-node-p (function).
clear-pattern-cache (function).
compile-verbose (function).
dot-matches-newline (function).
end-anchor-node-p (function).
escape-special-chars (function).
force-safe-match (function).
hook-node-function (function).
hook-node-function-p (function).
hook-node-index-p (function).
hook-node-p (function).
hook-node-symbol-p (function).
kleene-node-child (function).
kleene-node-greedy-p (function).
kleene-node-nongreedy-p (function).
kleene-node-p (function).
make-alt-node-args (function).
make-alt-node-list (function).
make-backmatch-node (function).
make-char-node (function).
make-charclass-node (function).
make-end-anchor-node (function).
make-hook-node (function).
make-kleene-node (function).
make-optional-node (function).
make-pkleene-node (function).
make-range-node (function).
make-regend-node (function).
make-register-node (function).
make-regs (function).
make-regstart-node (function).
make-seq-node-args (function).
make-seq-node-list (function).
make-specclass-node (function).
make-start-anchor-node (function).
make-string-node (function).
make-success-node (function).
match-simple-strings-only (function).
matcher (structure).
matcher-numregs (reader).
(setf matcher-numregs) (writer).
matcher-p (function).
optional-node-child (function).
optional-node-greedy-p (function).
optional-node-nongreedy-p (function).
optional-node-p (function).
pkleene-node-child (function).
pkleene-node-greedy-p (function).
pkleene-node-nongreedy-p (function).
pkleene-node-p (function).
range-node-child (function).
range-node-greedy-p (function).
range-node-max (function).
range-node-min (function).
range-node-nongreedy-p (function).
range-node-p (function).
regend-node-p (function).
regend-node-regnum (function).
register-end (compiler macro).
(setf register-end) (setf expander).
register-end (function).
register-matched-p (function).
register-node-child (function).
register-node-p (function).
register-node-regnum (function).
register-start (compiler macro).
(setf register-start) (setf expander).
register-start (function).
registers-match-rightmost (function).
regstart-node-p (function).
regstart-node-regnum (function).
seq-node-child (function).
seq-node-children (function).
seq-node-numchildren (function).
seq-node-p (function).
specclass-node-class (function).
specclass-node-negated-p (function).
specclass-node-p (function).
start-anchor-node-p (function).
string-node-p (function).
string-node-string (function).
success-node-p (function).
success-node-rc (function).
*allow-backmatch* (special variable).
*allow-nongreedy-quantifiers* (special variable).
*allow-nonregister-groups* (special variable).
*allow-rangematch* (special variable).
*dot-matches-newline* (special variable).
*escape-special-chars* (special variable).
*force-safe-match* (special variable).
*match-simple-strings-only* (special variable).
*pattern-cache* (special variable).
*regex-compile-verbose* (special variable).
*registers-match-rightmost* (special variable).
+max-regex-str-cache+ (constant).
+special-class-names+ (constant).
any-node-p (function).
casealt-node-children (function).
casealt-node-numchildren (function).
casealt-node-p (function).
char-or-class-node-p (function).
classseq-node-p (function).
classseq-node-seq (function).
closure-info (structure).
closure-info-initfn (reader).
(setf closure-info-initfn) (writer).
closure-info-linkfn (reader).
(setf closure-info-linkfn) (writer).
closure-info-matchfn (reader).
(setf closure-info-matchfn) (writer).
closure-info-p (function).
copy-closure-info (function).
copy-matcher (function).
copy-re-scanner (function).
define-constant (macro).
expand-char-class (function).
generate-char-range (function).
make-any-node (function).
make-casealt-node-args (function).
make-casealt-node-list (function).
make-classseq-node (function).
make-closure-info (function).
make-matcher (function).
make-re-scanner (function).
matcher-acceptfn (reader).
(setf matcher-acceptfn) (writer).
matcher-matchexpr (reader).
(setf matcher-matchexpr) (writer).
matcher-matchstr (reader).
(setf matcher-matchstr) (writer).
matcher-simple-string-matchfn (reader).
(setf matcher-simple-string-matchfn) (writer).
matcher-string-matchfn (reader).
(setf matcher-string-matchfn) (writer).
parse-std-char-class (function).
positive-charclass-node-p (function).
re-scanner (structure).
re-scanner-end (reader).
(setf re-scanner-end) (writer).
re-scanner-mode (reader).
(setf re-scanner-mode) (writer).
re-scanner-p (function).
re-scanner-pos (reader).
(setf re-scanner-pos) (writer).
re-scanner-regnum (reader).
(setf re-scanner-regnum) (writer).
re-scanner-str (reader).
(setf re-scanner-str) (writer).
re-scanner-ungot-token (reader).
(setf re-scanner-ungot-token) (writer).
re-scanner-ungot-value (reader).
(setf re-scanner-ungot-value) (writer).
resolve-initfn (function).
resolve-instr (function).
resolve-linkfn (function).
text-node-p (function).
regex/parser.lisppackages.lisp (file).
macs.lisp (file).
regex (system).
parse-str (function).
fix-escape-char (function).
next (function).
nextchar (function).
parse-char-class (function).
parse-char-class-contents (function).
parse-concat (function).
parse-group (function).
parse-quant (function).
parse-regex (function).
parse-term (function).
parse-union (function).
quantify (function).
re-scanner (function).
scan-num (function).
scan-range-bounds (function).
show-tokens (function).
special-class (function).
unget (function).
ungetchar (function).
regex/optimize.lisppackages.lisp (file).
macs.lisp (file).
regex (system).
append-strings (function).
canonicalize (function).
canonicalize-once (function).
char-class-seq-p (function).
coercetostring (function).
combine-alt-charclass (function).
combine-sequence-text (function).
contains-looping-pattern-p (function).
contains-registers-p (function).
expand-range (function).
flatten-alt (function).
flatten-sequence (function).
get-discriminant-chars-alist (function).
hoist-alt-ends (function).
hoist-alt-prefix (function).
hoist-alt-suffix (function).
improve (function).
improve-once (function).
make-discriminant-char-alist (function).
nullable-pattern-p (function).
obviously-nullable-pattern (function).
optimize-regex-tree (function).
partition-charclass-alt (function).
partition-charclass-sequence (function).
partition-on-leading-char (function).
partition-string-sequence (function).
safer-some (function).
select-alt-instrs (function).
select-casealt-instr (function).
select-char-instr (function).
select-charclass-instr (function).
select-classseq-instr (function).
select-greedy-kleene-instr (function).
select-greedy-optional-instr (function).
select-instructions (function).
select-negated-charclass-instr (function).
select-negated-specclass-instr (function).
select-nongreedy-kleene-instr (function).
select-nongreedy-optional-instr (function).
select-sequence-instrs (function).
select-specclass-instr (function).
select-string-instr (function).
seq-butlast (function).
seq-first (function).
seq-first-char (function).
seq-last (function).
seq-rest (function).
simplify (function).
simplify-once (function).
sort-lc-pred (function).
split-alts (function).
split-alts-aux (function).
string-seq-p (function).
subalt-if-necessary (function).
tree-any (function).
unregister (function).
worth-alt-case-partitioning-p (function).
regex/gen.lisppackages.lisp (file).
macs.lisp (file).
regex (system).
add-instr (function).
alloc-instr (function).
emit-alt (function).
emit-casealt (function).
emit-greedy-kleene-full-termcheck (function).
emit-greedy-kleene-no-termcheck (function).
emit-greedy-kleene-simple-termcheck (function).
emit-instr (function).
emit-ngkleene-full-termcheck (function).
emit-ngkleene-no-termcheck (function).
emit-ngkleene-simple-termcheck (function).
emit-sequence (function).
gen-instr-list (function).
regex/closure.lisppackages.lisp (file).
macs.lisp (file).
regex (system).
gen-alt-2-full-termcheck-closure (function).
gen-alt-2-no-termcheck-closure (function).
gen-alt-2-simple-termcheck-1-closure (function).
gen-alt-2-simple-termcheck-2-closure (function).
gen-alt-no-termcheck-closure (function).
gen-any-closure (function).
gen-backmatch-closure (function).
gen-casealt-closure (function).
gen-cclass-2-closure (function).
gen-cclass-2-greedy-kleene-closure (function).
gen-cclass-closure (function).
gen-cclass-greedy-kleene-closure (function).
gen-char-closure (function).
gen-char-greedy-kleene-closure (function).
gen-classseq-closure (function).
gen-closure (function).
gen-closures (function).
gen-endanchor-closure (function).
gen-hook-closure (function).
gen-left-rstart-closure (function).
gen-not-cclass-2-closure (function).
gen-not-cclass-2-greedy-kleene-closure (function).
gen-not-cclass-closure (function).
gen-not-cclass-greedy-kleene-closure (function).
gen-not-char-closure (function).
gen-not-char-greedy-kleene-closure (function).
gen-not-specclass-closure (function).
gen-not-specclass-greedy-kleene-closure (function).
gen-rend-closure (function).
gen-right-rstart-closure (function).
gen-specclass-closure (function).
gen-specclass-greedy-kleene-closure (function).
gen-startanchor-closure (function).
gen-string-closure (function).
gen-success-closure (function).
get-spec-pat-fxn (function).
make-casealt-jmptable (function).
make-init-closure (function).
make-nontext-closure (macro).
make-text-closure (macro).
odigitp (function).
punctp (function).
spacep (function).
xdigitp (function).
regex/regex.lisppackages.lisp (file).
macs.lisp (file).
parser.lisp (file).
optimize.lisp (file).
gen.lisp (file).
closure.lisp (file).
regex (system).
compile-expr (function).
compile-str (function).
match-str (compiler macro).
match-str (function).
scan-str (compiler macro).
scan-str (function).
compile-expr-to-matcher (function).
compile-expr-to-matchfn (function).
compute-max-regnum (function).
link-closures (function).
make-anchored-matcher (function).
match-str-all-parms (function).
newly-compiled-expr-matcher (function).
newly-compiled-str-matcher (function).
scan-str-all-parms (function).
testcomp (function).
testmatch (function).
uncached-compile-expr (function).
uncached-compile-str (function).
regex/regexp-test-suite.lisppackages.lisp (file).
regex.lisp (file).
regex (system).
*regexp-tests* (special variable).
run-sebastien-tests (function).
regex/retest.lisppackages.lisp (file).
regex.lisp (file).
regexp-test-suite.lisp (file).
regex (system).
coveragetest (function).
respeedtest (function).
run-tests (function).
speedtest (function).
strcmpspeedtest (function).
test (function).
Packages are listed by definition order.
regexcommon-lisp.
allow-backmatch (function).
allow-nongreedy-quantifiers (function).
allow-nonregister-groups (function).
allow-rangematch (function).
alt-node-child (function).
alt-node-children (function).
alt-node-first (function).
alt-node-numchildren (function).
alt-node-p (function).
alt-node-second (function).
backmatch-node-p (function).
backmatch-node-regnum (function).
char-node-char (function).
char-node-p (function).
charclass-node-chars (function).
charclass-node-negated-p (function).
charclass-node-p (function).
clear-pattern-cache (function).
compile-expr (function).
compile-str (function).
compile-verbose (function).
dot-matches-newline (function).
end-anchor-node-p (function).
escape-special-chars (function).
force-safe-match (function).
hook-node-function (function).
hook-node-function-p (function).
hook-node-index-p (function).
hook-node-p (function).
hook-node-symbol-p (function).
kleene-node-child (function).
kleene-node-greedy-p (function).
kleene-node-nongreedy-p (function).
kleene-node-p (function).
make-alt-node-args (function).
make-alt-node-list (function).
make-backmatch-node (function).
make-char-node (function).
make-charclass-node (function).
make-end-anchor-node (function).
make-hook-node (function).
make-kleene-node (function).
make-optional-node (function).
make-pkleene-node (function).
make-range-node (function).
make-regend-node (function).
make-register-node (function).
make-regs (function).
make-regstart-node (function).
make-seq-node-args (function).
make-seq-node-list (function).
make-specclass-node (function).
make-start-anchor-node (function).
make-string-node (function).
make-success-node (function).
match-simple-strings-only (function).
match-str (compiler macro).
match-str (function).
matcher (structure).
matcher-numregs (reader).
(setf matcher-numregs) (writer).
matcher-p (function).
optional-node-child (function).
optional-node-greedy-p (function).
optional-node-nongreedy-p (function).
optional-node-p (function).
parse-str (function).
pkleene-node-child (function).
pkleene-node-greedy-p (function).
pkleene-node-nongreedy-p (function).
pkleene-node-p (function).
range-node-child (function).
range-node-greedy-p (function).
range-node-max (function).
range-node-min (function).
range-node-nongreedy-p (function).
range-node-p (function).
regend-node-p (function).
regend-node-regnum (function).
register-end (compiler macro).
(setf register-end) (setf expander).
register-end (function).
register-matched-p (function).
register-node-child (function).
register-node-p (function).
register-node-regnum (function).
register-start (compiler macro).
(setf register-start) (setf expander).
register-start (function).
registers-match-rightmost (function).
regstart-node-p (function).
regstart-node-regnum (function).
scan-str (compiler macro).
scan-str (function).
seq-node-child (function).
seq-node-children (function).
seq-node-numchildren (function).
seq-node-p (function).
specclass-node-class (function).
specclass-node-negated-p (function).
specclass-node-p (function).
start-anchor-node-p (function).
string-node-p (function).
string-node-string (function).
success-node-p (function).
success-node-rc (function).
*allow-backmatch* (special variable).
*allow-nongreedy-quantifiers* (special variable).
*allow-nonregister-groups* (special variable).
*allow-rangematch* (special variable).
*dot-matches-newline* (special variable).
*escape-special-chars* (special variable).
*force-safe-match* (special variable).
*match-simple-strings-only* (special variable).
*pattern-cache* (special variable).
*regex-compile-verbose* (special variable).
*registers-match-rightmost* (special variable).
+max-regex-str-cache+ (constant).
+special-class-names+ (constant).
add-instr (function).
alloc-instr (function).
any-node-p (function).
append-strings (function).
canonicalize (function).
canonicalize-once (function).
casealt-node-children (function).
casealt-node-numchildren (function).
casealt-node-p (function).
char-class-seq-p (function).
char-or-class-node-p (function).
classseq-node-p (function).
classseq-node-seq (function).
closure-info (structure).
closure-info-initfn (reader).
(setf closure-info-initfn) (writer).
closure-info-linkfn (reader).
(setf closure-info-linkfn) (writer).
closure-info-matchfn (reader).
(setf closure-info-matchfn) (writer).
closure-info-p (function).
coercetostring (function).
combine-alt-charclass (function).
combine-sequence-text (function).
compile-expr-to-matcher (function).
compile-expr-to-matchfn (function).
compute-max-regnum (function).
contains-looping-pattern-p (function).
contains-registers-p (function).
copy-closure-info (function).
copy-matcher (function).
copy-re-scanner (function).
define-constant (macro).
emit-alt (function).
emit-casealt (function).
emit-greedy-kleene-full-termcheck (function).
emit-greedy-kleene-no-termcheck (function).
emit-greedy-kleene-simple-termcheck (function).
emit-instr (function).
emit-ngkleene-full-termcheck (function).
emit-ngkleene-no-termcheck (function).
emit-ngkleene-simple-termcheck (function).
emit-sequence (function).
expand-char-class (function).
expand-range (function).
fix-escape-char (function).
flatten-alt (function).
flatten-sequence (function).
gen-alt-2-full-termcheck-closure (function).
gen-alt-2-no-termcheck-closure (function).
gen-alt-2-simple-termcheck-1-closure (function).
gen-alt-2-simple-termcheck-2-closure (function).
gen-alt-no-termcheck-closure (function).
gen-any-closure (function).
gen-backmatch-closure (function).
gen-casealt-closure (function).
gen-cclass-2-closure (function).
gen-cclass-2-greedy-kleene-closure (function).
gen-cclass-closure (function).
gen-cclass-greedy-kleene-closure (function).
gen-char-closure (function).
gen-char-greedy-kleene-closure (function).
gen-classseq-closure (function).
gen-closure (function).
gen-closures (function).
gen-endanchor-closure (function).
gen-hook-closure (function).
gen-instr-list (function).
gen-left-rstart-closure (function).
gen-not-cclass-2-closure (function).
gen-not-cclass-2-greedy-kleene-closure (function).
gen-not-cclass-closure (function).
gen-not-cclass-greedy-kleene-closure (function).
gen-not-char-closure (function).
gen-not-char-greedy-kleene-closure (function).
gen-not-specclass-closure (function).
gen-not-specclass-greedy-kleene-closure (function).
gen-rend-closure (function).
gen-right-rstart-closure (function).
gen-specclass-closure (function).
gen-specclass-greedy-kleene-closure (function).
gen-startanchor-closure (function).
gen-string-closure (function).
gen-success-closure (function).
generate-char-range (function).
get-discriminant-chars-alist (function).
get-spec-pat-fxn (function).
hoist-alt-ends (function).
hoist-alt-prefix (function).
hoist-alt-suffix (function).
improve (function).
improve-once (function).
link-closures (function).
make-anchored-matcher (function).
make-any-node (function).
make-casealt-jmptable (function).
make-casealt-node-args (function).
make-casealt-node-list (function).
make-classseq-node (function).
make-closure-info (function).
make-discriminant-char-alist (function).
make-init-closure (function).
make-matcher (function).
make-nontext-closure (macro).
make-re-scanner (function).
make-text-closure (macro).
match-str-all-parms (function).
matcher-acceptfn (reader).
(setf matcher-acceptfn) (writer).
matcher-matchexpr (reader).
(setf matcher-matchexpr) (writer).
matcher-matchstr (reader).
(setf matcher-matchstr) (writer).
matcher-simple-string-matchfn (reader).
(setf matcher-simple-string-matchfn) (writer).
matcher-string-matchfn (reader).
(setf matcher-string-matchfn) (writer).
newly-compiled-expr-matcher (function).
newly-compiled-str-matcher (function).
next (function).
nextchar (function).
nullable-pattern-p (function).
obviously-nullable-pattern (function).
odigitp (function).
optimize-regex-tree (function).
parse-char-class (function).
parse-char-class-contents (function).
parse-concat (function).
parse-group (function).
parse-quant (function).
parse-regex (function).
parse-std-char-class (function).
parse-term (function).
parse-union (function).
partition-charclass-alt (function).
partition-charclass-sequence (function).
partition-on-leading-char (function).
partition-string-sequence (function).
positive-charclass-node-p (function).
punctp (function).
quantify (function).
re-scanner (function).
re-scanner (structure).
re-scanner-end (reader).
(setf re-scanner-end) (writer).
re-scanner-mode (reader).
(setf re-scanner-mode) (writer).
re-scanner-p (function).
re-scanner-pos (reader).
(setf re-scanner-pos) (writer).
re-scanner-regnum (reader).
(setf re-scanner-regnum) (writer).
re-scanner-str (reader).
(setf re-scanner-str) (writer).
re-scanner-ungot-token (reader).
(setf re-scanner-ungot-token) (writer).
re-scanner-ungot-value (reader).
(setf re-scanner-ungot-value) (writer).
resolve-initfn (function).
resolve-instr (function).
resolve-linkfn (function).
safer-some (function).
scan-num (function).
scan-range-bounds (function).
scan-str-all-parms (function).
select-alt-instrs (function).
select-casealt-instr (function).
select-char-instr (function).
select-charclass-instr (function).
select-classseq-instr (function).
select-greedy-kleene-instr (function).
select-greedy-optional-instr (function).
select-instructions (function).
select-negated-charclass-instr (function).
select-negated-specclass-instr (function).
select-nongreedy-kleene-instr (function).
select-nongreedy-optional-instr (function).
select-sequence-instrs (function).
select-specclass-instr (function).
select-string-instr (function).
seq-butlast (function).
seq-first (function).
seq-first-char (function).
seq-last (function).
seq-rest (function).
show-tokens (function).
simplify (function).
simplify-once (function).
sort-lc-pred (function).
spacep (function).
special-class (function).
split-alts (function).
split-alts-aux (function).
string-seq-p (function).
subalt-if-necessary (function).
testcomp (function).
testmatch (function).
text-node-p (function).
tree-any (function).
uncached-compile-expr (function).
uncached-compile-str (function).
unget (function).
ungetchar (function).
unregister (function).
worth-alt-case-partitioning-p (function).
xdigitp (function).
regex-testcommon-lisp.
regex.
*regexp-tests* (special variable).
coveragetest (function).
respeedtest (function).
run-sebastien-tests (function).
run-tests (function).
speedtest (function).
strcmpspeedtest (function).
test (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Parse a string regex expression, and compile it into matcher object. Uses the pattern cache.
Parse a string regex expression, and compile it into matcher object. Uses the pattern cache.
Run a matcher against a candidate string, without scanning
(so it is implicitly anchored). Returns (values t start end regs) on
success, nil on failure.
Parse a string into a parse tree.
Run a matcher against a candidate string, scanning forward if necessary. Returns (values t start end regs) on success, nil on failure.
Max number of entries in the regex compiler cache.
Expand an encoded char class into an explicit enumeration of all the chars, e.g. ’a-fA-F’ –> ’abcdefABCDEF’.
Return the function to test for the special pattern?
Is this character an octal digit?
Is this character a punctuation mark?
Parse a string regex expression into a regex parse tree.
Is this character some type of whitespace?
Is it worth partitioning an alt into a case-alt?
Is this character a hexidecimal digit?
structure-object.
string
""
fixnum
0
fixnum
0
symbol
(quote regex::in-regex)
fixnum
0
| Jump to: | (
A B C D E F G H I K L M N O P Q R S T U W X |
|---|
| Jump to: | (
A B C D E F G H I K L M N O P Q R S T U W X |
|---|
| Jump to: | *
+
A C E I L M N P R S U |
|---|
| Jump to: | *
+
A C E I L M N P R S U |
|---|
| Jump to: | C F G M O P R S |
|---|
| Jump to: | C F G M O P R S |
|---|