The esrap-peg Reference Manual

This is the esrap-peg Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:30:36 2022 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.

esrap-peg

2.1 `esrap-peg`

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

Author

Michael Raskin

License

MIT

Dependencies

esrap (system).
iterate (system).
cl-unification (system).
alexandria (system).

Source

esrap-peg.asd.

Child 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.

Lisp

3.1.1 `esrap-peg/esrap-peg.asd`

Source: esrap-peg.asd.
Parent Component: esrap-peg (system).
ASDF Systems: esrap-peg.

3.1.2 `esrap-peg/package.lisp`

Source: esrap-peg.asd.
Parent Component: esrap-peg (system).
Packages: esrap-peg.

3.1.3 `esrap-peg/util.lisp`

Dependency

package.lisp (file).

Source

esrap-peg.asd.

Parent Component

esrap-peg (system).

Internals

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

3.1.4 `esrap-peg/peg.lisp`

Dependency

package.lisp (file).

Source

esrap-peg.asd.

Parent Component

esrap-peg (system).

Internals

*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).

Source

esrap-peg.asd.

Parent Component

esrap-peg (system).

Public Interface

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

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

Dependency

package.lisp (file).

Source

esrap-peg.asd.

Parent Component

esrap-peg (system).

Public Interface

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

Internals

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).

Source

esrap-peg.asd.

Parent Component

esrap-peg (system).

Public Interface

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

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

Dependency

package.lisp (file).

Source

esrap-peg.asd.

Parent Component

esrap-peg (system).

Public Interface

*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).

Internals

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

4 Packages

Packages are listed by definition order.

esrap-peg

4.1 `esrap-peg`

Source

package.lisp.

Use List

common-lisp.
esrap.
iterate.

Public Interface

*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).

Internals

*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.

Public Interface
Internals

5.1 Public Interface

Special variables
Macros
Ordinary functions

5.1.1 Special variables

Special Variable: *esrap-peg-matcher-default-abbreviations* ¶

Package: esrap-peg.
Source: pattern-processing.lisp.

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

Package: esrap-peg.
Source: pattern-processing.lisp.

5.1.2 Macros

Macro: def-peg-fun (name (arg) &rest code) ¶

Package: esrap-peg.
Source: peg-on-the-fly.lisp.

Macro: def-peg-matchers (clauses &key abbreviations package arg) ¶

Package: esrap-peg.
Source: pattern-processing.lisp.

Macro: peg-compile (g) ¶

Package: esrap-peg.
Source: peg-compile.lisp.

5.1.3 Ordinary functions

Function: add-peg-order-rule (node before after) ¶

Package: esrap-peg.
Source: pattern-processing.lisp.

Function: ast-eval (x) ¶

Package: esrap-peg.
Source: peg-on-the-fly.lisp.

Function: basic-parse-peg (g) ¶

Package: esrap-peg.
Source: peg-functions.lisp.

Function: delete-peg-order-rule (node before after) ¶

Package: esrap-peg.
Source: pattern-processing.lisp.

Function: parse-peg-file (f) ¶

Package: esrap-peg.
Source: peg-functions.lisp.

Function: peg-code (g) ¶

Package: esrap-peg.
Source: peg-compile.lisp.

5.2 Internals

Special variables
Macros
Ordinary functions

5.2.1 Special variables

Special Variable: *character-class-storage* ¶

Package: esrap-peg.
Source: peg.lisp.

Special Variable: *range-list* ¶

Package: esrap-peg.
Source: peg.lisp.

Special Variable: character-range-definer ¶

Package: esrap-peg.
Source: peg-on-the-fly.lisp.

Special Variable: rule-creator ¶

Package: esrap-peg.
Source: peg-on-the-fly.lisp.

5.2.2 Macros

Macro: character-class-rule (&rest clauses) ¶

Package: esrap-peg.
Source: peg.lisp.

Macro: def-ast-rule (name &rest params) ¶

Package: esrap-peg.
Source: peg.lisp.

Macro: define-character-classes () ¶

Package: esrap-peg.
Source: peg.lisp.

5.2.3 Ordinary functions

Function: abbreviations-into-package (l &optional package) ¶

Package: esrap-peg.
Source: pattern-processing.lisp.

Function: esrap-peg-symbol (x) ¶

Package: esrap-peg.
Source: pattern-processing.lisp.

Function: file-contents (fn) ¶

Package: esrap-peg.
Source: util.lisp.

