This is the shasht Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:35:24 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
shashtJSON reading and writing for the Kzinti.
Tarn W. Burton
MIT
0.1
trivial-do (system).
closer-mop (system).
src (module).
Modules are listed depth-first from the system components tree.
shasht/srcshasht (system).
packages.lisp (file).
utils.lisp (file).
config.lisp (file).
read.lisp (file).
write.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
shasht/shasht.asdshasht/src/packages.lispshasht/src/utils.lispshasht/src/config.lispshasht/src/read.lispshasht/src/write.lispshasht/src/utils.lisppackages.lisp (file).
src (module).
make-object (function).
alistp (function).
ascii-printable-p (function).
control-char-p (function).
high-surrogate (type).
high-surrogate-p (function).
integer-char-p (function).
low-surrogate (type).
plistp (function).
supplementary-plane-p (function).
surrogates-to-codepoint (function).
shasht/src/config.lisputils.lisp (file).
src (module).
*read-default-array-format* (special variable).
*read-default-false-value* (special variable).
*read-default-null-value* (special variable).
*read-default-object-format* (special variable).
*read-default-true-value* (special variable).
*read-length* (special variable).
*read-level* (special variable).
*symbol-name-function* (special variable).
*write-alist-as-object* (special variable).
*write-array-tags* (special variable).
*write-ascii-encoding* (special variable).
*write-empty-array-values* (special variable).
*write-empty-object-values* (special variable).
*write-false-values* (special variable).
*write-indent-string* (special variable).
*write-null-values* (special variable).
*write-object-alist-tags* (special variable).
*write-object-plist-tags* (special variable).
*write-plist-as-object* (special variable).
*write-true-values* (special variable).
shasht/src/read.lispconfig.lisp (file).
src (module).
read-json (function).
read-json* (function).
shasht-invalid-char (condition).
shasht-invalid-char-char (reader method).
shasht-invalid-char-expected (reader method).
shasht-parse-error (condition).
shasht-read-length-exceeded (condition).
shasht-read-level-exceeded (condition).
copy-reader-state (function).
expect-char (function).
frob-input-stream (function).
make-reader-state (function).
read-encoded-char (function).
read-json-number (function).
read-json-string (function).
reader-state (structure).
reader-state-key (reader).
(setf reader-state-key) (writer).
reader-state-length (reader).
(setf reader-state-length) (writer).
reader-state-p (function).
reader-state-type (reader).
(setf reader-state-type) (writer).
reader-state-value (reader).
(setf reader-state-value) (writer).
skip-whitespace (function).
shasht/src/write.lispread.lisp (file).
src (module).
print-json-delimiter (function).
print-json-key-value (generic function).
print-json-value (generic function).
with-json-array (macro).
with-json-key (macro).
with-json-object (macro).
write-json (function).
write-json* (function).
write-json-string (function).
*delimiter* (special variable).
*next-delimiter* (special variable).
*next-terminator* (special variable).
*terminator* (special variable).
*write-indent-level* (special variable).
make-newline-string (function).
print-json-mop (function).
Packages are listed by definition order.
shashtcommon-lisp.
*read-default-array-format* (special variable).
*read-default-false-value* (special variable).
*read-default-null-value* (special variable).
*read-default-object-format* (special variable).
*read-default-true-value* (special variable).
*read-length* (special variable).
*read-level* (special variable).
*symbol-name-function* (special variable).
*write-alist-as-object* (special variable).
*write-array-tags* (special variable).
*write-ascii-encoding* (special variable).
*write-empty-array-values* (special variable).
*write-empty-object-values* (special variable).
*write-false-values* (special variable).
*write-indent-string* (special variable).
*write-null-values* (special variable).
*write-object-alist-tags* (special variable).
*write-object-plist-tags* (special variable).
*write-plist-as-object* (special variable).
*write-true-values* (special variable).
make-object (function).
print-json-delimiter (function).
print-json-key-value (generic function).
print-json-value (generic function).
read-json (function).
read-json* (function).
shasht-invalid-char (condition).
shasht-invalid-char-char (generic reader).
shasht-invalid-char-expected (generic reader).
shasht-parse-error (condition).
shasht-read-length-exceeded (condition).
shasht-read-level-exceeded (condition).
with-json-array (macro).
with-json-key (macro).
with-json-object (macro).
write-json (function).
write-json* (function).
write-json-string (function).
*delimiter* (special variable).
*next-delimiter* (special variable).
*next-terminator* (special variable).
*terminator* (special variable).
*write-indent-level* (special variable).
alistp (function).
ascii-printable-p (function).
control-char-p (function).
copy-reader-state (function).
expect-char (function).
frob-input-stream (function).
high-surrogate (type).
high-surrogate-p (function).
integer-char-p (function).
low-surrogate (type).
make-newline-string (function).
make-reader-state (function).
plistp (function).
print-json-mop (function).
read-encoded-char (function).
read-json-number (function).
read-json-string (function).
reader-state (structure).
reader-state-key (reader).
(setf reader-state-key) (writer).
reader-state-length (reader).
(setf reader-state-length) (writer).
reader-state-p (function).
reader-state-type (reader).
(setf reader-state-type) (writer).
reader-state-value (reader).
(setf reader-state-value) (writer).
skip-whitespace (function).
supplementary-plane-p (function).
surrogates-to-codepoint (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The default format to use when reading an array. Current supported formats are :vector or :list.
The default value to return when reading a false token.
The default value to return when reading a null token.
The default format to use when reading an object. Current supported formats are :hash-table, :alist or :plist.
The default value to return when reading a true token.
The maximum number of values in an array or an object.
The maximum number of levels to allow during reading.
If true then assocation lists will be written as an object.
Indicators in the CAR of a list that indicate that the CDR or the list should be written as an array.
If true then any non ASCII values will be encoded using Unicode escape sequences.
Values that will be written as an empty array.
Values that will be written as an empty object.
Values that will be written as a false token.
The string to use when indenting objects and arrays.
Values that will be written as a null token.
Indicators in the CAR of a list that indicate that the CDR of the list is an alist and should be written as object.
Indicators in the CAR of a list that indicate that the CDR of the list is an plist and should be written as object.
If true then property lists will be written as an object.
Values that will be written as a true token.
Enable JSON array writing for body. Array open/close and commas will be automatically handled when calls to print-json-value are made.
Enable JSON object writing for body. Object open/close and commas will be automatically handled when calls to print-json-key-value are made.
Create a hash table based on args (in plist format) and a test of equal.
Read a JSON value. Reading is influenced by the dynamic variables *read-default-true-value*, *read-default-false-value*, *read-default-null-value*, *read-default-array-format*, *read-default-object-format* and common-lisp:*read-default-float-format* which each determine the default values and formats used. The following arguments also control the behavior of the read.
* input-stream-or-string - a stream, a string or t. If t is passed then
*standard-input* is used.
* eof-error-p - if true signal eof with error, otherwise return eof-value.
* eof-value - value used if eof-error-p is nil.
* single-value-p - Check for trailing junk after read is complete.
Read a JSON value.
* stream - a stream, a string or t. If t is passed then *standard-input* is used.
* eof-error - if true signal eof with error, otherwise return eof-value.
* eof-value - value used if eof-error-p is nil.
* single-value - Check for trailing junk after read is complete.
* true-value - The value to return when reading a true token.
* false-value - The value to return when reading a false token.
* null-value - The value to return when reading a null token.
* array-format - The format to use when reading an array. Current supported formats are
:vector or :list.
* object-format - The format to use when reading an object. Current supported formats are
:hash-table, :alist or :plist.
* float-format - The format of floating point values.
Write a JSON value. Writing is influenced by the dynamic variables
*write-ascii-encoding*, *write-true-values*, *write-false-values*,
*write-null-values*, *write-alist-as-object*, *write-plist-as-object*,
*write-indent-string* and common-lisp:*print-pretty*.
The following arguments also control the behavior of the write.
* value - The value to be written.
* output-stream - a stream or nil to return a string or t to use
*standard-output*.
Write a JSON value.
The following arguments also control the behavior of the write.
* value - The value to be written.
* stream - a stream or nil to return a string or t to use
*standard-output*.
* ascii-encoding - If true then any non ASCII values will be encoded
using Unicode escape sequences.
* true-values - Values that will be written as a true token.
* false-values - Values that will be written as a false token.
* null-values - Values that will be written as a null token.
* empty-array-values - Values that will be written as an empty array.
* empty-object-values - Values that will be written as an empty object.
* array-tags - A list of values whose appearance in the CAR of a list
indicates the CDR of the list should be written as an array.
* object-alist-tags - A list of values whose appearance in the CAR of
a list indicates the CDR of the list is an alist and should be written as an
object.
* object-plist - A list of values whose appearance in the CAR of
a list indicates the CDR of the list is a plist and should be written as an
object.
* alist-as-object - If true then assocation lists will be written as an object.
* plist-as-object - If true then property lists will be written as an object.
* pretty - Use indentation in printing.
* indent-string - The string to use when indenting objects and arrays.
Write value as a JSON string to stream specified by output-stream.
Print a JSON key value. Must be used inside of with-json-object.
Print a JSON value to output-stream. Used by write-json to dispatch based on type.
structure-object) output-stream) ¶standard-object) output-stream) ¶character) output-stream) ¶pathname) output-stream) ¶symbol) output-stream) ¶array) output-stream) ¶vector) output-stream) ¶list) output-stream) ¶hash-table) output-stream) ¶string) output-stream) ¶integer) output-stream) ¶number) output-stream) ¶shasht-invalid-char)) ¶shasht-invalid-char)) ¶parse-error.
| Jump to: | (
A C E F G H I M P R S W |
|---|
| Jump to: | (
A C E F G H I M P R S W |
|---|
| Jump to: | *
C E K L S T V |
|---|
| Jump to: | *
C E K L S T V |
|---|
| Jump to: | C F H L M P R S T U W |
|---|
| Jump to: | C F H L M P R S T U W |
|---|