The dso-lex Reference Manual

Table of Contents

The dso-lex Reference Manual

This is the dso-lex Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:20:48 2020 GMT+0.

1 Systems

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

1.1 dso-lex

Dependencies

• cl-ppcre
• dso-util

Source

dso-lex.asd (file)

Component

lex.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 dso-lex.asd

Location

dso-lex.asd

Systems

dso-lex (system)

2.1.2 dso-lex/lex.lisp

Parent

dso-lex (system)

Location

lex.lisp

Packages

dso-lex

Exported Definitions

• deflexer (macro)
• lex-all (function)
• make-lexer (function)

Internal Definitions

• anchor-and-mode (function)
• break-defs (function)
• combine (function)
• greedy-lexer-form (function)
• lexer-form (function)
• wrap (function)

3 Packages

Packages are listed by definition order.

3.1 dso-lex

Allows the definition of lexers. See DEFLEXER.

Source

lex.lisp (file)

Use List

• dso-util
• cl-ppcre
• common-lisp

Exported Definitions

• deflexer (macro)
• lex-all (function)
• make-lexer (function)

Internal Definitions

• anchor-and-mode (function)
• break-defs (function)
• combine (function)
• greedy-lexer-form (function)
• lexer-form (function)
• wrap (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: deflexer NAME (&key PRIORITY-ONLY) &body DEFS

Defines a lexer, called as a function of the given NAME, and returning the matched token-class, image, and image-length as values. The body consists of token-class definitions, each being a list of a regular expression, the name of the class, and an optional filter.

Unless PRIORITY-ONLY is true, the longest match will win, and rule-priority will only be used to break ties. Otherwise, the first match wins.

Example:

(deflexer lexer ()
("[0-9]+" number parse-integer)
("[a-zA-Z]" letter))

(lexer "2pi" 1)

Package

dso-lex

Source

lex.lisp (file)

4.1.2 Functions

Function: lex-all LEXER INPUT

Package

dso-lex

Source

lex.lisp (file)

Function: make-lexer DEFS &key PRIORITY-ONLY

Returns a lexer function. The DEFS consists of token-class definitions, each being a list of a regular expression, the name of the class, and an optional filter. The returned function takes as arguments an input sequence and an optional start position, and returning the matched token-class, image, and image-length as values.

Unless PRIORITY-ONLY is true, the longest match will win, and rule-priority will only be used to break ties. Otherwise, the first match wins.

Example:

(let ((lexer (make-lexer ’(("[0-9]+" number parse-integer) ("[a-zA-Z]" letter)))))
(funcall lexer "2pi" 1))

Package

dso-lex

Source

lex.lisp (file)

4.2 Internal definitions

4.2.1 Functions

Function: anchor-and-mode REGEX

Package

dso-lex

Source

lex.lisp (file)

Function: break-defs DEFS

Package

dso-lex

Source

lex.lisp (file)

Function: combine REGEX-LIST

Package

dso-lex

Source

lex.lisp (file)

Function: greedy-lexer-form INPUT-VAR START-VAR DEFS

Package

dso-lex

Source

lex.lisp (file)

Function: lexer-form INPUT-VAR START-VAR DEFS

Package

dso-lex

Source

lex.lisp (file)

Function: wrap REGEX

Package

dso-lex

Source

lex.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types