source: project/wiki/eggref/4/json @ 34088

== json

=== Author

Tony Garnock-Jones


=== Requirements

* [[http://wiki.call-cc.org/eggref/4/packrat|packrat]]

=== Description

This extension implements a parser and generator for the  [[http://www.json.org|JSON]] data interchange format.

See also [[json-abnf]] and [[medea]].

=== API

<procedure>(json-write OBJECT [PORT])</procedure>

Writes the Scheme data object {{OBJECT}} in JSON format to {{PORT}} which defaults
to the value of {{(current-output-port)}}. Scheme data is mapped to JSON format in the following way:

<table>
        <tr><th align="left"> Scheme</th><th align="left">JSON</th></tr>
        <tr><td>Hash-table</td><td>Structure</td></tr>
        <tr><td>Vector</td><td>Structure (assuming vector consists of <tt>(SYMBOL . DATA)</tt> pairs</td></tr>
        <tr><td>List</td><td>Array</td></tr>
        <tr><td>Number</td><td>Number</td></tr>
        <tr><td>Void</td><td>Null</td></tr>
        <tr><td>String or symbol</td><td>String</td></tr>
</table>

<procedure>(json-read [PORT])</procedure>

Reads data in JSON format from {{PORT}} which defaults to the value of {{(current-input-port)}}.

Note that json-read does not produce alists, as the result are vectors and not lists, and keys are strings and not symbols.

=== License

 MIT
 
 Copyright (c) 2004, 2005 Tony Garnock-Jones <tonyg@kcbbs.gen.nz>
 Copyright (c) 2005 LShift Ltd. <query@lshift.net>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use, copy,
 modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

=== Version history

; 1.5 : .meta fixes
; 1.3 : ported to CHICKEN 4
; 1.2 : handling of unicode escapes [by Dan Muresan]
; 1.1 : Bugfix to handle null
; 1.0 : Initial release