The pp-toml Reference Manual

Table of Contents

Next: , Previous: , 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 2.3 "Robert April" on Wed Mar 14 04:26:09 2018 GMT+0.


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

1 Introduction

Paul's Parser for Tom's Own Minimal Language

Common Lisp TOML parser.

Build Status

Compliance notes

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: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 pp-toml

Maintainer

Paul Nathan <pnathan@alumni.uidaho.edu>

Author

Paul Nathan <pnathan@alumni.uidaho.edu>

License

LLGPL

Description

TOML parser

Long Description

Implements a TOML parser. PARSE-TOML is the top-level function

Version

1.0.1

Dependencies
Source

pp-toml.asd (file)

Component

pp-toml.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 pp-toml.asd

Location

pp-toml.asd

Systems

pp-toml (system)


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

3.1.2 pp-toml/pp-toml.lisp

Parent

pp-toml (system)

Location

pp-toml.lisp

Packages

pp-toml

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 pp-toml

Source

pp-toml.lisp (file)

Use List
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


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

5.1.1 Functions

Function: parse-string STRING

Returns the toml parsed structure from ‘string‘ or :parse-error

Package

pp-toml

Source

pp-toml.lisp (file)

Function: parse-toml STRING &key STRICT

Parse a TOML ‘string‘, returning a hash table comparable by EQUAL.

‘strict‘ is not supported at present.

Package

pp-toml

Source

pp-toml.lisp (file)

Function: strip-comments STRING

Strips the comments from the string

Package

pp-toml

Source

pp-toml.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: *comment-scanner*

Scanner for # comments. Handles "#" strings

Package

pp-toml

Source

pp-toml.lisp (file)


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

5.2.2 Functions

Function: explode-hash-table TABLE
Package

pp-toml

Source

pp-toml.lisp (file)

Function: extract-lisp-structure PARSED-STRUCTURE
Package

pp-toml

Source

pp-toml.lisp (file)

Function: key-p KEY TABLE

Does ‘key‘ exist in ‘table?

Package

pp-toml

Source

pp-toml.lisp (file)

Function: make-nested-hash TABLE KEY-LIST VALUE
Package

pp-toml

Source

pp-toml.lisp (file)

Function: not-bracket CHAR
Package

pp-toml

Source

pp-toml.lisp (file)

Function: not-doublequote CHAR
Package

pp-toml

Source

pp-toml.lisp (file)

Function: not-integer STRING
Package

pp-toml

Source

pp-toml.lisp (file)

Function: not-special-case CHAR
Package

pp-toml

Source

pp-toml.lisp (file)

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

pp-toml

Source

pp-toml.lisp (file)

Function: splode-y TABLE SPLITTER KEY VALUE
Package

pp-toml

Source

pp-toml.lisp (file)

Function: transliterate-to-specials STRING

Transliterate escape characters into Common Lisp characters

Package

pp-toml

Source

pp-toml.lisp (file)

Function: transliterate-unicode STRING
Package

pp-toml

Source

pp-toml.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, pp-toml.asd: The pp-toml<dot>asd file
File, Lisp, pp-toml/pp-toml.lisp: The pp-toml/pp-toml<dot>lisp file

L
Lisp File, pp-toml.asd: The pp-toml<dot>asd file
Lisp File, pp-toml/pp-toml.lisp: The pp-toml/pp-toml<dot>lisp file

P
pp-toml.asd: The pp-toml<dot>asd file
pp-toml/pp-toml.lisp: The pp-toml/pp-toml<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   E   F   K   M   N   P   S   T  
Index Entry  Section

E
explode-hash-table: Internal functions
extract-lisp-structure: Internal functions

F
Function, explode-hash-table: Internal functions
Function, extract-lisp-structure: Internal functions
Function, key-p: Internal functions
Function, make-nested-hash: Internal functions
Function, not-bracket: Internal functions
Function, not-doublequote: Internal functions
Function, not-integer: Internal functions
Function, not-special-case: Internal functions
Function, parse-string: Exported functions
Function, parse-toml: Exported functions
Function, process-value-data: Internal functions
Function, splode-y: Internal functions
Function, strip-comments: Exported functions
Function, transliterate-to-specials: Internal functions
Function, transliterate-unicode: Internal functions

K
key-p: Internal functions

M
make-nested-hash: Internal functions

N
not-bracket: Internal functions
not-doublequote: Internal functions
not-integer: Internal functions
not-special-case: Internal functions

P
parse-string: Exported functions
parse-toml: Exported functions
process-value-data: Internal functions

S
splode-y: Internal functions
strip-comments: Exported functions

T
transliterate-to-specials: Internal functions
transliterate-unicode: Internal functions

Jump to:   E   F   K   M   N   P   S   T  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*comment-scanner*: Internal special variables

S
Special Variable, *comment-scanner*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, pp-toml: The pp-toml package
pp-toml: The pp-toml system
pp-toml: The pp-toml package

S
System, pp-toml: The pp-toml system

Jump to:   P   S