The cl-json-helper Reference Manual

Table of Contents

The cl-json-helper Reference Manual

This is the cl-json-helper Reference Manual, version 1.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 12:13:01 2021 GMT+0.

1 Introduction

###cl-json-helper: A Common Lisp library to assist cl-json.

cl-json encodes and decodes JSON data. cl-json-helper adds two functions to help encoding JSON data and one function to help in processing decoded JSON data.

The nickname xjson can be used for the cl-json-helper package.

[Function] json-empty ()

	The return value is decoded by cl-json as {}.
	
	Example:
		(cl-json:encode-json-to-string `(("Empty" . ,(xjson:json-empty))))
	=> "{\"Empty\":{}}"

[Function] json-bool (val)

	Encodes val as "true" or "false"

	Examples:
		(cl-json:encode-json-to-string `(("TRUE" . ,(xjson:json-bool t))))
	=> "{\"TRUE\":true}"
		(cl-json:encode-json-to-string `(("FALSE" . ,(xjson:json-bool nil))))
	=> "{\"FALSE\":false}"

[Function] json-key-value (key list &key (test #'eql))

	Return the value associated with _key_ in a decoded JSON list, if present, and whether
	or not _key_ was found.
	
	(cl-json:encode-json-to-string '(("HELLO" . "WORLD")
	                                 ("ITS" . "ME")
	                                 ("CEST" . "MOI")))
	=> "{\"HELLO\":\"WORLD\",\"ITS\":\"ME\",\"CEST\":\"MOI\"}"
	
	(cl-json:decode-json-from-string "{\"HELLO\":\"WORLD\",\"ITS\":\"ME\",\"CEST\":\"MOI\"}")
	=> ((:+HELLO+ . "WORLD") (:+ITS+ . "ME") (:+CEST+ . "MOI"))
	
	(xjson:json-key-value :+CEST+ '((:+HELLO+ . "WORLD") (:+ITS+ . "ME") (:+CEST+ . "MOI")))
	=> "MOI"
	   T
	
	(xjson:json-key-value :+FALSE+ (cl-json:decode-json-from-string "{\"FALSE\":false}"))
	=> NIL
	   T
	
	(xjson:json-key-value :+BAR+ (cl-json:decode-json-from-string "{\"FALSE\":false}"))
	=> NIL
	   NIL

json-key-value is just a glorified call to Lisp's assoc

Repository

https://github.com/stablecross/cl-json-helper

####License cl-json-helper is available under a BSD-like license. See the file LICENSE for details.

Contact

For any questions or comments, please feel free to email me, Bob Felts wrf3@stablecross.com

2 Systems

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

2.1 cl-json-helper

Author

Bob Felts <wrf3@stablecross.com>

License

BSD

Description

Handy extras for cl-json

Version

1.1.0

Dependency

cl-json

Source

cl-json-helper.asd (file)

Components

• package.lisp (file)
• cl-json-helper.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-json-helper.asd

Location

cl-json-helper.asd

Systems

cl-json-helper (system)

3.1.2 cl-json-helper/package.lisp

Parent

cl-json-helper (system)

Location

package.lisp

Packages

cl-json-helper

3.1.3 cl-json-helper/cl-json-helper.lisp

Dependency

package.lisp (file)

Parent

cl-json-helper (system)

Location

cl-json-helper.lisp

Exported Definitions

• json-bool (function)
• json-empty (function)
• json-key-value (function)
• value-of (function)

Internal Definitions

• *json-empty-obj* (special variable)
• *json-false-obj* (special variable)
• json-empty-obj (class)
• json-false-obj (class)
• value-of-helper (function)

4 Packages

Packages are listed by definition order.

4.1 cl-json-helper

Source

package.lisp (file)

Nickname

xjson

Use List

common-lisp

Exported Definitions

• json-bool (function)
• json-empty (function)
• json-key-value (function)
• value-of (function)

Internal Definitions

• *json-empty-obj* (special variable)
• *json-false-obj* (special variable)
• json-empty-obj (class)
• json-false-obj (class)
• value-of-helper (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: json-bool VAL

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

Function: json-empty ()

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

Function: json-key-value KEY LIST &key TEST

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

Function: value-of LIST &rest KEYS

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *json-empty-obj*

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

Special Variable: *json-false-obj*

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

5.2.2 Functions

Function: value-of-helper LIST KEYS

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

5.2.3 Classes

Class: json-empty-obj ()

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

Direct superclasses

standard-object (class)

Class: json-false-obj ()

Package

cl-json-helper

Source

cl-json-helper.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

encode-json (method)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types