The esrap-peg Reference Manual

This is the esrap-peg Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:44:43 2018 GMT+0.

1 Introduction

Esrap-PEG is a thin wrapper on top of Esrap that uses Esrap to 
parse PEG grammars and can use the resulting AST to define rules
for an Esrap parser that parses the PEG grammar in question.

See http://pdos.csail.mit.edu/~baford/packrat/popl04/peg-popl04.pdf
and http://pdos.csail.mit.edu/~baford/packrat/ for more information.

I use the canonical PEG definition with two exceptions. First,
I allow octal escape \377 (original article says [0-2] for the
first digit for some reason). Second, I allow \u followed by
4 hexadecimal digits for full Unicode escape.

The library provides means to parse PEG syntax, to define rules
in run-time without compiling any closures and to generate code
that implements the rules in compiled module.

It does a walk around the tree to define rules or to return code
defining the rules.

This parser uses the same permissive license as Esrap.

Licence:

 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation files
 (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge,
 publish, distribute, sublicense, and/or sell copies of the Software,
 and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

2 Systems

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

2.1 `esrap-peg`

Author

Michael Raskin

License

MIT

Description

A wrapper around Esrap to allow generating Esrap grammars from PEG definitions

Dependencies

esrap
iterate
cl-unification
alexandria

Source

esrap-peg.asd (file)

Components

package.lisp (file)
util.lisp (file)
peg.lisp (file)
peg-functions.lisp (file)
peg-on-the-fly.lisp (file)
peg-compile.lisp (file)
pattern-processing.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 `esrap-peg.asd`

Location: esrap-peg.asd
Systems: esrap-peg (system)

3.1.2 `esrap-peg/package.lisp`

Parent: esrap-peg (system)
Location: package.lisp
Packages: esrap-peg

3.1.3 `esrap-peg/util.lisp`

Dependency

package.lisp (file)

Parent

esrap-peg (system)

Location

util.lisp

Internal Definitions

file-contents (function)
stream-contents (function)

3.1.4 `esrap-peg/peg.lisp`

Dependency

package.lisp (file)

Parent

esrap-peg (system)

Location

peg.lisp

Internal Definitions

*character-class-storage* (special variable)
*range-list* (special variable)
character-class-rule (macro)
def-ast-rule (macro)
define-character-classes (macro)
semantic-checker␣for␣character␣class␣with␣clauses␣(#\n␣#\r␣#\t␣#\'␣#\"␣#\[␣#\]↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣#\\)␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\3))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\7))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9)␣(#\a␣#\f)↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣(#\a␣#\f))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\a␣#\z)␣(#\a␣#\z)␣#\_)␣ (function)
temporary␣function␣to␣add␣symbol␣and␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣char␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣class␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣close␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣comment␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣definition␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣dot␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣endoffile␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣endofline␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣expression␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣grammar␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣identcont␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣identifier␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣identstart␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣leftarrow␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣literal␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣not␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣open␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣plus␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣prefix␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣primary␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣question␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣range␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣sequence␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣slash␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣space␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣spacing␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣star␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣suffix␣into␣ast (function)
to-text (function)

3.1.5 `esrap-peg/peg-functions.lisp`

Dependencies

package.lisp (file)
util.lisp (file)
peg.lisp (file)

Parent

esrap-peg (system)

Location

peg-functions.lisp

Exported Definitions

basic-parse-peg (function)
parse-peg-file (function)

3.1.6 `esrap-peg/peg-on-the-fly.lisp`

Dependency

package.lisp (file)

Parent

esrap-peg (system)

Location

peg-on-the-fly.lisp

Exported Definitions

ast-eval (function)
def-peg-fun (macro)

Internal Definitions

character-range-definer (special variable)
rule-creator (special variable)

3.1.7 `esrap-peg/peg-compile.lisp`

Dependencies

package.lisp (file)
peg-on-the-fly.lisp (file)

Parent

esrap-peg (system)

Location

peg-compile.lisp

Exported Definitions

peg-code (function)
peg-compile (macro)

3.1.8 `esrap-peg/pattern-processing.lisp`

Dependency

package.lisp (file)

Parent

esrap-peg (system)

Location

pattern-processing.lisp

Exported Definitions

*esrap-peg-matcher-default-abbreviations* (special variable)
*esrap-peg-pattern-package* (special variable)
add-peg-order-rule (function)
def-peg-matchers (macro)
delete-peg-order-rule (function)

Internal Definitions

abbreviations-into-package (function)
esrap-peg-symbol (function)

4 Packages

Packages are listed by definition order.

4.1 `esrap-peg`

Source

package.lisp (file)

Use List

iterate
esrap
common-lisp

Exported Definitions

*esrap-peg-matcher-default-abbreviations* (special variable)
*esrap-peg-pattern-package* (special variable)
add-peg-order-rule (function)
ast-eval (function)
basic-parse-peg (function)
def-peg-fun (macro)
def-peg-matchers (macro)
delete-peg-order-rule (function)
parse-peg-file (function)
peg-code (function)
peg-compile (macro)

Internal Definitions

*character-class-storage* (special variable)
*range-list* (special variable)
abbreviations-into-package (function)
character-class-rule (macro)
character-range-definer (special variable)
def-ast-rule (macro)
define-character-classes (macro)
esrap-peg-symbol (function)
file-contents (function)
rule-creator (special variable)
semantic-checker␣for␣character␣class␣with␣clauses␣(#\n␣#\r␣#\t␣#\'␣#\"␣#\[␣#\]↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣#\\)␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\3))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\7))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9)␣(#\a␣#\f)↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣(#\a␣#\f))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9))␣ (function)
semantic-checker␣for␣character␣class␣with␣clauses␣((#\a␣#\z)␣(#\a␣#\z)␣#\_)␣ (function)
stream-contents (function)
temporary␣function␣to␣add␣symbol␣and␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣char␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣class␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣close␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣comment␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣definition␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣dot␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣endoffile␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣endofline␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣expression␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣grammar␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣identcont␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣identifier␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣identstart␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣leftarrow␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣literal␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣not␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣open␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣plus␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣prefix␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣primary␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣question␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣range␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣sequence␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣slash␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣space␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣spacing␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣star␣into␣ast (function)
temporary␣function␣to␣add␣symbol␣suffix␣into␣ast (function)
to-text (function)

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: *esrap-peg-matcher-default-abbreviations*

Package: esrap-peg
Source: pattern-processing.lisp (file)

Special Variable: *esrap-peg-pattern-package*

Package: esrap-peg
Source: pattern-processing.lisp (file)

5.1.2 Macros

Macro: def-peg-fun NAME (ARG) &rest CODE

Package: esrap-peg
Source: peg-on-the-fly.lisp (file)

Macro: def-peg-matchers CLAUSES &key ABBREVIATIONS PACKAGE ARG

Package: esrap-peg
Source: pattern-processing.lisp (file)

Macro: peg-compile G

Package: esrap-peg
Source: peg-compile.lisp (file)

5.1.3 Functions

Function: add-peg-order-rule NODE BEFORE AFTER

Package: esrap-peg
Source: pattern-processing.lisp (file)

Function: ast-eval X

Package: esrap-peg
Source: peg-on-the-fly.lisp (file)

Function: basic-parse-peg G

Package: esrap-peg
Source: peg-functions.lisp (file)

Function: delete-peg-order-rule NODE BEFORE AFTER

Package: esrap-peg
Source: pattern-processing.lisp (file)

Function: parse-peg-file F

Package: esrap-peg
Source: peg-functions.lisp (file)

Function: peg-code G

Package: esrap-peg
Source: peg-compile.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *character-class-storage*

Package: esrap-peg
Source: peg.lisp (file)

Special Variable: *range-list*

Package: esrap-peg
Source: peg.lisp (file)

Special Variable: character-range-definer

Package: esrap-peg
Source: peg-on-the-fly.lisp (file)

Special Variable: rule-creator

Package: esrap-peg
Source: peg-on-the-fly.lisp (file)

5.2.2 Macros

Macro: character-class-rule &rest CLAUSES

Package: esrap-peg
Source: peg.lisp (file)

Macro: def-ast-rule NAME &rest PARAMS

Package: esrap-peg
Source: peg.lisp (file)

Macro: define-character-classes ()

Package: esrap-peg
Source: peg.lisp (file)

5.2.3 Functions

Function: abbreviations-into-package L &optional PACKAGE

Package: esrap-peg
Source: pattern-processing.lisp (file)

Function: esrap-peg-symbol X

Package: esrap-peg
Source: pattern-processing.lisp (file)

Function: file-contents FN

Package: esrap-peg
Source: util.lisp (file)

Function: semantic-checker␣for␣character␣class␣with␣clauses␣(#\n␣#\r␣#\t␣#\'␣#\"␣#\[␣#\]↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣#\\)␣ X

Package: esrap-peg
Source: peg.lisp (file)

Function: semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\3))␣ X

Package: esrap-peg
Source: peg.lisp (file)

Function: semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\7))␣ X

Package: esrap-peg
Source: peg.lisp (file)

Function: semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9)␣(#\a␣#\f)↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣(#\a␣#\f))␣ X

Package: esrap-peg
Source: peg.lisp (file)

Function: semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9))␣ X

