The cl-json-pointer Reference Manual

4.1.1 cl-json-pointer/cl-json-pointer.asd

Source

cl-json-pointer.asd.

Parent Component

cl-json-pointer (system).

ASDF Systems

• cl-json-pointer.
• cl-json-pointer/core.
• cl-json-pointer/st-json-support.
• cl-json-pointer/boost-json-support.

4.1.2 cl-json-pointer/core/src/package.lisp

Source

cl-json-pointer.asd.

Parent Component

src (module).

Packages

cl-json-pointer.

4.1.3 cl-json-pointer/core/src/util.lisp

Dependency

package.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• array-try-push (function).
• clone-and-replace-on-cons (function).
• compare-string-by-readtable-case (function).
• delete-cons (function).
• extend-array (function).
• extend-list (function).
• remove-cons (function).
• thunk-lambda (macro).

4.1.4 cl-json-pointer/core/src/condition.lisp

Dependency

package.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Public Interface

json-pointer-error (condition).

Internals

• json-pointer-access-error (condition).
• json-pointer-bad-reference-token-0-used-error (condition).
• json-pointer-bad-reference-token-error (condition).
• json-pointer-bad-reference-token-not-numeric-error (condition).
• json-pointer-parse-error (condition).

4.1.5 cl-json-pointer/core/src/parser.lisp

Dependency

condition.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Public Interface

parse-json-pointer (generic function).

Internals

• +end+ (constant).
• +parse-json-pointer-default-buffer-length+ (constant).
• intern-object-key (generic function).
• parsed-json-pointer (type).
• read-reference-token-as-index (function).

4.1.6 cl-json-pointer/core/src/traversal.lisp

Dependencies

• util.lisp (file).
• condition.lisp (file).
• parser.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• *traverse-nil-set-to-index-method* (special variable).
• *traverse-nil-set-to-last-method* (special variable).
• *traverse-nil-set-to-name-method* (special variable).
• *traverse-object-like-kinds* (special variable).
• *traverse-treat-string-as-atom* (special variable).
• bad-deleter-error (function).
• chained-setter-lambda (macro).
• error-on-traversing-atom (function).
• list-try-traverse (function).
• traverse-by-json-pointer (function).
• traverse-by-reference-token (generic function).
• traverse-by-reference-token-using-class (function).
• vector-in-bounds-p (function).

4.1.7 cl-json-pointer/core/src/interface.lisp

Dependency

traversal.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Public Interface

• *json-object-flavor* (special variable).
• add-by-json-pointer (function).
• delete-by-json-pointer (function).
• deletef-by-json-pointer (macro).
• exists-p-by-json-pointer (function).
• (setf get-by-json-pointer) (setf expander).
• get-by-json-pointer (function).
• remove-by-json-pointer (function).
• set-by-json-pointer (function).
• update-by-json-pointer (macro).

Internals

make-setter-by-json-pointer (function).

4.1.8 cl-json-pointer/core/src/support.lisp

Dependency

traversal.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Public Interface

*cl-json-pointer-supported-json-flavors* (special variable).

4.1.9 cl-json-pointer/core/src/support_cl-json.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• +identifier-name-to-key-name+ (constant).
• +json-identifier-name-to-lisp-name+ (constant).
• intern-object-key (method).

4.1.10 cl-json-pointer/core/src/support_com-gigamonkeys-json.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• traverse-by-reference-token (method).
• traverse-by-reference-token (method).

4.1.11 cl-json-pointer/core/src/support_com-inuoe-jzon.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

4.1.12 cl-json-pointer/core/src/support_jonathan.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• intern-object-key (method).
• traverse-by-reference-token (method).

4.1.13 cl-json-pointer/core/src/support_json-lib.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

4.1.14 cl-json-pointer/core/src/support_json-streams.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• traverse-by-reference-token (method).
• traverse-by-reference-token (method).

4.1.15 cl-json-pointer/core/src/support_jsown.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• traverse-by-reference-token (method).
• traverse-by-reference-token (method).

4.1.16 cl-json-pointer/core/src/support_shasht.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

4.1.17 cl-json-pointer/core/src/support_trivial-json-codec.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

• intern-object-key (method).
• traverse-by-reference-token (method).
• traverse-by-reference-token (method).
• traverse-by-reference-token (method).

