The monkeylib-json Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The monkeylib-json Reference Manual

This is the monkeylib-json Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:19:56 2018 GMT+0.


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

1 Systems

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


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

1.1 com.gigamonkeys.json

Author

Peter Seibel <peter@gigamonkeys.com>

Description

Library for reading and writing JSON-formatted data.

Dependencies
Source

com.gigamonkeys.json.asd (file)

Components

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

2 Files

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


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

2.1 Lisp


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

2.1.1 com.gigamonkeys.json.asd

Location

com.gigamonkeys.json.asd

Systems

com.gigamonkeys.json (system)


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

2.1.2 com.gigamonkeys.json/packages.lisp

Parent

com.gigamonkeys.json (system)

Location

packages.lisp

Packages

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

2.1.3 com.gigamonkeys.json/json.lisp

Dependency

packages.lisp (file)

Parent

com.gigamonkeys.json (system)

Location

json.lisp

Exported Definitions
Internal Definitions

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

2.1.4 com.gigamonkeys.json/json-builder.lisp

Dependency

packages.lisp (file)

Parent

com.gigamonkeys.json (system)

Location

json-builder.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 com.gigamonkeys.json

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

3.2 com.gigamonkeys.json.parser

Source

packages.lisp (file)

Use List
Used By List

com.gigamonkeys.json

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Special variables

Special Variable: *object-type*
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)


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

4.1.2 Functions

Function: json DATA

The top-level function for converting Lisp objects into a string in the JSON format. It can convert any object that can be converted to a json-exp via the to-json generic function.

Package

com.gigamonkeys.json

Source

json.lisp (file)

Function: parse-json TEXT

Parse json text into Lisp objects. Hash tables are used to represent Javascript objects and vectors to represent arrays.

Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Function: write-json DATA &optional STREAM

Write DATA to STREAM in JSON format.

Package

com.gigamonkeys.json

Source

json.lisp (file)


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

4.1.3 Generic functions

Generic Function: json-stringify OBJECT

Convert object directly to a JSON representation as
a string. Default methods are provided for strings, symbols (which must be keywords), and numbers but there may be situations where it is appropriate to define new methods on this function. In general, however, it is probably better to define a method on to-json to convert the object to a sexp that can be rendered as JSON.

Package

com.gigamonkeys.json

Source

json.lisp (file)

Methods
Method: json-stringify (OBJECT number)
Method: json-stringify (OBJECT symbol)
Method: json-stringify (OBJECT string)
Method: json-stringify OBJECT
Generic Function: to-json THING

Generic function that can convert an arbitrary Lisp
object to a json-exp, i.e. a sexp that can then be rendered as json. To make an arbitrary class convertable to JSON, add a method to this generic function that generates a json-exp.

Package

com.gigamonkeys.json

Source

json.lisp (file)

Methods
Method: to-json (THING hash-table)
Method: to-json THING

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

4.2 Internal definitions


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

4.2.1 Special variables

Special Variable: *empty-object*
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)


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

4.2.2 Macros

Macro: tjp PRODUCTION INPUT
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)


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

4.2.3 Functions

Function: emit-json-char CHAR STREAM
Package

com.gigamonkeys.json

Source

json.lisp (file)

Function: fix-empty-object JSON
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Function: json-parser INPUT
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)


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

4.2.4 Generic functions

Generic Function: emit-json OBJECT STREAM

Emit object to stream as JSON.

Package

com.gigamonkeys.json

Source

json.lisp (file)

Methods
Method: emit-json (OBJECT (eql t)) STREAM
Method: emit-json (OBJECT number) STREAM
Method: emit-json (OBJECT string) STREAM
Method: emit-json (OBJECT symbol) STREAM
Method: emit-json (OBJECT vector) STREAM
Method: emit-json (OBJECT cons) STREAM
Method: emit-json (OBJECT (eql nil)) STREAM
Method: emit-json OBJECT STREAM
Generic Function: finish-object OBJECT

Return the actual object that will be put into the data structure.

Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Methods
Method: finish-object (OBJECT hash-table)
Method: finish-object (OBJECT vector)
Generic Function: make-object TYPE

Make a new object for a given named type.

Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Methods
Method: make-object (TYPE (eql hash-table))
Method: make-object (TYPE (eql vector))
Generic Function: save-key-value KEY-VALUE-PAIR OBJECT

Save the key and value in the data structure returned by MAKE-OBJECT.

Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Methods
Method: save-key-value KEY-VALUE-PAIR (OBJECT hash-table)
Method: save-key-value KEY-VALUE-PAIR (OBJECT vector)

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

4.2.5 Types

Type: digit ()
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Type: digit1-9 ()
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Type: hex ()
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)

