The cl-bnf Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-bnf Reference Manual

This is the cl-bnf Reference Manual, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 14:44:24 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 cl-bnf

Author

Bruno Dias <dias.h.bruno@gmail.com>

License

MIT

Description

A simple BNF parser.

Source

cl-bnf.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

2 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

2.1 cl-bnf/src

Parent

cl-bnf (system)

Location

src/

Component

bnf.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-bnf.asd

Location

cl-bnf.asd

Systems

cl-bnf (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-bnf/src/bnf.lisp

Parent

src (module)

Location

src/bnf.lisp

Packages

cl-bnf

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-bnf

Source

bnf.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: define-grammar LABEL &rest RULES
Package

cl-bnf

Source

bnf.lisp (file)

Macro: define-rule LABEL RULE &key CALL TAG APPLY

Generate a function LABEL to parse RULE. Later, you can apply a TRANSFORMATION which can be a function or a keytword.

Package

cl-bnf

Source

bnf.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: parse RULES SOURCE

Parse according to the RULES on SOURCE.

Package

cl-bnf

Source

bnf.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *table*
Package

cl-bnf

Source

bnf.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: one STREAM PRED

Get a single char from the STREAM and test against PRED.

Package

cl-bnf

Source

bnf.lisp (file)

Macro: single-char STREAM CHAR

Get a single char from the STREAM and test against CHAR.

Package

cl-bnf

Source

bnf.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: and-match STREAM EXPRESSION

And pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf

Source

bnf.lisp (file)

Function: back-char TS

Move backward one char on TS.

Package

cl-bnf

Source

bnf.lisp (file)

Function: copy-text-stream INSTANCE
Package

cl-bnf

Source

bnf.lisp (file)

Function: eval-pattern-or-function ITEM SOURCE

Evaluate a patter or function for ITEM an use SOURCE.

Package

cl-bnf

Source

bnf.lisp (file)

Function: make-text-stream &key (CURSOR CURSOR) (TEXT TEXT) (LINE LINE) (COLUMN COLUMN) (LENGTH LENGTH)
Package

cl-bnf

Source

bnf.lisp (file)

Function: many-matches STREAM EXPRESSION

Many pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf

Source

bnf.lisp (file)

Function: maybe-match STREAM EXPRESSION

Maybe pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf

Source

bnf.lisp (file)

Function: next-char TS &key EOF-CHAR

Look ahead the next char.

Package

cl-bnf

Source

bnf.lisp (file)

Function: or-match STREAM EXPRESSION

Or pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf

Source

bnf.lisp (file)

Function: string-match STREAM STRING

String pattern to be run on STREAM with STRING.

Package

cl-bnf

Source

bnf.lisp (file)

Function: text-stream-column INSTANCE
Function: (setf text-stream-column) VALUE INSTANCE
Package

cl-bnf

Source

bnf.lisp (file)

Function: text-stream-cursor INSTANCE
Function: (setf text-stream-cursor) VALUE INSTANCE
Package

cl-bnf

Source

bnf.lisp (file)

Function: text-stream-length INSTANCE
Function: (setf text-stream-length) VALUE INSTANCE
Package

cl-bnf

Source

bnf.lisp (file)

Function: text-stream-line INSTANCE
Function: (setf text-stream-line) VALUE INSTANCE
Package

cl-bnf

Source

bnf.lisp (file)

Function: text-stream-p OBJECT
Package

cl-bnf

Source

bnf.lisp (file)

Function: text-stream-text INSTANCE
Function: (setf text-stream-text) VALUE INSTANCE
Package

cl-bnf

Source

bnf.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Structures

Structure: text-stream ()
Package

cl-bnf

Source

bnf.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: cursor
Readers

text-stream-cursor (function)

Writers

(setf text-stream-cursor) (function)

Slot: text
Readers

text-stream-text (function)

Writers

(setf text-stream-text) (function)

Slot: line
Readers

text-stream-line (function)

Writers

(setf text-stream-line) (function)

Slot: column
Readers

text-stream-column (function)

Writers

(setf text-stream-column) (function)

Slot: length
Readers

text-stream-length (function)

Writers

(setf text-stream-length) (function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-bnf.asd: The cl-bnf<dot>asd file
cl-bnf/src: The cl-bnf/src module
cl-bnf/src/bnf.lisp: The cl-bnf/src/bnf<dot>lisp file

F
File, Lisp, cl-bnf.asd: The cl-bnf<dot>asd file
File, Lisp, cl-bnf/src/bnf.lisp: The cl-bnf/src/bnf<dot>lisp file

L
Lisp File, cl-bnf.asd: The cl-bnf<dot>asd file
Lisp File, cl-bnf/src/bnf.lisp: The cl-bnf/src/bnf<dot>lisp file

M
Module, cl-bnf/src: The cl-bnf/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   M   N   O   P   S   T  
Index Entry  Section

(
(setf text-stream-column): Internal functions
(setf text-stream-cursor): Internal functions
(setf text-stream-length): Internal functions
(setf text-stream-line): Internal functions
(setf text-stream-text): Internal functions

A
and-match: Internal functions

B
back-char: Internal functions

C
copy-text-stream: Internal functions

D
define-grammar: Exported macros
define-rule: Exported macros

E
eval-pattern-or-function: Internal functions

F
Function, (setf text-stream-column): Internal functions
Function, (setf text-stream-cursor): Internal functions
Function, (setf text-stream-length): Internal functions
Function, (setf text-stream-line): Internal functions
Function, (setf text-stream-text): Internal functions
Function, and-match: Internal functions
Function, back-char: Internal functions
Function, copy-text-stream: Internal functions
Function, eval-pattern-or-function: Internal functions
Function, make-text-stream: Internal functions
Function, many-matches: Internal functions
Function, maybe-match: Internal functions
Function, next-char: Internal functions
Function, or-match: Internal functions
Function, parse: Exported functions
Function, string-match: Internal functions
Function, text-stream-column: Internal functions
Function, text-stream-cursor: Internal functions
Function, text-stream-length: Internal functions
Function, text-stream-line: Internal functions
Function, text-stream-p: Internal functions
Function, text-stream-text: Internal functions

M
Macro, define-grammar: Exported macros
Macro, define-rule: Exported macros
Macro, one: Internal macros
Macro, single-char: Internal macros
make-text-stream: Internal functions
many-matches: Internal functions
maybe-match: Internal functions

N
next-char: Internal functions

O
one: Internal macros
or-match: Internal functions

P
parse: Exported functions

S
single-char: Internal macros
string-match: Internal functions

T
text-stream-column: Internal functions
text-stream-cursor: Internal functions
text-stream-length: Internal functions
text-stream-line: Internal functions
text-stream-p: Internal functions
text-stream-text: Internal functions

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   L   S   T  
Index Entry  Section

*
*table*: Internal special variables

C
column: Internal structures
cursor: Internal structures

L
length: Internal structures
line: Internal structures

S
Slot, column: Internal structures
Slot, cursor: Internal structures
Slot, length: Internal structures
Slot, line: Internal structures
Slot, text: Internal structures
Special Variable, *table*: Internal special variables

T
text: Internal structures

Jump to:   *  
C   L   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   T  
Index Entry  Section

C
cl-bnf: The cl-bnf system
cl-bnf: The cl-bnf package

P
Package, cl-bnf: The cl-bnf package

S
Structure, text-stream: Internal structures
System, cl-bnf: The cl-bnf system

T
text-stream: Internal structures

Jump to:   C   P   S   T