4.1.18 cl-json-pointer/core/src/support_yason.lisp

Dependency

support.lisp (file).

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

traverse-by-reference-token (method).

4.1.19 cl-json-pointer/st-json-support/src/support_st-json.lisp

Source

cl-json-pointer.asd.

Parent Component

src (module).

Internals

traverse-by-reference-token (method).

4.1.20 cl-json-pointer/boost-json-support/src/support_boost-json.lisp

Source

cl-json-pointer.asd.

Parent Component

src (module).

6.1.1 Special variables

Special Variable: *cl-json-pointer-supported-json-flavors* ¶

Holds symbols acceptable by ‘*json-object-flavor*’ and :FLAVOR keyword argument (except ‘T’)

Package

cl-json-pointer.

Source

support.lisp.

Special Variable: *json-object-flavor* ¶

Default flavor of JSON library currently used.
This value is used for :FLAVOR argument of exported functions.
Currently acceptable values are held by ‘*cl-json-pointer-supported-json-flavors*’

Default is ‘t’, behaves as well as possible without any knowledge about JSON libs.

Package

cl-json-pointer.

Source

interface.lisp.

6.1.2 Macros

Macro: deletef-by-json-pointer (place pointer &rest keyargs) ¶

Modify macro of ‘delete-by-json-pointer’. This sets results of ‘delete-by-json-pointer’ to the referred place.

Package

cl-json-pointer.

Source

interface.lisp.

Macro: update-by-json-pointer (place pointer value &rest keyargs) ¶

Modify macro of ‘set-by-json-pointer’. This sets results of ‘set-by-json-pointer’ to the referred place.

Package

cl-json-pointer.

Source

interface.lisp.

6.1.3 Setf expanders

Setf Expander: (setf get-by-json-pointer) (obj pointer &key flavor) ¶

A setf expansion for allowing ‘setf’ to ‘(get-by-json-pointer ...)’ forms.

Package

cl-json-pointer.

Source

interface.lisp.

Reader

get-by-json-pointer (function).

6.1.4 Ordinary functions

Function: add-by-json-pointer (obj pointer value &key flavor) ¶

Works same as ‘set-by-json-pointer’, except this try to make a new list when setting to lists.

Package

cl-json-pointer.

Source

interface.lisp.

Function: delete-by-json-pointer (obj pointer &key flavor) ¶

Traverses OBJ with POINTER, deletes the pointed place, and returns the modified OBJ

Package

cl-json-pointer.

Source

interface.lisp.

Function: exists-p-by-json-pointer (obj pointer &key flavor) ¶

Traverses OBJ with POINTER and returns the existence of the place pointed by POINTER.

Package

cl-json-pointer.

Source

interface.lisp.

Function: get-by-json-pointer (obj pointer &key flavor) ¶

Traverses OBJ with POINTER and returns three values:
the found value (‘nil’ if not found), a generalized boolean saying the existence of the place pointed by POINTER, and NIL.

Package

cl-json-pointer.

Source

interface.lisp.

Setf expander for this function

(setf get-by-json-pointer).

Function: remove-by-json-pointer (obj pointer &key flavor) ¶

Works same as ‘delete-by-json-pointer’, except this try to make a new list when deleting from lists.

Package

cl-json-pointer.

Source

interface.lisp.

Function: set-by-json-pointer (obj pointer value &key flavor) ¶

Traverses OBJ with POINTER, sets VALUE into the pointed place, and returns the modified OBJ

Package

cl-json-pointer.

Source

interface.lisp.

6.1.5 Generic functions

Generic Function: parse-json-pointer (obj &key start end accept-uri-fragment &allow-other-keys) ¶

Parses OBJ to an internal representation

Package

cl-json-pointer.

Source

parser.lisp.

Methods

Method: parse-json-pointer ((pointer string) &key start end accept-uri-fragment &allow-other-keys) ¶

Method: parse-json-pointer ((stream stream) &key accept-uri-fragment &allow-other-keys) ¶

Method: parse-json-pointer ((pointer list) &key &allow-other-keys) ¶

Method: parse-json-pointer (pointer &key &allow-other-keys) ¶

6.1.6 Conditions

Condition: json-pointer-error ¶

The root object of all errors related to cl-json-pointer

Package

cl-json-pointer.

