The recursive-regex Reference Manual

This is the recursive-regex Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:30:42 2018 GMT+0.

1 Introduction

recursive-regex

This library integrates with CL-PPCRE to make named regex groups dispatch to custom matcher functions, which can recursively call another regex in the context of the original regex. It can then return a (parse) tree of results.

Some advantages of this approach

Modularize common regexp patterns so more reuse can be had
Allow non-regular expression matches by defering to custom match functions
Named groups matched in * expressions return all their results rather than the last match only (full parse tree of results, based on the named dispatchers)
Easy to expand your extant regular expressions to return better results (ie, I don't need to replce cl-ppcre with some parse, I can just keep using cl-ppcre)

Some disadvantages of this approach

Currently doesnt support a streaming interface
Not as well founded theoretically as other parser kits (ie: there are no shift/reduce or reduce/reduce errors flagged)
Not tested or optimized for performance.

Minor Example:

 (regex-recursive-groups #?r"function\s*(?<parens>)"
     "looking for function(call(), 1 ,2) type things")
 >> #<RESULT-NODE ROOT s:12 e:34 kids:1 "function(call(), 1 ,2)"  {1003341731}>
    (:ROOT "function(call(), 1 ,2)"
      (:MATCHED-PARENS "(call(), 1 ,2)"))

NB: Currently returns clos object trees and lisp-trees, because I want to play with it in the repl and see results but in practicality the CLOS result is probably what I want to work with.

Pre-Defined Dispatchers

body: 
    can be used in a definition to designate where the body 
    matcher should start matching. You can also provide a default
    body by specifying a regex inside the body in a definition.

parens, brackets, braces, angels:
    these all match a single matched pair 
    eg, for parens:
    not in the match (in (the) match) not in the match

single-quotes, double-quotes:
    single-quotes and double-quotes respect a single backslash as escape

comma-list: 
    [\t ]*(?:(?<body>[^,]*)[\t ]*,)*[\t ]*(?<body>[^,]*)[\t ]*
    the comma-list definition is (?<body>) separated by commas with
    arbitrary whitespace surrounding them. The default value of the
    body regex os [^,]*

csv-row:
    (?<comma-list>((?<double-quotes>)|[^\n,]*))(?:\n|$)
    calls the comma-list matcher passing in the body
    double-quotes-matcher or not new line or comma repeating

Recursive Regular Expressions Elsewhere

I'm obviously not the first person to think this idea would be neat

Balanced capture groups
This blog post talks about balanced expressions available in .net
Perl Docs for balanced capture groups
Perl, leading the way in hackery as ever has a couple of different ways to embed regexps' recursively
A blog post discussing embedding a PERL regexp inside its own definition
Perl recursive patterns

Authors

;; Copyright (c) 2011 Russ Tyndall, 
;;   Acceleration.net http://www.acceleration.net
;; All rights reserved.
;;
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
;;
;;  - Redistributions of source code must retain the above copyright
;;    notice, this list of conditions and the following disclaimer.
;;
;;  - Redistributions in binary form must reproduce the above copyright
;;    notice, this list of conditions and the following disclaimer in the
;;    documentation and/or other materials provided with the distribution.
;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;; A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 `recursive-regex`

License

BSD

Description

Recursive regular expression parsing engine

Version

0.1

Dependencies

iterate
anaphora
cl-interpol
cl-ppcre
alexandria
symbol-munger

Source

recursive-regex.asd (file)

Components

rec-regex.lisp (file)
rex-reader.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 `recursive-regex.asd`

Location: recursive-regex.asd
Systems: recursive-regex (system)
Packages: recursive-regex.system

3.1.2 `recursive-regex/rec-regex.lisp`

Parent

recursive-regex (system)

Location

rec-regex.lisp

Packages

recursive-regex

Exported Definitions

*case-insensitive* (special variable)
*dispatchers* (special variable)
add-body-matcher (function)
add-matched-pair-matcher (function)
add-named-regex-matcher (function)
clear-dispatchers (function)
create-recursive-scanner (function)
end (method)
(setf end) (method)
full-match (method)
(setf full-match) (method)
groups (method)
(setf groups) (method)
kids (method)
(setf kids) (method)
make-default-dispatch-table (function)
name (method)
(setf name) (method)
regex-recursive-groups (function)
result-node (function)
result-node (class)
start (method)
(setf start) (method)
treeify-regex-results (function)

Internal Definitions

%collect-groups-to-tree (function)
%make-dispatcher (function)
%trace-log (function)
%tracer (function)
*body-regex* (special variable)
*minimize-results* (special variable)
*trace-depth* (special variable)
*trace-parse* (special variable)
*uncompiled-br* (special variable)
continue-matching (function)
convert-to-full-match (function)
data (method)
(setf data) (method)
def-traced-matcher-lambda (macro)
devoid (function)
dispatch-fn (function)
inner-match (function)
inner-match (condition)
make-body-matcher (function)
make-displaced-array (function)
make-matched-pair-matcher (function)
make-named-regex-matcher (function)
trace-log (macro)
tracer (macro)
with-child-pusher (macro)

3.1.3 `recursive-regex/rex-reader.lisp`

Parent

recursive-regex (system)

Location

rex-reader.lisp

Exported Definitions

read-rex-file-to-dispatchers (function)

Internal Definitions

+end-of-defs+ (special variable)
+option+ (special variable)
+option-case-insensitive+ (special variable)
+production-split+ (special variable)
end-of-defs? (function)
handle-quoted-rules (function)
option-ci? (function)
option? (function)
process-rex-def (function)
replace-all (function)
replace-expansions (function)
trimmed-readline (function)
unescaped-quote-pos (function)

4 Packages

Packages are listed by definition order.

4.1 `recursive-regex.system`

Source

recursive-regex.asd

Use List

asdf/interface
common-lisp

4.2 `recursive-regex`

Source

rec-regex.lisp (file)

Nicknames

rec-regex
recex

Use List

anaphora
iterate
common-lisp-user
common-lisp

Exported Definitions

*case-insensitive* (special variable)
*dispatchers* (special variable)
add-body-matcher (function)
add-matched-pair-matcher (function)
add-named-regex-matcher (function)
clear-dispatchers (function)
create-recursive-scanner (function)
end (generic function)
end (method)
(setf end) (method)
(setf end) (generic function)
full-match (generic function)
full-match (method)
(setf full-match) (method)
(setf full-match) (generic function)
groups (generic function)
groups (method)
(setf groups) (method)
(setf groups) (generic function)
kids (generic function)
kids (method)
(setf kids) (method)
(setf kids) (generic function)
make-default-dispatch-table (function)
name (generic function)
name (method)
(setf name) (method)
(setf name) (generic function)
read-rex-file-to-dispatchers (function)
regex-recursive-groups (function)
result-node (function)
result-node (class)
start (generic function)
start (method)
(setf start) (method)
(setf start) (generic function)
treeify-regex-results (function)

Internal Definitions

%collect-groups-to-tree (function)
%make-dispatcher (function)
%trace-log (function)
%tracer (function)
*body-regex* (special variable)
*minimize-results* (special variable)
*trace-depth* (special variable)
*trace-parse* (special variable)
*uncompiled-br* (special variable)
+end-of-defs+ (special variable)
+option+ (special variable)
+option-case-insensitive+ (special variable)
+production-split+ (special variable)
continue-matching (function)
convert-to-full-match (function)
data (generic function)
data (method)
(setf data) (method)
(setf data) (generic function)
def-traced-matcher-lambda (macro)
devoid (function)
dispatch-fn (function)
end-of-defs? (function)
handle-quoted-rules (function)
inner-match (function)
inner-match (condition)
make-body-matcher (function)
make-displaced-array (function)
make-matched-pair-matcher (function)
make-named-regex-matcher (function)
option-ci? (function)
option? (function)
process-rex-def (function)
replace-all (function)
replace-expansions (function)
trace-log (macro)
tracer (macro)
trimmed-readline (function)
unescaped-quote-pos (function)
with-child-pusher (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *case-insensitive*

Package: recursive-regex
Source: rec-regex.lisp (file)

Special Variable: *dispatchers*

Package: recursive-regex
Source: rec-regex.lisp (file)

5.1.2 Functions

Function: add-body-matcher NAME

Add a new body matcher that dispatches on name

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: add-matched-pair-matcher NAME OPEN CLOSE &optional ESCAPE

Add a matched pair matcher dispatched on name

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: add-named-regex-matcher NAME REGEX

Add a new dispatcher on name to child regex

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: clear-dispatchers ()

removes all the dispatchers

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: create-recursive-scanner REGEX &optional FUNCTION-TABLE &aux *ALLOW-NAMED-REGISTERS* *DISPATCHERS*

Allows named registers to refer to functions that should be in the place of the named register

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: make-default-dispatch-table ()

Creates a default dispatch table with a parens dispatcher that can match pairs of parentheses

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: read-rex-file-to-dispatchers FILE &aux CI? DEFS DONE-WITH-DEFS? *ALLOW-NAMED-REGISTERS*

reads a set of definitions in from a rex file, calls add-named-regex-matcher for each production name => regex

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: regex-recursive-groups REGEX TARGET &key DISPATCHERS TREE-RESULTS? &aux *DISPATCHERS* RES

run a recursive regular expression and gather all the results for each of them into a tree

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: result-node NAME START END &optional TARGET GROUPS KIDS

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: treeify-regex-results TREE

Make a lisp tree of the results of the matches from the clos tree

Package: recursive-regex
Source: rec-regex.lisp (file)

5.1.3 Generic functions

Generic Function: end OBJECT

Generic Function: (setf end) NEW-VALUE OBJECT

Package

recursive-regex

Methods

Method: end (RESULT-NODE result-node)

automatically generated reader method

Source: rec-regex.lisp (file)

Method: (setf end) NEW-VALUE (RESULT-NODE result-node)

automatically generated writer method

Source: rec-regex.lisp (file)

Generic Function: full-match OBJECT

Generic Function: (setf full-match) NEW-VALUE OBJECT

Package

recursive-regex

Methods

Method: full-match (RESULT-NODE result-node)

automatically generated reader method

Source: rec-regex.lisp (file)

Method: (setf full-match) NEW-VALUE (RESULT-NODE result-node)

automatically generated writer method

Source: rec-regex.lisp (file)

Generic Function: groups OBJECT

Generic Function: (setf groups) NEW-VALUE OBJECT

Package

recursive-regex

Methods

Method: groups (RESULT-NODE result-node)

automatically generated reader method

Source: rec-regex.lisp (file)

Method: (setf groups) NEW-VALUE (RESULT-NODE result-node)

automatically generated writer method

Source: rec-regex.lisp (file)

Generic Function: kids OBJECT

Generic Function: (setf kids) NEW-VALUE OBJECT

Package

recursive-regex

Methods

Method: kids (RESULT-NODE result-node)

automatically generated reader method

Source: rec-regex.lisp (file)

Method: (setf kids) NEW-VALUE (RESULT-NODE result-node)

automatically generated writer method

Source: rec-regex.lisp (file)

Generic Function: name OBJECT

Generic Function: (setf name) NEW-VALUE OBJECT

Package

recursive-regex

Methods

Method: name (RESULT-NODE result-node)

automatically generated reader method

Source: rec-regex.lisp (file)

Method: (setf name) NEW-VALUE (RESULT-NODE result-node)

automatically generated writer method

Source: rec-regex.lisp (file)

Generic Function: start OBJECT

Generic Function: (setf start) NEW-VALUE OBJECT

Package

recursive-regex

Methods

Method: start (RESULT-NODE result-node)

automatically generated reader method

Source: rec-regex.lisp (file)

Method: (setf start) NEW-VALUE (RESULT-NODE result-node)

automatically generated writer method

Source: rec-regex.lisp (file)

5.1.4 Classes

Class: result-node ()

Package

recursive-regex

Source

rec-regex.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

print-object (method)
kids (method)
kids (method)
groups (method)
groups (method)
full-match (method)
full-match (method)
end (method)
end (method)
start (method)
start (method)
name (method)
name (method)

Direct slots

Slot: name

Initargs: :name
Readers: name (generic function)
Writers: (setf name) (generic function)

Slot: start

Initargs: :start
Readers: start (generic function)
Writers: (setf start) (generic function)

Slot: end

Initargs: :end
Readers: end (generic function)
Writers: (setf end) (generic function)

Slot: full-match

Initargs: :full-match
Readers: full-match (generic function)
Writers: (setf full-match) (generic function)

Slot: groups

Initargs: :groups
Readers: groups (generic function)
Writers: (setf groups) (generic function)

Slot: kids

Initargs: :kids
Readers: kids (generic function)
Writers: (setf kids) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *body-regex*

Package: recursive-regex
Source: rec-regex.lisp (file)

Special Variable: *minimize-results*

Package: recursive-regex
Source: rec-regex.lisp (file)

Special Variable: *trace-depth*

Package: recursive-regex
Source: rec-regex.lisp (file)

Special Variable: *trace-parse*

Package: recursive-regex
Source: rec-regex.lisp (file)

Special Variable: *uncompiled-br*

Package: recursive-regex
Source: rec-regex.lisp (file)

Special Variable: +end-of-defs+

Package: recursive-regex
Source: rex-reader.lisp (file)

Special Variable: +option+

Package: recursive-regex
Source: rex-reader.lisp (file)

Special Variable: +option-case-insensitive+

Package: recursive-regex
Source: rex-reader.lisp (file)

Special Variable: +production-split+

Package: recursive-regex
Source: rex-reader.lisp (file)

5.2.2 Macros

Macro: def-traced-matcher-lambda (POS-NAME NAME &rest REST-TRACING) &body BODY

Package: recursive-regex
Source: rec-regex.lisp (file)

Macro: trace-log MSG &rest ARGS

Package: recursive-regex
Source: rec-regex.lisp (file)

Macro: tracer &rest ARGS

Package: recursive-regex
Source: rec-regex.lisp (file)

Macro: with-child-pusher (PLACE) &body BODY

pushes child-matches into the place and continues-matching discards results that have been backtracked passed

Package: recursive-regex
Source: rec-regex.lisp (file)

5.2.3 Functions

Function: %collect-groups-to-tree NAME SCANNER TARGET &optional START END OUTER-MATCH-START OUTER-MATCH-END &aux CHILDREN

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: %make-dispatcher NAME BODY-REGEX FUNCTION-TABLE

Whenever we meet a named group, change it to a named dispatcher if we find it in the list we use that matcher, otherwise we use a body matcher.

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: %trace-log MSG &rest ARGS

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: %tracer LABEL NAME POS MATCH-END &key DATA LEVEL

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: continue-matching &optional C

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: convert-to-full-match REGEX

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: devoid REGEX

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: dispatch-fn NAME &optional FUNCTION-TABLE

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: end-of-defs? LINE

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: handle-quoted-rules REGEX &aux IDX IDX2 START

quotes in rex productions should be direct string matches (not regex)

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: inner-match DATA

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: make-body-matcher &optional NAME

Handles matching the body of a named regular expression

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: make-displaced-array ARRAY &optional START END

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: make-matched-pair-matcher NAME OPEN-CHAR CLOSE-CHAR &optional ESCAPE

Will create a regex filter that can match arbitrary pairs of matched characters such as (start (other () some) end)

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: make-named-regex-matcher NAME NAMED-REGEX

Handles matching by delegating to another named regular expression

Package: recursive-regex
Source: rec-regex.lisp (file)

Function: option-ci? LINE

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: option? LINE

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: process-rex-def NAME REGEX DEFS

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: replace-all STRING PART REPLACEMENT &key TEST STREAM

Returns a new string in which all the occurences of the part
is replaced with replacement. [FROM http://cl-cookbook.sourceforge.net/strings.html#manip]

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: replace-expansions DEFS NEW-REGEX

If we encounter {name} style definitions in the right hand side replace them with their text (regex fragment) value

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: trimmed-readline STREAM &optional EOF-ERROR-P EOF-VALUE RECURSIVE-P

read a line and trim it, if it is empty return nil instead of empty string

Package: recursive-regex
Source: rex-reader.lisp (file)

Function: unescaped-quote-pos S START

find the index of an unescaped quote

Package: recursive-regex
Source: rex-reader.lisp (file)

5.2.4 Generic functions

Generic Function: data CONDITION

Generic Function: (setf data) NEW-VALUE CONDITION

Package

recursive-regex

Methods

Method: data (CONDITION inner-match)

Method: (setf data) NEW-VALUE (CONDITION inner-match)

Source: rec-regex.lisp (file)

5.2.5 Conditions

Condition: inner-match ()

Package

recursive-regex

Source

rec-regex.lisp (file)

Direct superclasses

condition (condition)

Direct methods

data (method)
data (method)

Direct slots

Slot: data

Initargs: :data
Initform: (quote nil)
Readers: data (generic function)
Writers: (setf data) (generic function)

Appendix A Indexes

A.1 Concepts

Jump to:	F L R

	Index Entry	Section

F
	File, Lisp, `recursive-regex.asd`:	The recursive-regex<dot>asd file
	File, Lisp, `recursive-regex/rec-regex.lisp`:	The recursive-regex/rec-regex<dot>lisp file
	File, Lisp, `recursive-regex/rex-reader.lisp`:	The recursive-regex/rex-reader<dot>lisp file

L
	Lisp File, `recursive-regex.asd`:	The recursive-regex<dot>asd file
	Lisp File, `recursive-regex/rec-regex.lisp`:	The recursive-regex/rec-regex<dot>lisp file
	Lisp File, `recursive-regex/rex-reader.lisp`:	The recursive-regex/rex-reader<dot>lisp file

R
	`recursive-regex.asd`:	The recursive-regex<dot>asd file
	`recursive-regex/rec-regex.lisp`:	The recursive-regex/rec-regex<dot>lisp file
	`recursive-regex/rex-reader.lisp`:	The recursive-regex/rex-reader<dot>lisp file

Jump to:	F L R

A.2 Functions

Jump to:	% ( A C D E F G H I K M N O P R S T U W

	Index Entry	Section

%
	`%collect-groups-to-tree`:	Internal functions
	`%make-dispatcher`:	Internal functions
	`%trace-log`:	Internal functions
	`%tracer`:	Internal functions

(
	`(setf data)`:	Internal generic functions
	`(setf data)`:	Internal generic functions
	`(setf end)`:	Exported generic functions
	`(setf end)`:	Exported generic functions
	`(setf full-match)`:	Exported generic functions
	`(setf full-match)`:	Exported generic functions
	`(setf groups)`:	Exported generic functions
	`(setf groups)`:	Exported generic functions
	`(setf kids)`:	Exported generic functions
	`(setf kids)`:	Exported generic functions
	`(setf name)`:	Exported generic functions
	`(setf name)`:	Exported generic functions
	`(setf start)`:	Exported generic functions
	`(setf start)`:	Exported generic functions

A
	`add-body-matcher`:	Exported functions
	`add-matched-pair-matcher`:	Exported functions
	`add-named-regex-matcher`:	Exported functions

C
	`clear-dispatchers`:	Exported functions
	`continue-matching`:	Internal functions
	`convert-to-full-match`:	Internal functions
	`create-recursive-scanner`:	Exported functions

D
	`data`:	Internal generic functions
	`data`:	Internal generic functions
	`def-traced-matcher-lambda`:	Internal macros
	`devoid`:	Internal functions
	`dispatch-fn`:	Internal functions

E
	`end`:	Exported generic functions
	`end`:	Exported generic functions
	`end-of-defs?`:	Internal functions

F
	`full-match`:	Exported generic functions
	`full-match`:	Exported generic functions
	`Function, %collect-groups-to-tree`:	Internal functions
	`Function, %make-dispatcher`:	Internal functions
	`Function, %trace-log`:	Internal functions
	`Function, %tracer`:	Internal functions
	`Function, add-body-matcher`:	Exported functions
	`Function, add-matched-pair-matcher`:	Exported functions
	`Function, add-named-regex-matcher`:	Exported functions
	`Function, clear-dispatchers`:	Exported functions
	`Function, continue-matching`:	Internal functions
	`Function, convert-to-full-match`:	Internal functions
	`Function, create-recursive-scanner`:	Exported functions
	`Function, devoid`:	Internal functions
	`Function, dispatch-fn`:	Internal functions
	`Function, end-of-defs?`:	Internal functions
	`Function, handle-quoted-rules`:	Internal functions
	`Function, inner-match`:	Internal functions
	`Function, make-body-matcher`:	Internal functions
	`Function, make-default-dispatch-table`:	Exported functions
	`Function, make-displaced-array`:	Internal functions
	`Function, make-matched-pair-matcher`:	Internal functions
	`Function, make-named-regex-matcher`:	Internal functions
	`Function, option-ci?`:	Internal functions
	`Function, option?`:	Internal functions
	`Function, process-rex-def`:	Internal functions
	`Function, read-rex-file-to-dispatchers`:	Exported functions
	`Function, regex-recursive-groups`:	Exported functions
	`Function, replace-all`:	Internal functions
	`Function, replace-expansions`:	Internal functions
	`Function, result-node`:	Exported functions
	`Function, treeify-regex-results`:	Exported functions
	`Function, trimmed-readline`:	Internal functions
	`Function, unescaped-quote-pos`:	Internal functions

G
	`Generic Function, (setf data)`:	Internal generic functions
	`Generic Function, (setf end)`:	Exported generic functions
	`Generic Function, (setf full-match)`:	Exported generic functions
	`Generic Function, (setf groups)`:	Exported generic functions
	`Generic Function, (setf kids)`:	Exported generic functions
	`Generic Function, (setf name)`:	Exported generic functions
	`Generic Function, (setf start)`:	Exported generic functions
	`Generic Function, data`:	Internal generic functions
	`Generic Function, end`:	Exported generic functions
	`Generic Function, full-match`:	Exported generic functions
	`Generic Function, groups`:	Exported generic functions
	`Generic Function, kids`:	Exported generic functions
	`Generic Function, name`:	Exported generic functions
	`Generic Function, start`:	Exported generic functions
	`groups`:	Exported generic functions
	`groups`:	Exported generic functions

H
	`handle-quoted-rules`:	Internal functions

I
	`inner-match`:	Internal functions

K
	`kids`:	Exported generic functions
	`kids`:	Exported generic functions

M
	`Macro, def-traced-matcher-lambda`:	Internal macros
	`Macro, trace-log`:	Internal macros
	`Macro, tracer`:	Internal macros
	`Macro, with-child-pusher`:	Internal macros
	`make-body-matcher`:	Internal functions
	`make-default-dispatch-table`:	Exported functions
	`make-displaced-array`:	Internal functions
	`make-matched-pair-matcher`:	Internal functions
	`make-named-regex-matcher`:	Internal functions
	`Method, (setf data)`:	Internal generic functions
	`Method, (setf end)`:	Exported generic functions
	`Method, (setf full-match)`:	Exported generic functions
	`Method, (setf groups)`:	Exported generic functions
	`Method, (setf kids)`:	Exported generic functions
	`Method, (setf name)`:	Exported generic functions
	`Method, (setf start)`:	Exported generic functions
	`Method, data`:	Internal generic functions
	`Method, end`:	Exported generic functions
	`Method, full-match`:	Exported generic functions
	`Method, groups`:	Exported generic functions
	`Method, kids`:	Exported generic functions
	`Method, name`:	Exported generic functions
	`Method, start`:	Exported generic functions

N
	`name`:	Exported generic functions
	`name`:	Exported generic functions

O
	`option-ci?`:	Internal functions
	`option?`:	Internal functions

P
	`process-rex-def`:	Internal functions

R
	`read-rex-file-to-dispatchers`:	Exported functions
	`regex-recursive-groups`:	Exported functions
	`replace-all`:	Internal functions
	`replace-expansions`:	Internal functions
	`result-node`:	Exported functions

S
	`start`:	Exported generic functions
	`start`:	Exported generic functions

T
	`trace-log`:	Internal macros
	`tracer`:	Internal macros
	`treeify-regex-results`:	Exported functions
	`trimmed-readline`:	Internal functions

U
	`unescaped-quote-pos`:	Internal functions

W
	`with-child-pusher`:	Internal macros

Jump to:	% ( A C D E F G H I K M N O P R S T U W

A.3 Variables

Jump to:	* + D E F G K N S

	Index Entry	Section

*
	`body-regex`:	Internal special variables
	`case-insensitive`:	Exported special variables
	`dispatchers`:	Exported special variables
	`minimize-results`:	Internal special variables
	`trace-depth`:	Internal special variables
	`trace-parse`:	Internal special variables
	`uncompiled-br`:	Internal special variables

+
	`+end-of-defs+`:	Internal special variables
	`+option+`:	Internal special variables
	`+option-case-insensitive+`:	Internal special variables
	`+production-split+`:	Internal special variables

D
	`data`:	Internal conditions

E
	`end`:	Exported classes

F
	`full-match`:	Exported classes

G
	`groups`:	Exported classes

K
	`kids`:	Exported classes

N
	`name`:	Exported classes

S
	`Slot, data`:	Internal conditions
	`Slot, end`:	Exported classes
	`Slot, full-match`:	Exported classes
	`Slot, groups`:	Exported classes
	`Slot, kids`:	Exported classes
	`Slot, name`:	Exported classes
	`Slot, start`:	Exported classes
	`Special Variable, body-regex`:	Internal special variables
	`Special Variable, case-insensitive`:	Exported special variables
	`Special Variable, dispatchers`:	Exported special variables
	`Special Variable, minimize-results`:	Internal special variables
	`Special Variable, trace-depth`:	Internal special variables
	`Special Variable, trace-parse`:	Internal special variables
	`Special Variable, uncompiled-br`:	Internal special variables
	`Special Variable, +end-of-defs+`:	Internal special variables
	`Special Variable, +option+`:	Internal special variables
	`Special Variable, +option-case-insensitive+`:	Internal special variables
	`Special Variable, +production-split+`:	Internal special variables
	`start`:	Exported classes

Jump to:	* + D E F G K N S

A.4 Data types

Jump to:	C I P R S

	Index Entry	Section

C
	`Class, result-node`:	Exported classes
	`Condition, inner-match`:	Internal conditions

I
	`inner-match`:	Internal conditions

P
	`Package, recursive-regex`:	The recursive-regex package
	`Package, recursive-regex.system`:	The recursive-regex<dot>system package

R
	`recursive-regex`:	The recursive-regex system
	`recursive-regex`:	The recursive-regex package
	`recursive-regex.system`:	The recursive-regex<dot>system package
	`result-node`:	Exported classes

S
	`System, recursive-regex`:	The recursive-regex system

Jump to:	C I P R S

• Introduction:		What recursive-regex is all about
• Systems:		The systems documentation
• Files:		The files documentation
• Packages:		The packages documentation
• Definitions:		The symbols documentation
• Indexes:		Concepts, functions, variables and data types

• Exported special variables:
• Exported functions:
• Exported generic functions:
• Exported classes:

• Internal special variables:
• Internal macros:
• Internal functions:
• Internal generic functions:
• Internal conditions:

• Concept index:
• Function index:
• Variable index:
• Data type index:

• The recursive-regex.asd file:
• The recursive-regex/rec-regex.lisp file:
• The recursive-regex/rex-reader.lisp file:

• The recursive-regex.system package:
• The recursive-regex package:

The recursive-regex Reference Manual

Table of Contents

The recursive-regex Reference Manual

1 Introduction

recursive-regex

Some advantages of this approach

Some disadvantages of this approach

Minor Example:

Pre-Defined Dispatchers

Recursive Regular Expressions Elsewhere

Authors

2 Systems

2.1 recursive-regex

3 Files

3.1 Lisp

3.1.1 recursive-regex.asd

3.1.2 recursive-regex/rec-regex.lisp

3.1.3 recursive-regex/rex-reader.lisp

4 Packages

4.1 recursive-regex.system

4.2 recursive-regex

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Functions

5.1.3 Generic functions

5.1.4 Classes

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Macros

5.2.3 Functions

5.2.4 Generic functions

5.2.5 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `recursive-regex`

3.1.1 `recursive-regex.asd`

3.1.2 `recursive-regex/rec-regex.lisp`

3.1.3 `recursive-regex/rex-reader.lisp`

4.1 `recursive-regex.system`

4.2 `recursive-regex`