The clop Reference Manual

Table of Contents

The clop Reference Manual

This is the clop Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:26:01 2022 GMT+0.

1 Introduction

* CLOP - Common Lisp tOml Parser

** Overview

[[https://toml.io][Tom's Obvious Minimal Language (TOML)]] is a human friendly configuration file format. This library implements a parser (decoder) for it.

Clop strictly follows TOML 1.0 specification and is fully compatible with it. It passes all 296 tests defined in [[https://github.com/BurntSushi/toml-test][BurntSushi/toml-test]].

It is implemented by utilizing [[https://github.com/scymtym/esrap][ESRAP]], which is a really awesome library.

** Installation

Once it gets into Quicklisp, you can load it by:

#+BEGIN_SRC lisp
  ;; Load it.
  (ql:quickload "clop")
  
  ;; Run some basic tests.
  (asdf:test-system "clop")
#+END_SRC

If you want to run comprehensive tests, you need to first clone [[https://github.com/BurntSushi/toml-test][toml-test]] and set it up locally.

Use the following command to test it:

#+BEGIN_SRC sh
  cd /path/to/clop/roswell
  ros build decoder.ros
  
  /path/to/toml-test/toml-test ./decoder
#+END_SRC

You should now see a line of:

#+BEGIN_SRC text
  toml-test [/path/to/clop/roswell/decoder]: using embedded tests: 296 passed,  0 failed
#+END_SRC


** Usage

*** Functions

The main entry point of Clop is ~parse~ function.

#+BEGIN_SRC lisp
  (defparameter +toml-text+ "
[server]
port = 5000
print-access-log = false
")
  
  (clop:parse +toml-text+)
  ; => (("server" ("port" . 5000) ("print-access-log")))
#+END_SRC

This function takes an optional keyword argument ~style~ that controls the output style:

- ~:alist~. The default. TOML tables are transformed to alists.
- ~:jsown~. TOML tables are transformed to jsown style ~(:obj "key" "value")~.
- ~:raw~. TOML tables are transformed to Clop internal representations, i.e. classes ~table~, ~table-array~ and ~inline-table~.

*** Configurations

The behavior of Clop can be tuned by settings configuration variables. Wrap them in a let lexical context or change their values globally to make it work.

|---------------+---------------+----------------------------|
| Variable      | Default Value | Meaning                    |
|---------------+---------------+----------------------------|
| *value-+inf*  | :+INF         | The value of +inf          |
| *value--inf*  | :-INF         | The value of -inf          |
| *value-+nan*  | :+NAN         | The value of +nan          |
| *value--nan*  | :-NAN         | The value of -nan          |
| *value-true*  | T             | The value of boolean true  |
| *value-false* | NIL           | The value of boolean false |
|---------------+---------------+----------------------------|

*** Extending Clop

Clop implementation has 2 concepts: value parser and block parser.

- Value parser is used for handling basic values, i.e. string, integer, float, bool, datetime, datetime-local, date-local, time-local.

- Block parser is used for handling TOML blocks, i.e. key-value-pair, table, inline-table and table-array.

**** Tuning Value Parser

For basic values, you may:

1. Define your own value parser function that takes 2 arguments: type and value, and return the resulting value.
2. Set ~clop.config:*value-parser*~ variable to your own function.

You may refer to ~roswell/decoder.ros~ for an example. ~toml-test~ requires values to be a JSON object like:

#+BEGIN_SRC json
  {
    "type": "integer",
    "value": 123
  }
#+END_SRC

Code in ~roswell/decoder.ros~ tunes value parser to return such ~jsown~ object.

**** Tuning Block Parser

Instead of implementing your own block parser, you may pass a ~:raw~ style to ~clop:parse~ function and start from the return value. Check docstrings in ~src/toml-block-parser~ for more detail.

2 Systems

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

2.1 clop

Author

YUE Daian

License

MIT

Description

CLOP - Common Lisp tOml Parser

Version

0.1.0

Dependencies

• alexandria
• esrap
• parse-number
• local-time
• str

Source

clop.asd (file)

Component

src (module)

3 Modules

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

3.1 clop/src

Parent

clop (system)

Location

src/

Components

• conditions.lisp (file)
• toml-value-parser.lisp (file)
• config.lisp (file)
• toml-block.lisp (file)
• toml-block-parser.lisp (file)
• rules.lisp (file)
• clop.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 clop.asd

Location

clop.asd

Systems

clop (system)

4.1.2 clop/src/conditions.lisp

Parent

src (module)

Location

src/conditions.lisp

Packages

clop.conditions

Exported Definitions

• toml-dotted-key-open-table-array-error (condition)
• toml-dotted-key-redefine-table-error (condition)
• toml-invalid-text-error (condition)
• toml-invalid-utf8-error (condition)
• toml-modify-inline-table-error (condition)
• toml-parse-error (condition)
• toml-redefine-property-error (condition)
• toml-redefine-table-error (condition)
• toml-table-error (condition)

Internal Definitions

• names (method)
• (setf names) (method)
• text (method)
• (setf text) (method)

4.1.3 clop/src/toml-value-parser.lisp

Parent

src (module)

Location

src/toml-value-parser.lisp

Packages

clop.toml-value-parser

Exported Definitions

• parse-value (generic function)
• parse-value (method)
• parse-value (method)
• parse-value (method)
• parse-value (method)
• parse-value (method)

4.1.4 clop/src/config.lisp

Parent

src (module)

Location

src/config.lisp

Packages

clop.config

Exported Definitions

• *value-+inf* (special variable)
• *value-+nan* (special variable)
• *value--inf* (special variable)
• *value--nan* (special variable)
• *value-false* (special variable)
• *value-parser* (special variable)
• *value-true* (special variable)

4.1.5 clop/src/toml-block.lisp

Parent

src (module)

Location

src/toml-block.lisp

Packages

clop.toml-block

Exported Definitions

• keys (method)
• (setf keys) (method)
• names (method)
• (setf names) (method)
• pairs (method)
• (setf pairs) (method)
• toml-array-table (class)
• toml-block (class)
• toml-inline-table (class)
• toml-key-value-pair (class)
• toml-named-table (class)
• toml-table (class)
• value (method)
• (setf value) (method)

4.1.6 clop/src/toml-block-parser.lisp

Parent

src (module)

Location

src/toml-block-parser.lisp

Packages

clop.toml-block-parser

Exported Definitions

• children (method)
• (setf children) (method)
• collection (class)
• inline-table (class)
• parse-toml-blocks (function)
• table (class)
• table-array (class)

Internal Definitions

• append-child (function)
• current-table (method)
• (setf current-table) (method)
• definition-context (method)
• (setf definition-context) (method)
• get-child (function)
• last-child (function)
• parse-pair-value (function)
• parse-toml-block (generic function)
• parse-toml-block (method)
• parse-toml-block (method)
• parse-toml-block (method)
• parse-toml-block (method)
• parser-context (class)
• root-table (method)
• set-child (function)

4.1.7 clop/src/rules.lisp

Parent

src (module)

Location

src/rules.lisp

Packages

clop.rules

Internal Definitions

• basic-unescaped-char-p (function)
• comment-char-p (function)
• hexp (function)
• literal-char-p (function)
• multiline-basic-text-p (function)
• multiline-literal-char-p (function)
• non-ascii-p (function)
• parse-number (function)
• parse-utf8 (function)
• parse-value (function)

4.1.8 clop/src/clop.lisp

Parent

src (module)

Location

src/clop.lisp

Packages

clop

Exported Definitions

parse (function)

Internal Definitions

• serialize (generic function)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)

5 Packages

Packages are listed by definition order.

5.1 clop.conditions

Source

conditions.lisp (file)

Use List

common-lisp

Used By List

• clop.rules
• clop.toml-block-parser

Exported Definitions

• toml-dotted-key-open-table-array-error (condition)
• toml-dotted-key-redefine-table-error (condition)
• toml-invalid-text-error (condition)
• toml-invalid-utf8-error (condition)
• toml-modify-inline-table-error (condition)
• toml-parse-error (condition)
• toml-redefine-property-error (condition)
• toml-redefine-table-error (condition)
• toml-table-error (condition)

Internal Definitions

• names (generic function)
• names (method)
• (setf names) (method)
• (setf names) (generic function)
• text (generic function)
• text (method)
• (setf text) (method)
• (setf text) (generic function)

5.2 clop.toml-value-parser

Source

toml-value-parser.lisp (file)

Use List

common-lisp

Exported Definitions

• parse-value (generic function)
• parse-value (method)
• parse-value (method)
• parse-value (method)
• parse-value (method)
• parse-value (method)

5.3 clop.config

Source

config.lisp (file)

Use List

common-lisp

Exported Definitions

• *value-+inf* (special variable)
• *value-+nan* (special variable)
• *value--inf* (special variable)
• *value--nan* (special variable)
• *value-false* (special variable)
• *value-parser* (special variable)
• *value-true* (special variable)

5.4 clop.toml-block

Source

toml-block.lisp (file)

Use List

common-lisp

Used By List

• clop.rules
• clop.toml-block-parser

Exported Definitions

• keys (generic function)
• keys (method)
• (setf keys) (method)
• (setf keys) (generic function)
• names (generic function)
• names (method)
• (setf names) (method)
• (setf names) (generic function)
• pairs (generic function)
• pairs (method)
• (setf pairs) (method)
• (setf pairs) (generic function)
• toml-array-table (class)
• toml-block (class)
• toml-inline-table (class)
• toml-key-value-pair (class)
• toml-named-table (class)
• toml-table (class)
• value (generic function)
• value (method)
• (setf value) (method)
• (setf value) (generic function)

5.5 clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Use List

• clop.toml-block
• clop.conditions
• common-lisp

Used By List

clop

Exported Definitions

• children (generic function)
• children (method)
• (setf children) (method)
• (setf children) (generic function)
• collection (class)
• inline-table (class)
• parse-toml-blocks (function)
• table (class)
• table-array (class)

Internal Definitions

• append-child (function)
• current-table (generic function)
• current-table (method)
• (setf current-table) (method)
• (setf current-table) (generic function)
• definition-context (generic function)
• definition-context (method)
• (setf definition-context) (method)
• (setf definition-context) (generic function)
• get-child (function)
• last-child (function)
• parse-pair-value (function)
• parse-toml-block (generic function)
• parse-toml-block (method)
• parse-toml-block (method)
• parse-toml-block (method)
• parse-toml-block (method)
• parser-context (class)
• root-table (generic function)
• root-table (method)
• set-child (function)

5.6 clop.rules

Source

rules.lisp (file)

Use List

• clop.conditions
• clop.toml-block
• esrap
• common-lisp

Used By List

clop

Internal Definitions

• basic-unescaped-char-p (function)
• comment-char-p (function)
• hexp (function)
• literal-char-p (function)
• multiline-basic-text-p (function)
• multiline-literal-char-p (function)
• non-ascii-p (function)
• parse-number (function)
• parse-utf8 (function)
• parse-value (function)

5.7 clop

Source

clop.lisp (file)

Use List

• clop.toml-block-parser
• clop.rules
• common-lisp

Exported Definitions

parse (function)

Internal Definitions

• serialize (generic function)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *value-+inf*

The value of +inf when decoding TOML.

Package

clop.config

Source

config.lisp (file)

Special Variable: *value-+nan*

The value of +nan when decoding TOML.

Package

clop.config

Source

config.lisp (file)

Special Variable: *value--inf*

The value of -inf when decoding TOML.

Package

clop.config

Source

config.lisp (file)

Special Variable: *value--nan*

The value of -nan when decoding TOML.

Package

clop.config

Source

config.lisp (file)

Special Variable: *value-false*

The value of false when decoding TOML.

Package

clop.config

Source

config.lisp (file)

Special Variable: *value-parser*

Package

clop.config

Source

config.lisp (file)

Special Variable: *value-true*

The value of true when decoding TOML.

Package

clop.config

Source

config.lisp (file)

6.1.2 Functions

Function: parse TEXT &key STYLE

Parse given string TEXT and convert the result to given STYLE. The STYLE can be one of:
* :alist (the default)
* :jsown (jsown-like object)
* :raw (should be rarely used)

The top-level of result is an alist.

You may implement your own style by implementing SERIALIZE method.

Package

clop

Source

clop.lisp (file)

Function: parse-toml-blocks LIST

Given a LIST of components (tables or key-value pairs), return an alist.

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

6.1.3 Generic functions

Generic Function: children OBJECT

Generic Function: (setf children) NEW-VALUE OBJECT

Package

clop.toml-block-parser

Methods

Method: children (COLLECTION collection)

Method: (setf children) NEW-VALUE (COLLECTION collection)

A table of any kind. Note that for a table, its own name is not stored as a property of itself, but as a hash key in children property of its parent collection. The parsed result is a table representing root table.

Source

toml-block-parser.lisp (file)

Generic Function: keys OBJECT

Generic Function: (setf keys) NEW-VALUE OBJECT

Package

clop.toml-block

Methods

Method: keys (TOML-KEY-VALUE-PAIR toml-key-value-pair)

automatically generated reader method

Source

toml-block.lisp (file)

Method: (setf keys) NEW-VALUE (TOML-KEY-VALUE-PAIR toml-key-value-pair)

automatically generated writer method

Source

toml-block.lisp (file)

Generic Function: names OBJECT

Generic Function: (setf names) NEW-VALUE OBJECT

Package

clop.toml-block

Methods

Method: names (TOML-NAMED-TABLE toml-named-table)

automatically generated reader method

Source

toml-block.lisp (file)

Method: (setf names) NEW-VALUE (TOML-NAMED-TABLE toml-named-table)

automatically generated writer method

Source

toml-block.lisp (file)

Generic Function: pairs OBJECT

Generic Function: (setf pairs) NEW-VALUE OBJECT

Package

clop.toml-block

Methods

Method: pairs (TOML-INLINE-TABLE toml-inline-table)

automatically generated reader method

Source

toml-block.lisp (file)

Method: (setf pairs) NEW-VALUE (TOML-INLINE-TABLE toml-inline-table)

automatically generated writer method

Source

toml-block.lisp (file)

Generic Function: parse-value TYPE VALUE

Package

clop.toml-value-parser

Source

toml-value-parser.lisp (file)

Methods

Method: parse-value TYPE VALUE

Method: parse-value (TYPE (eql time-local)) VALUE

Return a plist with keys (:hour :minute :second).

Method: parse-value (TYPE (eql date-local)) VALUE

Return a plist with keys (:year :month :day).

Method: parse-value (TYPE (eql datetime-local)) VALUE

Return a plist with keys (:year :month :day :hour :minute :second).

Method: parse-value (TYPE (eql datetime)) VALUE

Return a timestamp.

Generic Function: value OBJECT

Generic Function: (setf value) NEW-VALUE OBJECT

Package

clop.toml-block

Methods

Method: value (TOML-KEY-VALUE-PAIR toml-key-value-pair)

automatically generated reader method

Source

toml-block.lisp (file)

Method: (setf value) NEW-VALUE (TOML-KEY-VALUE-PAIR toml-key-value-pair)

automatically generated writer method

Source

toml-block.lisp (file)

6.1.4 Conditions

Condition: toml-dotted-key-open-table-array-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-table-error (condition)

Condition: toml-dotted-key-redefine-table-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-table-error (condition)

Condition: toml-invalid-text-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-parse-error (condition)

Direct subclasses

toml-invalid-utf8-error (condition)

Direct methods

• text (method)
• text (method)

Direct slots

Slot: text

Initargs

:text

Readers

text (generic function)

Writers

(setf text) (generic function)

Condition: toml-invalid-utf8-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-invalid-text-error (condition)

Condition: toml-modify-inline-table-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-table-error (condition)

Condition: toml-parse-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

toml-invalid-text-error (condition)

Condition: toml-redefine-property-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-table-error (condition)

Condition: toml-redefine-table-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

toml-table-error (condition)

Condition: toml-table-error ()

Package

clop.conditions

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• toml-redefine-table-error (condition)
• toml-redefine-property-error (condition)
• toml-modify-inline-table-error (condition)
• toml-dotted-key-redefine-table-error (condition)
• toml-dotted-key-open-table-array-error (condition)

Direct methods

• names (method)
• names (method)

Direct slots

Slot: names

Initargs

:names

Readers

names (generic function)

Writers

(setf names) (generic function)

6.1.5 Classes

Class: collection ()

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• table (class)
• inline-table (class)
• table-array (class)

Direct methods

• children (method)
• children (method)

Direct slots

Slot: children

A table of any kind. Note that for a table, its own name is not stored as a property of itself, but as a hash key in children property of its parent collection. The parsed result is a table representing root table.

Initform

(make-hash-table :test (function equal))

Readers

children (generic function)

Writers

(setf children) (generic function)

Class: inline-table ()

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Direct superclasses

collection (class)

Direct methods

• serialize (method)
• serialize (method)
• print-object (method)

Class: table ()

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Direct superclasses

collection (class)

Direct methods

• serialize (method)
• serialize (method)
• print-object (method)
• definition-context (method)
• definition-context (method)

Direct slots

Slot: definition-context

Internal use.

Indicates if the table is defined or not.
A table is defined in the following ways:
1. By [Table] header.
2. By being a path of dotted.key.tables. In this case, all the tables along the way are created and defined.

Its value can be:
- NIL means table is opened but not defined.
- T means defined via [Table] header.
- A table instance means defined under corresponding table section.

Type

boolean

Initargs

:definition-context

Readers

definition-context (generic function)

Writers

(setf definition-context) (generic function)

Class: table-array ()

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Direct superclasses

collection (class)

Direct methods

• serialize (method)
• print-object (method)

Direct slots

Slot: children

Initform

(list)

Class: toml-array-table ()

Package

clop.toml-block

Source

toml-block.lisp (file)

Direct superclasses

toml-named-table (class)

Direct methods

• parse-toml-block (method)
• print-object (method)

Class: toml-block ()

Package

clop.toml-block

Source

toml-block.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• toml-key-value-pair (class)
• toml-table (class)

Class: toml-inline-table ()

Package

clop.toml-block

Source

toml-block.lisp (file)

Direct superclasses

toml-table (class)

Direct methods

• parse-toml-block (method)
• print-object (method)
• pairs (method)
• pairs (method)

Direct slots

Slot: pairs

Type

list

Initargs

:pairs

Readers

pairs (generic function)

Writers

(setf pairs) (generic function)

Class: toml-key-value-pair ()

Package

clop.toml-block

Source

toml-block.lisp (file)

Direct superclasses

toml-block (class)

Direct methods

• parse-toml-block (method)
• print-object (method)
• value (method)
• value (method)
• keys (method)
• keys (method)

Direct slots

Slot: keys

Type

list

Initargs

:keys

Readers

keys (generic function)

Writers

(setf keys) (generic function)

Slot: value

Initargs

:value

Readers

value (generic function)

Writers

(setf value) (generic function)

Class: toml-named-table ()

Package

clop.toml-block

Source

toml-block.lisp (file)

Direct superclasses

toml-table (class)

Direct subclasses

toml-array-table (class)

Direct methods

• parse-toml-block (method)
• print-object (method)
• names (method)
• names (method)

Direct slots

Slot: names

Type

string

Initargs

:names

Readers

names (generic function)

Writers

(setf names) (generic function)

Class: toml-table ()

Package

clop.toml-block

Source

toml-block.lisp (file)

Direct superclasses

toml-block (class)

Direct subclasses

• toml-named-table (class)
• toml-inline-table (class)

6.2 Internal definitions

6.2.1 Functions

Function: append-child TABLE-ARRAY TABLE

Append TABLE as a child to TABLE-ARRAY.

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Function: basic-unescaped-char-p CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: comment-char-p CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: get-child TABLE NAME

Get the child of TABLE specified by NAME.

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Function: hexp CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: last-child TABLE-ARRAY

Get the last child of TABLE-ARRAY.

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Function: literal-char-p CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: multiline-basic-text-p CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: multiline-literal-char-p CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: non-ascii-p CHAR

Package

clop.rules

Source

rules.lisp (file)

Function: parse-number STRING &key RADIX START

Parse number from STRING with underscores dropped.

Package

clop.rules

Source

rules.lisp (file)

Function: parse-pair-value VALUE CONTEXT

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Function: parse-utf8 TEXT

Package

clop.rules

Source

rules.lisp (file)

Function: parse-value TYPE TEXT

Package

clop.rules

Source

rules.lisp (file)

Function: set-child TABLE NAME VALUE

Set the child of TABLE specified by NAME to VALUE.

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

6.2.2 Generic functions

Generic Function: current-table OBJECT

Generic Function: (setf current-table) NEW-VALUE OBJECT

Package

clop.toml-block-parser

Methods

Method: current-table (PARSER-CONTEXT parser-context)

automatically generated reader method

Source

toml-block-parser.lisp (file)

Method: (setf current-table) NEW-VALUE (PARSER-CONTEXT parser-context)

automatically generated writer method

Source

toml-block-parser.lisp (file)

Generic Function: definition-context OBJECT

Generic Function: (setf definition-context) NEW-VALUE OBJECT

Package

clop.toml-block-parser

Methods

Method: definition-context (TABLE table)

Method: (setf definition-context) NEW-VALUE (TABLE table)

Internal use.

Indicates if the table is defined or not.
A table is defined in the following ways:
1. By [Table] header.
2. By being a path of dotted.key.tables. In this case, all the tables along the way are created and defined.

Its value can be:
- NIL means table is opened but not defined.
- T means defined via [Table] header.
- A table instance means defined under corresponding table section.

Source

toml-block-parser.lisp (file)

Generic Function: names CONDITION

Generic Function: (setf names) NEW-VALUE CONDITION

Package

clop.conditions

Methods

Method: names (CONDITION toml-table-error)

Method: (setf names) NEW-VALUE (CONDITION toml-table-error)

Source

conditions.lisp (file)

Generic Function: parse-toml-block TOML-BLOCK CONTEXT

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Methods

Method: parse-toml-block (TOML-TABLE toml-inline-table) CONTEXT

Method: parse-toml-block (PAIR toml-key-value-pair) CONTEXT

Method: parse-toml-block (TOML-TABLE toml-array-table) CONTEXT

Method: parse-toml-block (TOML-TABLE toml-named-table) CONTEXT

Generic Function: root-table OBJECT

Package

clop.toml-block-parser

Methods

Method: root-table (PARSER-CONTEXT parser-context)

automatically generated reader method

Source

toml-block-parser.lisp (file)

Generic Function: serialize TABLE STYLE

Convert given TABLE to STYLE.
The TABLE should be the root table containing

Package

clop

Source

clop.lisp (file)

Methods

Method: serialize THING (STYLE (eql raw))

Method: serialize (THING list) STYLE

Method: serialize THING STYLE

Method: serialize (TABLE table-array) STYLE

Method: serialize (TABLE inline-table) (STYLE (eql alist))

Method: serialize (TABLE table) (STYLE (eql alist))

Method: serialize (TABLE inline-table) (STYLE (eql jsown))

Method: serialize (TABLE table) (STYLE (eql jsown))

Generic Function: text CONDITION

Generic Function: (setf text) NEW-VALUE CONDITION

Package

clop.conditions

Methods

Method: text (CONDITION toml-invalid-text-error)

Method: (setf text) NEW-VALUE (CONDITION toml-invalid-text-error)

Source

conditions.lisp (file)

6.2.3 Classes

Class: parser-context ()

Package

clop.toml-block-parser

Source

toml-block-parser.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• current-table (method)
• current-table (method)
• root-table (method)

Direct slots

Slot: root-table

Initform

(make-instance (quote clop.toml-block-parser:table))

Readers

root-table (generic function)

Slot: current-table

Readers

current-table (generic function)

Writers

(setf current-table) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types