The cl-bnf Reference Manual

3.1.1 cl-bnf/cl-bnf.asd

Source

cl-bnf.asd.

Parent Component

cl-bnf (system).

ASDF Systems

cl-bnf.

---

3.1.2 cl-bnf/src/bnf.lisp

Source

cl-bnf.asd.

Parent Component

src (module).

Packages

cl-bnf.

Public Interface

• define-grammar (macro).
• define-rule (macro).
• parse (function).

Internals

• and-match (function).
• back-char (function).
• copy-text-stream (function).
• eval-pattern-or-function (function).
• expand-and-rule (function).
• expand-item (function).
• ispair (function).
• make-text-stream (function).
• many-matches (function).
• map-rules (function).
• maybe-match (function).
• next-char (function).
• one (macro).
• or-match (function).
• single-char (macro).
• split-seq-on (function).
• string-match (function).
• text-stream (structure).
• text-stream-column (reader).
• (setf text-stream-column) (writer).
• text-stream-cursor (reader).
• (setf text-stream-cursor) (writer).
• text-stream-length (reader).
• (setf text-stream-length) (writer).
• text-stream-line (reader).
• (setf text-stream-line) (writer).
• text-stream-p (function).
• text-stream-text (reader).
• (setf text-stream-text) (writer).

---

5.1.1 Macros

Macro: define-grammar (spec &rest rules) ¶

Generates the parser with SPEC and all the RULES.

Package

cl-bnf.

Source

bnf.lisp.

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.

---

5.1.2 Ordinary functions

Function: parse (rules source) ¶

Parse according to the RULES on SOURCE.

Package

cl-bnf.

Source

bnf.lisp.

---

5.2.1 Macros

Macro: one (stream pred) ¶

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

Package

cl-bnf.

Source

bnf.lisp.

Macro: single-char (stream char) ¶

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

Package

cl-bnf.

Source

bnf.lisp.

---

5.2.2 Ordinary functions

Function: and-match (stream expression) ¶

And pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf.

Source

bnf.lisp.

Function: back-char (ts) ¶

Move backward one char on TS.

Package

cl-bnf.

Source

bnf.lisp.

Function: copy-text-stream (instance) ¶

Package

cl-bnf.

Source

bnf.lisp.

Function: eval-pattern-or-function (item source) ¶

Evaluate a patter or function for ITEM an use SOURCE.

Package

cl-bnf.

Source

bnf.lisp.

Function: expand-and-rule (items) ¶

Take many or RULES and normalize the tree.

Package

cl-bnf.

Source

bnf.lisp.

Function: expand-item (item) ¶

If ITEM is simple type, transforms it into the correct structure.

Package

cl-bnf.

Source

bnf.lisp.

Function: ispair (x) ¶

Package

cl-bnf.

Source

bnf.lisp.

Function: make-text-stream (&key cursor text line column length) ¶

Package

cl-bnf.

Source

bnf.lisp.

Function: many-matches (stream expression) ¶

Many pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf.

Source

bnf.lisp.

Function: map-rules (fn rules) ¶

Apply FN on each expression in RULES.

Package

cl-bnf.

Source

bnf.lisp.

Function: maybe-match (stream expression) ¶

Maybe pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf.

Source

bnf.lisp.

Function: next-char (ts &key eof-char) ¶

Look ahead the next char.

Package

cl-bnf.

Source

bnf.lisp.

Function: or-match (stream expression) ¶

Or pattern to be run on STREAM with EXPRESSION.

Package

cl-bnf.

Source

bnf.lisp.

Function: split-seq-on (item seq) ¶

Split on ITEM on SEQ.

Package

cl-bnf.

Source

bnf.lisp.

Function: string-match (stream str) ¶

String pattern to be run on STREAM with STRING.

Package

cl-bnf.

Source

bnf.lisp.

Reader: text-stream-column (instance) ¶

Writer: (setf text-stream-column) (instance) ¶

Package

cl-bnf.

Source

bnf.lisp.

Target Slot

column.

Reader: text-stream-cursor (instance) ¶

Writer: (setf text-stream-cursor) (instance) ¶

Package

cl-bnf.

Source

bnf.lisp.

Target Slot

cursor.

Reader: text-stream-length (instance) ¶

Writer: (setf text-stream-length) (instance) ¶

Package

cl-bnf.

Source

bnf.lisp.

Target Slot

length.

Reader: text-stream-line (instance) ¶

Writer: (setf text-stream-line) (instance) ¶

Package

cl-bnf.

Source

bnf.lisp.

Target Slot

line.

Function: text-stream-p (object) ¶

Package

cl-bnf.

Source

bnf.lisp.

Reader: text-stream-text (instance) ¶

Writer: (setf text-stream-text) (instance) ¶

Package

cl-bnf.

Source

bnf.lisp.

Target Slot

text.

---

5.2.3 Structures

Structure: text-stream ¶

Package

cl-bnf.

Source

bnf.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: cursor ¶

Readers

text-stream-cursor.

Writers

(setf text-stream-cursor).

Slot: text ¶

Readers

text-stream-text.

Writers

(setf text-stream-text).

Slot: line ¶

Readers

text-stream-line.

Writers

(setf text-stream-line).

Slot: column ¶

Readers

text-stream-column.

Writers

(setf text-stream-column).

Slot: length ¶

Package

common-lisp.

Readers

text-stream-length.

Writers

(setf text-stream-length).

---