Source

condition.lisp.

Direct superclasses

simple-error.

Direct subclasses

• json-pointer-access-error.
• json-pointer-bad-reference-token-error.
• json-pointer-parse-error.

6.2.1 Constants

Constant: +end+ ¶

A symbol indicates ’the (nonexistent) member after the last array element’, denoted by ’-’

Package

cl-json-pointer.

Source

parser.lisp.

Constant: +identifier-name-to-key-name+ ¶

Package

cl-json-pointer.

Source

support_cl-json.lisp.

Constant: +json-identifier-name-to-lisp-name+ ¶

Package

cl-json-pointer.

Source

support_cl-json.lisp.

Constant: +parse-json-pointer-default-buffer-length+ ¶

Package

cl-json-pointer.

Source

parser.lisp.

6.2.2 Special variables

Special Variable: *traverse-nil-set-to-index-method* ¶

Determines how to set to NIL by an index.
- ‘:list’ :: (Default) makes a new list and set <value> into nth point. - ‘:alist’ :: pushes (reference-token . <value>) as an alist.
- ‘:plist’ :: appends (reference-token <value>) as an plist.
- ‘:error’ :: throws an error.

Package

cl-json-pointer.

Source

traversal.lisp.

Special Variable: *traverse-nil-set-to-last-method* ¶

Determines how to set to the last (by ’-’) of NIL.
- ‘:list’ :: (Default) pushes <value> as an ordinal list. - ‘:alist’ :: pushes (reference-token . <value>) as an alist. - ‘:plist’ :: appends (reference-token <value>) as an plist. - ‘:array’ :: makes a new array contains <value>.

Package

cl-json-pointer.

Source

traversal.lisp.

Special Variable: *traverse-nil-set-to-name-method* ¶

Determines how to set to NIL by a name.
- ‘:alist’ :: (Default) pushes (reference-token . <value>) as an alist. - ‘:plist’ :: appends (reference-token <value>) as an plist.

Package

cl-json-pointer.

Source

traversal.lisp.

Special Variable: *traverse-object-like-kinds* ¶

Package

cl-json-pointer.

Source

traversal.lisp.

Special Variable: *traverse-treat-string-as-atom* ¶

If this is T, cl-json-pointer trests string as atom.

Package

cl-json-pointer.

Source

traversal.lisp.

6.2.3 Macros

Macro: chained-setter-lambda ((&rest vars) (next-function &optional next-arg) &body body) ¶

Package

cl-json-pointer.

Source

traversal.lisp.

Macro: thunk-lambda (&body form) ¶

Used for making thunks.

Package

cl-json-pointer.

Source

util.lisp.

6.2.4 Ordinary functions

Function: array-try-push (array x) ¶

Package

cl-json-pointer.

Source

util.lisp.

Function: bad-deleter-error (obj rtoken) ¶

Package

cl-json-pointer.

Source

traversal.lisp.

Function: clone-and-replace-on-cons (list cons value) ¶

Makes a fresh list whose contents is same as LIST except the car of
CONS is replaced with VALUE. If CONS is not contained in LIST,
returns a new list by appending LIST, (list VALUE) and the cdr of CONS to the LIST.

Package

cl-json-pointer.

Source

util.lisp.

Function: compare-string-by-readtable-case (a b &key case) ¶

Package

cl-json-pointer.

Source

util.lisp.

Function: delete-cons (list cons &optional count) ¶

Destructively modifies LIST to exclude the CONS and successive COUNT conses. If CONS is not contained in LIST, returns a list by ‘nconc’ing LIST and (nthcdr COUNT CONS).

Package

cl-json-pointer.

Source

util.lisp.

Function: error-on-traversing-atom (flavor obj rtoken) ¶

Package

cl-json-pointer.

Source

traversal.lisp.

Function: extend-array (array new-length fill-pointer) ¶

Makes a new adjustable fill-pointered array having same contents as ARRAY.

Package

cl-json-pointer.

Source

util.lisp.

Function: extend-list (list n &key initial-element) ¶

Destructively extends LIST to size N.

Package

cl-json-pointer.

Source

util.lisp.

Function: list-try-traverse (kinds flavor list rtoken set-method next-setter) ¶

Package

cl-json-pointer.

Source

traversal.lisp.