Package: esrap-peg
Source: peg.lisp (file)

Function: semantic-checker␣for␣character␣class␣with␣clauses␣((#\a␣#\z)␣(#\a␣#\z)␣#\_)␣ X

Package: esrap-peg
Source: peg.lisp (file)

Function: stream-contents F

Package: esrap-peg
Source: util.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣and␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣char␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣class␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣close␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣comment␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣definition␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣dot␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣endoffile␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣endofline␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣expression␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣grammar␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣identcont␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣identifier␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣identstart␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣leftarrow␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣literal␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣not␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣open␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣plus␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣prefix␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣primary␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣question␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣range␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣sequence␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣slash␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣space␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣spacing␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣star␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: temporary␣function␣to␣add␣symbol␣suffix␣into␣ast X &rest POS

Package: esrap-peg
Source: peg.lisp (file)

Function: to-text STR START END

Package: esrap-peg
Source: peg.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	E F L

	Index Entry	Section

E
	`esrap-peg.asd`:	The esrap-peg<dot>asd file
	`esrap-peg/package.lisp`:	The esrap-peg/package<dot>lisp file
	`esrap-peg/pattern-processing.lisp`:	The esrap-peg/pattern-processing<dot>lisp file
	`esrap-peg/peg-compile.lisp`:	The esrap-peg/peg-compile<dot>lisp file
	`esrap-peg/peg-functions.lisp`:	The esrap-peg/peg-functions<dot>lisp file
	`esrap-peg/peg-on-the-fly.lisp`:	The esrap-peg/peg-on-the-fly<dot>lisp file
	`esrap-peg/peg.lisp`:	The esrap-peg/peg<dot>lisp file
	`esrap-peg/util.lisp`:	The esrap-peg/util<dot>lisp file

F
	File, Lisp, `esrap-peg.asd`:	The esrap-peg<dot>asd file
	File, Lisp, `esrap-peg/package.lisp`:	The esrap-peg/package<dot>lisp file
	File, Lisp, `esrap-peg/pattern-processing.lisp`:	The esrap-peg/pattern-processing<dot>lisp file
	File, Lisp, `esrap-peg/peg-compile.lisp`:	The esrap-peg/peg-compile<dot>lisp file
	File, Lisp, `esrap-peg/peg-functions.lisp`:	The esrap-peg/peg-functions<dot>lisp file
	File, Lisp, `esrap-peg/peg-on-the-fly.lisp`:	The esrap-peg/peg-on-the-fly<dot>lisp file
	File, Lisp, `esrap-peg/peg.lisp`:	The esrap-peg/peg<dot>lisp file
	File, Lisp, `esrap-peg/util.lisp`:	The esrap-peg/util<dot>lisp file

L
	Lisp File, `esrap-peg.asd`:	The esrap-peg<dot>asd file
	Lisp File, `esrap-peg/package.lisp`:	The esrap-peg/package<dot>lisp file
	Lisp File, `esrap-peg/pattern-processing.lisp`:	The esrap-peg/pattern-processing<dot>lisp file
	Lisp File, `esrap-peg/peg-compile.lisp`:	The esrap-peg/peg-compile<dot>lisp file
	Lisp File, `esrap-peg/peg-functions.lisp`:	The esrap-peg/peg-functions<dot>lisp file
	Lisp File, `esrap-peg/peg-on-the-fly.lisp`:	The esrap-peg/peg-on-the-fly<dot>lisp file
	Lisp File, `esrap-peg/peg.lisp`:	The esrap-peg/peg<dot>lisp file
	Lisp File, `esrap-peg/util.lisp`:	The esrap-peg/util<dot>lisp file

Jump to:	E F L

A.2 Functions

Jump to:	A B C D E F M P S T

	Index Entry	Section

A
	`abbreviations-into-package`:	Internal functions
	`add-peg-order-rule`:	Exported functions
	`ast-eval`:	Exported functions

B
	`basic-parse-peg`:	Exported functions

C
	`character-class-rule`:	Internal macros

D
	`def-ast-rule`:	Internal macros
	`def-peg-fun`:	Exported macros
	`def-peg-matchers`:	Exported macros
	`define-character-classes`:	Internal macros
	`delete-peg-order-rule`:	Exported functions

E
	`esrap-peg-symbol`:	Internal functions

F
	`file-contents`:	Internal functions
	`Function, abbreviations-into-package`:	Internal functions
	`Function, add-peg-order-rule`:	Exported functions
	`Function, ast-eval`:	Exported functions
	`Function, basic-parse-peg`:	Exported functions
	`Function, delete-peg-order-rule`:	Exported functions
	`Function, esrap-peg-symbol`:	Internal functions
	`Function, file-contents`:	Internal functions
	`Function, parse-peg-file`:	Exported functions
	`Function, peg-code`:	Exported functions
	`Function, semantic-checker␣for␣character␣class␣with␣clauses␣(#\n␣#\r␣#\t␣#\'␣#\"␣#\[␣#\]↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣#\)␣`:	Internal functions
	`Function, semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\3))␣`:	Internal functions
	`Function, semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\7))␣`:	Internal functions
	`Function, semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9))␣`:	Internal functions
	`Function, semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9)␣(#\a␣#\f)↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣(#\a␣#\f))␣`:	Internal functions
	`Function, semantic-checker␣for␣character␣class␣with␣clauses␣((#\a␣#\z)␣(#\a␣#\z)␣#\_)␣`:	Internal functions
	`Function, stream-contents`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣and␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣char␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣class␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣close␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣comment␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣definition␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣dot␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣endoffile␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣endofline␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣expression␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣grammar␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣identcont␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣identifier␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣identstart␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣leftarrow␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣literal␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣not␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣open␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣plus␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣prefix␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣primary␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣question␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣range␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣sequence␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣slash␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣space␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣spacing␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣star␣into␣ast`:	Internal functions
	`Function, temporary␣function␣to␣add␣symbol␣suffix␣into␣ast`:	Internal functions
	`Function, to-text`:	Internal functions

M
	`Macro, character-class-rule`:	Internal macros
	`Macro, def-ast-rule`:	Internal macros
	`Macro, def-peg-fun`:	Exported macros
	`Macro, def-peg-matchers`:	Exported macros
	`Macro, define-character-classes`:	Internal macros
	`Macro, peg-compile`:	Exported macros

P
	`parse-peg-file`:	Exported functions
	`peg-code`:	Exported functions
	`peg-compile`:	Exported macros

S
	`semantic-checker␣for␣character␣class␣with␣clauses␣(#\n␣#\r␣#\t␣#\'␣#\"␣#\[␣#\]↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣#\\)␣`:	Internal functions
	`semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\3))␣`:	Internal functions
	`semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\7))␣`:	Internal functions
	`semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9))␣`:	Internal functions
	`semantic-checker␣for␣character␣class␣with␣clauses␣((#\0␣#\9)␣(#\a␣#\f)↩␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣(#\a␣#\f))␣`:	Internal functions
	`semantic-checker␣for␣character␣class␣with␣clauses␣((#\a␣#\z)␣(#\a␣#\z)␣#\_)␣`:	Internal functions
	`stream-contents`:	Internal functions

T
	`temporary␣function␣to␣add␣symbol␣and␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣char␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣class␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣close␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣comment␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣definition␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣dot␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣endoffile␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣endofline␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣expression␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣grammar␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣identcont␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣identifier␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣identstart␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣leftarrow␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣literal␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣not␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣open␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣plus␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣prefix␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣primary␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣question␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣range␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣sequence␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣slash␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣space␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣spacing␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣star␣into␣ast`:	Internal functions
	`temporary␣function␣to␣add␣symbol␣suffix␣into␣ast`:	Internal functions
	`to-text`:	Internal functions

Jump to:	A B C D E F M P S T

A.3 Variables

Jump to:	* C R S

	Index Entry	Section

*
	`character-class-storage`:	Internal special variables
	`esrap-peg-matcher-default-abbreviations`:	Exported special variables
	`esrap-peg-pattern-package`:	Exported special variables
	`range-list`:	Internal special variables

C
	`character-range-definer`:	Internal special variables

R
	`rule-creator`:	Internal special variables

S
	`Special Variable, character-class-storage`:	Internal special variables
	`Special Variable, esrap-peg-matcher-default-abbreviations`:	Exported special variables
	`Special Variable, esrap-peg-pattern-package`:	Exported special variables
	`Special Variable, range-list`:	Internal special variables
	`Special Variable, character-range-definer`:	Internal special variables
	`Special Variable, rule-creator`:	Internal special variables

Jump to:	* C R S

A.4 Data types

Jump to:	E P S

	Index Entry	Section

E
	`esrap-peg`:	The esrap-peg system
	`esrap-peg`:	The esrap-peg package

P
	`Package, esrap-peg`:	The esrap-peg package

S
	`System, esrap-peg`:	The esrap-peg system

Jump to:	E P S

• Introduction:		What esrap-peg 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

• The esrap-peg.asd file:
• The esrap-peg/package.lisp file:
• The esrap-peg/util.lisp file:
• The esrap-peg/peg.lisp file:
• The esrap-peg/peg-functions.lisp file:
• The esrap-peg/peg-on-the-fly.lisp file:
• The esrap-peg/peg-compile.lisp file:
• The esrap-peg/pattern-processing.lisp file:

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

• Exported special variables:
• Exported macros:
• Exported functions:

• Internal special variables:
• Internal macros:
• Internal functions:

The esrap-peg Reference Manual

Table of Contents

The esrap-peg Reference Manual

1 Introduction

2 Systems

2.1 esrap-peg

3 Files

3.1 Lisp

3.1.1 esrap-peg.asd

3.1.2 esrap-peg/package.lisp

3.1.3 esrap-peg/util.lisp

3.1.4 esrap-peg/peg.lisp

3.1.5 esrap-peg/peg-functions.lisp

3.1.6 esrap-peg/peg-on-the-fly.lisp

3.1.7 esrap-peg/peg-compile.lisp

3.1.8 esrap-peg/pattern-processing.lisp

4 Packages

4.1 esrap-peg

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Macros

5.1.3 Functions

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Macros

5.2.3 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `esrap-peg`

3.1.1 `esrap-peg.asd`

3.1.2 `esrap-peg/package.lisp`

3.1.3 `esrap-peg/util.lisp`

3.1.4 `esrap-peg/peg.lisp`

3.1.5 `esrap-peg/peg-functions.lisp`

3.1.6 `esrap-peg/peg-on-the-fly.lisp`

3.1.7 `esrap-peg/peg-compile.lisp`

3.1.8 `esrap-peg/pattern-processing.lisp`

4.1 `esrap-peg`