Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The pp-toml Reference Manual
This is the pp-toml Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 05:35:22 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The pp-toml Reference Manual, Up: The pp-toml Reference Manual [Contents][Index]
1 Introduction
Paul's Parser for Tom's Own Minimal Language (0.1.0)
Common Lisp TOML parser.
Needs
The library needs to be brought up to 1.0.0 spec.
Compliance notes
-
Supports the TOML v0.1.0 spec with the following exceptions:
-
Complications arising from escaping quote & comment syntax are known and deferred until someone gets bit and is angry enough to send a pull request fixing them.
-
Not enforcing array homogeneity. Partly this is because of Postel's dictum, but partly because it might be more convenient to have heterogenous lists. Future work - might add a strict mode which throws errors here.
-
Unicode support may have some issues. It should work, but Unicode on Common Lisp is sometimes dependant on your system's configuration. Testing should be done before rolling your work to production.
-
Common Lisp is pretty good with numbers. Therefore, instead of manually differentiating between floats and integers, pp-toml calls them NUMBERS and lets your Lisp take care of the rest. Again, test before rolling to production.
Testing
To run the tests, do this:
sbcl --script run-sbcl-tests.lisp
Which will produce a test report.
Contributions
Gratefully accepted. Please add test cases for bug reports you fix or features you add.
License is LLGPL.
Remarks
Since Tom thought it'd be a good idea to put his name on the language, I'm putting my name on this parser.
Next: Files, Previous: Introduction, Up: The pp-toml Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 pp-toml
TOML parser
- Maintainer
Paul Nathan <pnathan@alumni.uidaho.edu>
- Author
Paul Nathan <pnathan@alumni.uidaho.edu>
- License
LLGPL
- Long Description
Implements a TOML parser. PARSE-TOML is the top-level function
- Version
1.0.1
- Dependencies
- alexandria (system).
- cl-ppcre (system).
- generic-comparability (system).
- local-time (system).
- parse-number (system).
- split-sequence (system).
- esrap (system).
- Source
- Child Component
pp-toml.lisp (file).
Next: Packages, Previous: Systems, Up: The pp-toml Reference Manual [Contents][Index]
3 Files
Files are sorted by type and then listed depth-first from the systems components trees.
3.1 Lisp
Next: pp-toml/pp-toml.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
3.1.1 pp-toml/pp-toml.asd
- Source
- Parent Component
pp-toml (system).
- ASDF Systems
Previous: pp-toml/pp-toml.asd, Up: Lisp [Contents][Index]
3.1.2 pp-toml/pp-toml.lisp
- Source
- Parent Component
pp-toml (system).
- Packages
- Public Interface
- parse-string (function).
- parse-toml (function).
- strip-comments (function).
- Internals
- *comment-scanner* (special variable).
- explode-hash-table (function).
- extract-lisp-structure (function).
- key-p (function).
- make-nested-hash (function).
- not-bracket (function).
- not-doublequote (function).
- not-integer (function).
- not-special-case (function).
- process-value-data (function).
- splode-y (function).
- transliterate-to-specials (function).
- transliterate-unicode (function).
Next: Definitions, Previous: Files, Up: The pp-toml Reference Manual [Contents][Index]
4 Packages
Packages are listed by definition order.
4.1 pp-toml
- Source
- Use List
- common-lisp.
- esrap.
- generic-comparability.
- Public Interface
- parse-string (function).
- parse-toml (function).
- strip-comments (function).
- Internals
- *comment-scanner* (special variable).
- explode-hash-table (function).
- extract-lisp-structure (function).
- key-p (function).
- make-nested-hash (function).
- not-bracket (function).
- not-doublequote (function).
- not-integer (function).
- not-special-case (function).
- process-value-data (function).
- splode-y (function).
- transliterate-to-specials (function).
- transliterate-unicode (function).
Next: Indexes, Previous: Packages, Up: The pp-toml Reference Manual [Contents][Index]
5 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
5.1 Public Interface
Previous: Public Interface, Up: Public Interface [Contents][Index]
5.1.1 Ordinary functions
- Function: parse-string (string) ¶
-
Returns the toml parsed structure from ‘string‘ or :parse-error
- Package
- Source
- Function: parse-toml (string &key strict) ¶
-
Parse a TOML ‘string‘, returning a hash table comparable by EQUAL.
‘strict‘ is not supported at present.
- Package
- Source
- Function: strip-comments (string) ¶
-
Strips the comments from the string
- Package
- Source
Previous: Public Interface, Up: Definitions [Contents][Index]
5.2 Internals
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
5.2.1 Special variables
- Special Variable: *comment-scanner* ¶
-
Scanner for # comments. Handles "#" strings
- Package
- Source
Previous: Special variables, Up: Internals [Contents][Index]
5.2.2 Ordinary functions
- Function: explode-hash-table (table) ¶
-
- Package
- Source
- Function: extract-lisp-structure (parsed-structure) ¶
-
- Package
- Source
- Function: key-p (key table) ¶
-
Does ‘key‘ exist in ‘table?
- Package
- Source
- Function: make-nested-hash (table key-list value) ¶
-
- Package
- Source
- Function: not-bracket (char) ¶
-
- Package
- Source
- Function: not-doublequote (char) ¶
-
- Package
- Source
- Function: not-integer (string) ¶
-
- Package
- Source
- Function: not-special-case (char) ¶
-
- Package
- Source
- Function: process-value-data (value) ¶
-
‘value‘ may be any of the standard toml value types: array,
datetime, bool, number, or string. Of those, arrays are a special case:
Supposing an array is encountered, process-value-data recurses upon the array.
Toml does not support references as of v0.1, and there for we can traverse arrays without cyles of references.
- Package
- Source
- Function: splode-y (table splitter key value) ¶
-
- Package
- Source
- Function: transliterate-to-specials (string) ¶
-
Transliterate escape characters into Common Lisp characters
- Package
- Source
- Function: transliterate-unicode (string) ¶
-
- Package
- Source
Previous: Definitions, Up: The pp-toml Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | E F K M N P S T |
|---|
| Jump to: | E F K M N P S T |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*comment-scanner*: | Private special variables | ||
| | |||
| S | |||
Special Variable, *comment-scanner*: | Private special variables | ||
| | |||
| Jump to: | *
S |
|---|
A.4 Data types
| Jump to: | F P S |
|---|
| Jump to: | F P S |
|---|