Function: make-setter-by-json-pointer (obj obj-flavor pointer set-method) ¶

Updating functions (‘set-by-json-pointer’, ‘delete-by-json-pointer’, etc) calls this for making a setter function.

Package

cl-json-pointer.

Source

interface.lisp.

Function: read-reference-token-as-index (rtoken &optional errorp) ¶

Package

cl-json-pointer.

Source

parser.lisp.

Function: remove-cons (list cons &optional count) ¶

Makes a fresh list whose contents is same as LIST except the CONS and successive COUNT conses. If CONS is not contained in LIST, returns a new list by appending LIST and (nthcdr COUNT CONS).

Package

cl-json-pointer.

Source

util.lisp.

Function: traverse-by-json-pointer (obj flavor pointer set-method) ¶

Traverses OBJ with a parsed json-pointer (POINTER), and returns three values:
the referred object, existence (boolean), and a closure can be used as a setter.

SET-METHOD determines how to _set_ into OBJ by the returned setter:
- ‘nil’ :: No setters made. (Do not set to OBJ.)
- ‘:update’ :: Destructively updates into OBJ.
- ‘:delete’ :: Destructively deletes from OBJ.
- ‘:add’ :: If changing a list, makes a new list containing the set’ed value. (non-list objs are still modified).
- ‘:remove’ :: If deleting form a list, makes a new list not containing the removed value. (non-list objs are still modified).

FLAVOR is a keyword specifies the JSON object flavors.
See ‘*cl-json-pointer-supported-json-flavors*’

Package

cl-json-pointer.

Source

traversal.lisp.

Function: traverse-by-reference-token-using-class (flavor obj rtoken set-method next-setter class) ¶

Package

cl-json-pointer.

Source

traversal.lisp.

Function: vector-in-bounds-p (vector index) ¶

Because ‘array-in-bounds-p’ ignores fill-pointers.

Package

cl-json-pointer.

Source

traversal.lisp.

6.2.5 Generic functions

Generic Function: intern-object-key (flavor rtoken) ¶

Interns RTOKEN as JSON object key, with JSON lib flavor of FLAVOR

Package

cl-json-pointer.

Source

parser.lisp.

Methods

Method: intern-object-key ((flavor (eql :trivial-json-codec)) (rtoken string)) ¶

It seems trivial-json-codec ignores escape characters (backslashes).

For example, the result of
(trivial-json-codec:deserialize-raw cl-json-pointer/test::+test1-example+) contains (:I\\J 5). I think this should be (:I\J 5)

But, this method treats it in that way.

Source

support_trivial-json-codec.lisp.

Method: intern-object-key ((flavor (eql :jonathan)) rtoken) ¶

Source

support_jonathan.lisp.

Method: intern-object-key ((flavor (eql :cl-json)) rtoken) ¶

Source

support_cl-json.lisp.

Method: intern-object-key (flavor (rtoken symbol)) ¶

Method: intern-object-key (flavor (rtoken string)) ¶

Interns RTOKEN itself as JSON object key.
This is suitable for yason, st-json, jsown, json-streams, and com.gigamonkeys.json.

Generic Function: traverse-by-reference-token (flavor obj rtoken set-method next-setter) ¶

Traverses OBJ with a reference token (RTOKEN), and
returns three values: a referred object, existence (boolean), and a closure can be used as a setter.

FLAVOR is used when OBJ’s type is ambiguous, especially lists.

Package

cl-json-pointer.

Source

traversal.lisp.

Methods

Method: traverse-by-reference-token (flavor (obj jso) rtoken set-method next-setter) ¶

Source

support_st-json.lisp.

Method: traverse-by-reference-token ((flavor (eql :yason)) (obj list) (rtoken string) set-method next-setter) ¶

Source

support_yason.lisp.

Method: traverse-by-reference-token :around ((flavor (eql :trivial-json-codec)) (obj null) rtoken set-method next-setter) ¶

Source

support_trivial-json-codec.lisp.

Method: traverse-by-reference-token ((flavor (eql :trivial-json-codec)) (obj list) (rtoken string) set-method next-setter) ¶

Source

support_trivial-json-codec.lisp.

Method: traverse-by-reference-token ((flavor (eql :trivial-json-codec-alist)) (alist list) rtoken set-method next-setter) ¶