Function: semantic-checker⎵for⎵character⎵class⎵with⎵clauses⎵(#\n⎵#\r⎵#\t⎵#\'⎵#\"⎵#\[⎵#\]↵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵#\\)⎵ (x) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: semantic-checker⎵for⎵character⎵class⎵with⎵clauses⎵((#\0⎵#\3))⎵ (x) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: semantic-checker⎵for⎵character⎵class⎵with⎵clauses⎵((#\0⎵#\7))⎵ (x) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: semantic-checker⎵for⎵character⎵class⎵with⎵clauses⎵((#\0⎵#\9)⎵(#\a⎵#\f)↵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵⎵(#\a⎵#\f))⎵ (x) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: semantic-checker⎵for⎵character⎵class⎵with⎵clauses⎵((#\0⎵#\9))⎵ (x) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: semantic-checker⎵for⎵character⎵class⎵with⎵clauses⎵((#\a⎵#\z)⎵(#\a⎵#\z)⎵#\_)⎵ (x) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: stream-contents (f) ¶

Package: esrap-peg.
Source: util.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵and⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵char⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵class⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵close⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵comment⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵definition⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵dot⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵endoffile⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵endofline⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵expression⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵grammar⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵identcont⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵identifier⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵identstart⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵leftarrow⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵literal⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵not⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵open⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵plus⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵prefix⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵primary⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵question⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵range⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵sequence⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵slash⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵space⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵spacing⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵star⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: temporary⎵function⎵to⎵add⎵symbol⎵suffix⎵into⎵ast (x &rest pos) ¶

Package: esrap-peg.
Source: peg.lisp.

Function: to-text (str start end) ¶

Package: esrap-peg.
Source: peg.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

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

	Index Entry	Section

A
	`abbreviations-into-package`:	Private ordinary functions
	`add-peg-order-rule`:	Public ordinary functions
	`ast-eval`:	Public ordinary functions

B
	`basic-parse-peg`:	Public ordinary functions

C
	`character-class-rule`:	Private macros

D
	`def-ast-rule`:	Private macros
	`def-peg-fun`:	Public macros
	`def-peg-matchers`:	Public macros
	`define-character-classes`:	Private macros
	`delete-peg-order-rule`:	Public ordinary functions

E
	`esrap-peg-symbol`:	Private ordinary functions

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

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

P
	`parse-peg-file`:	Public ordinary functions
	`peg-code`:	Public ordinary functions
	`peg-compile`:	Public macros

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

T
	`temporary⎵function⎵to⎵add⎵symbol⎵and⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵char⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵class⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵close⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵comment⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵definition⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵dot⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵endoffile⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵endofline⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵expression⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵grammar⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵identcont⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵identifier⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵identstart⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵leftarrow⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵literal⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵not⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵open⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵plus⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵prefix⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵primary⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵question⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵range⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵sequence⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵slash⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵space⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵spacing⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵star⎵into⎵ast`:	Private ordinary functions
	`temporary⎵function⎵to⎵add⎵symbol⎵suffix⎵into⎵ast`:	Private ordinary functions
	`to-text`:	Private ordinary 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`:	Private special variables
	`esrap-peg-matcher-default-abbreviations`:	Public special variables
	`esrap-peg-pattern-package`:	Public special variables
	`range-list`:	Private special variables

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

R
	`rule-creator`:	Private special variables

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

Jump to:	* C R S

A.4 Data types

Jump to:	E F P S U

	Index Entry	Section

E
	`esrap-peg`:	The esrap-peg system
	`esrap-peg`:	The esrap-peg package
	`esrap-peg.asd`:	The esrap-peg/esrap-peg․asd file

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

P
	`Package, esrap-peg`:	The esrap-peg package
	`package.lisp`:	The esrap-peg/package․lisp file
	`pattern-processing.lisp`:	The esrap-peg/pattern-processing․lisp file
	`peg-compile.lisp`:	The esrap-peg/peg-compile․lisp file
	`peg-functions.lisp`:	The esrap-peg/peg-functions․lisp file
	`peg-on-the-fly.lisp`:	The esrap-peg/peg-on-the-fly․lisp file
	`peg.lisp`:	The esrap-peg/peg․lisp file

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

U
	`util.lisp`:	The esrap-peg/util․lisp file

Jump to:	E F P S U

The esrap-peg Reference Manual

The esrap-peg Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 esrap-peg

3 Files

3.1 Lisp

3.1.1 esrap-peg/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 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Ordinary 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/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`