Type: string-char ()
Package

com.gigamonkeys.json.parser

Source

json-builder.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
com.gigamonkeys.json.asd: The com<dot>gigamonkeys<dot>json<dot>asd file
com.gigamonkeys.json/json-builder.lisp: The com<dot>gigamonkeys<dot>json/json-builder<dot>lisp file
com.gigamonkeys.json/json.lisp: The com<dot>gigamonkeys<dot>json/json<dot>lisp file
com.gigamonkeys.json/packages.lisp: The com<dot>gigamonkeys<dot>json/packages<dot>lisp file

F
File, Lisp, com.gigamonkeys.json.asd: The com<dot>gigamonkeys<dot>json<dot>asd file
File, Lisp, com.gigamonkeys.json/json-builder.lisp: The com<dot>gigamonkeys<dot>json/json-builder<dot>lisp file
File, Lisp, com.gigamonkeys.json/json.lisp: The com<dot>gigamonkeys<dot>json/json<dot>lisp file
File, Lisp, com.gigamonkeys.json/packages.lisp: The com<dot>gigamonkeys<dot>json/packages<dot>lisp file

L
Lisp File, com.gigamonkeys.json.asd: The com<dot>gigamonkeys<dot>json<dot>asd file
Lisp File, com.gigamonkeys.json/json-builder.lisp: The com<dot>gigamonkeys<dot>json/json-builder<dot>lisp file
Lisp File, com.gigamonkeys.json/json.lisp: The com<dot>gigamonkeys<dot>json/json<dot>lisp file
Lisp File, com.gigamonkeys.json/packages.lisp: The com<dot>gigamonkeys<dot>json/packages<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   E   F   G   J   M   P   S   T   W  
Index Entry  Section

E
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json: Internal generic functions
emit-json-char: Internal functions

F
finish-object: Internal generic functions
finish-object: Internal generic functions
finish-object: Internal generic functions
fix-empty-object: Internal functions
Function, emit-json-char: Internal functions
Function, fix-empty-object: Internal functions
Function, json: Exported functions
Function, json-parser: Internal functions
Function, parse-json: Exported functions
Function, write-json: Exported functions

G
Generic Function, emit-json: Internal generic functions
Generic Function, finish-object: Internal generic functions
Generic Function, json-stringify: Exported generic functions
Generic Function, make-object: Internal generic functions
Generic Function, save-key-value: Internal generic functions
Generic Function, to-json: Exported generic functions

J
json: Exported functions
json-parser: Internal functions
json-stringify: Exported generic functions
json-stringify: Exported generic functions
json-stringify: Exported generic functions
json-stringify: Exported generic functions
json-stringify: Exported generic functions

M
Macro, tjp: Internal macros
make-object: Internal generic functions
make-object: Internal generic functions
make-object: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, emit-json: Internal generic functions
Method, finish-object: Internal generic functions
Method, finish-object: Internal generic functions
Method, json-stringify: Exported generic functions
Method, json-stringify: Exported generic functions
Method, json-stringify: Exported generic functions
Method, json-stringify: Exported generic functions
Method, make-object: Internal generic functions
Method, make-object: Internal generic functions
Method, save-key-value: Internal generic functions
Method, save-key-value: Internal generic functions
Method, to-json: Exported generic functions
Method, to-json: Exported generic functions

P
parse-json: Exported functions

S
save-key-value: Internal generic functions
save-key-value: Internal generic functions
save-key-value: Internal generic functions

T
tjp: Internal macros
to-json: Exported generic functions
to-json: Exported generic functions
to-json: Exported generic functions

W
write-json: Exported functions

Jump to:   E   F   G   J   M   P   S   T   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*empty-object*: Internal special variables
*object-type*: Exported special variables

S
Special Variable, *empty-object*: Internal special variables
Special Variable, *object-type*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   D   H   P   S   T  
Index Entry  Section

C
com.gigamonkeys.json: The com<dot>gigamonkeys<dot>json system
com.gigamonkeys.json: The com<dot>gigamonkeys<dot>json package
com.gigamonkeys.json.parser: The com<dot>gigamonkeys<dot>json<dot>parser package

D
digit: Internal types
digit1-9: Internal types

H
hex: Internal types

P
Package, com.gigamonkeys.json: The com<dot>gigamonkeys<dot>json package
Package, com.gigamonkeys.json.parser: The com<dot>gigamonkeys<dot>json<dot>parser package

S
string-char: Internal types
System, com.gigamonkeys.json: The com<dot>gigamonkeys<dot>json system

T
Type, digit: Internal types
Type, digit1-9: Internal types
Type, hex: Internal types
Type, string-char: Internal types

Jump to:   C   D   H   P   S   T