The result of ‘trivial-json-codec:deserialize-raw’ looks like an alist, but its cdr is wrapped by a cons:

(trivial-json-codec:deserialize-raw "{ \"a\": 1, \"b\": 2}" ) ; => ((:A 1) (:B 2))

This method treats them specially.

Source

support_trivial-json-codec.lisp.

Method: traverse-by-reference-token ((flavor (eql :jsown)) (obj null) rtoken set-method next-setter) ¶

Source

support_jsown.lisp.

Method: traverse-by-reference-token ((flavor (eql :jsown)) (obj list) (rtoken string) set-method next-setter) ¶

Source

support_jsown.lisp.

Method: traverse-by-reference-token ((flavor (eql :json-streams)) (obj null) rtoken set-method next-setter) ¶

Source

support_json-streams.lisp.

Method: traverse-by-reference-token ((flavor (eql :json-streams)) (obj list) (rtoken string) set-method next-setter) ¶

Source

support_json-streams.lisp.

Method: traverse-by-reference-token ((flavor (eql :jonathan)) (obj null) rtoken set-method next-setter) ¶

Source

support_jonathan.lisp.

Method: traverse-by-reference-token ((flavor (eql :com.gigamonkeys.json)) (obj null) rtoken set-method next-setter) ¶

Source

support_com-gigamonkeys-json.lisp.

Method: traverse-by-reference-token ((flavor (eql :com.gigamonkeys.json)) (obj list) (rtoken string) set-method next-setter) ¶

Source

support_com-gigamonkeys-json.lisp.

Method: traverse-by-reference-token (flavor (obj array) (rtoken string) set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj array) (rtoken integer) set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj array) (rtoken (eql -)) set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj hash-table) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj structure-object) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj standard-object) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj null) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj list) (rtoken string) set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj list) (rtoken integer) set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj list) (rtoken (eql -)) set-method next-setter) ¶

Method: traverse-by-reference-token ((flavor (eql :list)) (list list) (rtoken string) set-method next-setter) ¶

Indexing to an ordinal list.

Method: traverse-by-reference-token ((flavor (eql :list)) (list list) (index integer) set-method next-setter) ¶

Indexing to an ordinal list.

Method: traverse-by-reference-token ((flavor (eql :list)) (list list) (rtoken (eql -)) set-method next-setter) ¶

Pushing to an ordinal list.

Method: traverse-by-reference-token ((flavor (eql :plist)) (plist list) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token ((flavor (eql :alist)) (alist list) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token (flavor (obj string) rtoken set-method next-setter) ¶

Method: traverse-by-reference-token (flavor obj rtoken set-method next-setter) ¶

6.2.6 Conditions

Condition: json-pointer-access-error ¶

Errors at traversing an object

Package

cl-json-pointer.

Source

condition.lisp.

Direct superclasses

json-pointer-error.

Condition: json-pointer-bad-reference-token-0-used-error ¶

Package

cl-json-pointer.

Source

condition.lisp.

Direct superclasses

json-pointer-bad-reference-token-error.

Direct Default Initargs

Initarg	Value
:format-control	reference token (~a) must not start with '0' when used as an index

Condition: json-pointer-bad-reference-token-error ¶

Errors related to the json-pointer syntax

Package

cl-json-pointer.

Source

condition.lisp.

Direct superclasses

json-pointer-error.

Direct subclasses

• json-pointer-bad-reference-token-0-used-error.
• json-pointer-bad-reference-token-not-numeric-error.

Direct Default Initargs

Initarg	Value
:format-control	bad reference token (~a)

Direct slots

Slot: rtoken ¶

Initform

(quote nil)

Initargs

:reference-token

Condition: json-pointer-bad-reference-token-not-numeric-error ¶

Package

cl-json-pointer.

Source

condition.lisp.

Direct superclasses

json-pointer-bad-reference-token-error.

Direct Default Initargs

Initarg	Value
:format-control	reference token (~a) cannot be read as index

Condition: json-pointer-parse-error ¶

Thrown by ‘parse-json-pointer’

Package

cl-json-pointer.

Source

condition.lisp.

Direct superclasses

json-pointer-error.

6.2.7 Types

Type: parsed-json-pointer () ¶

Package

cl-json-pointer.

Source

parser.lisp.