[ViewVC] Diff of: cvs/JSON-XS/README

Comparing JSON-XS/README (file contents):
Revision 1.18 by root, Tue Aug 28 02:06:06 2007 UTC vs.
Revision 1.27 by root, Tue Jul 15 11:29:29 2008 UTC

…		…
1	NAME	1	NAME
2	JSON::XS - JSON serialising/deserialising, done correctly and fast	2	JSON::XS - JSON serialising/deserialising, done correctly and fast
3		3
		4	JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ
		5	(http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html)
		6
4	SYNOPSIS	7	SYNOPSIS
5	use JSON::XS;	8	use JSON::XS;
6		9
7	# exported functions, they croak on error	10	# exported functions, they croak on error
8	# and expect/generate UTF-8	11	# and expect/generate UTF-8
9		12
10	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;	13	$utf8_encoded_json_text = encode_json $perl_hash_or_arrayref;
11	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;	14	$perl_hash_or_arrayref = decode_json $utf8_encoded_json_text;
12		15
13	# OO-interface	16	# OO-interface
14		17
15	$coder = JSON::XS->new->ascii->pretty->allow_nonref;	18	$coder = JSON::XS->new->ascii->pretty->allow_nonref;
16	$pretty_printed_unencoded = $coder->encode ($perl_scalar);	19	$pretty_printed_unencoded = $coder->encode ($perl_scalar);
17	$perl_scalar = $coder->decode ($unicode_json_text);	20	$perl_scalar = $coder->decode ($unicode_json_text);
		21
		22	# Note that JSON version 2.0 and above will automatically use JSON::XS
		23	# if available, at virtually no speed overhead either, so you should
		24	# be able to just:
		25
		26	use JSON;
		27
		28	# and do the same things, except that you have a pure-perl fallback now.
18		29
19	DESCRIPTION	30	DESCRIPTION
20	This module converts Perl data structures to JSON and vice versa. Its	31	This module converts Perl data structures to JSON and vice versa. Its
21	primary goal is to be correct and its secondary goal is to be fast.	32	primary goal is to be correct and its secondary goal is to be fast.
22	To reach the latter goal it was written in C.	33	To reach the latter goal it was written in C.
		34
		35	Beginning with version 2.0 of the JSON module, when both JSON and
		36	JSON::XS are installed, then JSON will fall back on JSON::XS (this can
		37	be overridden) with no overhead due to emulation (by inheriting
		38	constructor and methods). If JSON::XS is not available, it will fall
		39	back to the compatible JSON::PP module as backend, so using JSON instead
		40	of JSON::XS gives you a portable JSON API that can be fast when you need
		41	and doesn't require a C compiler when that is a problem.
23		42
24	As this is the n-th-something JSON module on CPAN, what was the reason	43	As this is the n-th-something JSON module on CPAN, what was the reason
25	to write yet another JSON module? While it seems there are many JSON	44	to write yet another JSON module? While it seems there are many JSON
26	modules, none of them correctly handle all corner cases, and in most	45	modules, none of them correctly handle all corner cases, and in most
27	cases their maintainers are unresponsive, gone missing, or not listening	46	cases their maintainers are unresponsive, gone missing, or not listening
31		50
32	See MAPPING, below, on how JSON::XS maps perl values to JSON values and	51	See MAPPING, below, on how JSON::XS maps perl values to JSON values and
33	vice versa.	52	vice versa.
34		53
35	FEATURES	54	FEATURES
36	* correct unicode handling	55	* correct Unicode handling
		56
37	This module knows how to handle Unicode, and even documents how and	57	This module knows how to handle Unicode, documents how and when it
38	when it does so.	58	does so, and even documents what "correct" means.
39		59
40	* round-trip integrity	60	* round-trip integrity
		61
41	When you serialise a perl data structure using only datatypes	62	When you serialise a perl data structure using only data types
42	supported by JSON, the deserialised data structure is identical on	63	supported by JSON, the deserialised data structure is identical on
43	the Perl level. (e.g. the string "2.0" doesn't suddenly become "2"	64	the Perl level. (e.g. the string "2.0" doesn't suddenly become "2"
44	just because it looks like a number).	65	just because it looks like a number). There minor are exceptions
		66	to this, read the MAPPING section below to learn about those.
45		67
46	* strict checking of JSON correctness	68	* strict checking of JSON correctness
		69
47	There is no guessing, no generating of illegal JSON texts by	70	There is no guessing, no generating of illegal JSON texts by
48	default, and only JSON is accepted as input by default (the latter	71	default, and only JSON is accepted as input by default (the latter
49	is a security feature).	72	is a security feature).
50		73
51	* fast	74	* fast
52	Compared to other JSON modules, this module compares favourably in
53	terms of speed, too.
54		75
		76	Compared to other JSON modules and other serialisers such as
		77	Storable, this module usually compares favourably in terms of speed,
		78	too.
		79
55	* simple to use	80	* simple to use
		81
56	This module has both a simple functional interface as well as an OO	82	This module has both a simple functional interface as well as an
57	interface.	83	object oriented interface interface.
58		84
59	* reasonably versatile output formats	85	* reasonably versatile output formats
		86
60	You can choose between the most compact guarenteed single-line	87	You can choose between the most compact guaranteed-single-line
61	format possible (nice for simple line-based protocols), a pure-ascii	88	format possible (nice for simple line-based protocols), a pure-ASCII
62	format (for when your transport is not 8-bit clean, still supports	89	format (for when your transport is not 8-bit clean, still supports
63	the whole unicode range), or a pretty-printed format (for when you	90	the whole Unicode range), or a pretty-printed format (for when you
64	want to read that stuff). Or you can combine those features in	91	want to read that stuff). Or you can combine those features in
65	whatever way you like.	92	whatever way you like.
66		93
67	FUNCTIONAL INTERFACE	94	FUNCTIONAL INTERFACE
68	The following convinience methods are provided by this module. They are	95	The following convenience methods are provided by this module. They are
69	exported by default:	96	exported by default:
70		97
71	$json_text = to_json $perl_scalar	98	$json_text = encode_json $perl_scalar
72	Converts the given Perl data structure (a simple scalar or a	99	Converts the given Perl data structure to a UTF-8 encoded, binary
73	reference to a hash or array) to a UTF-8 encoded, binary string
74	(that is, the string contains octets only). Croaks on error.	100	string (that is, the string contains octets only). Croaks on error.
75		101
76	This function call is functionally identical to:	102	This function call is functionally identical to:
77		103
78	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)	104	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)
79		105
80	except being faster.	106	Except being faster.
81		107
82	$perl_scalar = from_json $json_text	108	$perl_scalar = decode_json $json_text
83	The opposite of "to_json": expects an UTF-8 (binary) string and	109	The opposite of "encode_json": expects an UTF-8 (binary) string and
84	tries to parse that as an UTF-8 encoded JSON text, returning the	110	tries to parse that as an UTF-8 encoded JSON text, returning the
85	resulting simple scalar or reference. Croaks on error.	111	resulting reference. Croaks on error.
86		112
87	This function call is functionally identical to:	113	This function call is functionally identical to:
88		114
89	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	115	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
90		116
91	except being faster.	117	Except being faster.
92		118
93	$is_boolean = JSON::XS::is_bool $scalar	119	$is_boolean = JSON::XS::is_bool $scalar
94	Returns true if the passed scalar represents either JSON::XS::true	120	Returns true if the passed scalar represents either JSON::XS::true
95	or JSON::XS::false, two constants that act like 1 and 0,	121	or JSON::XS::false, two constants that act like 1 and 0,
96	respectively and are used to represent JSON "true" and "false"	122	respectively and are used to represent JSON "true" and "false"
97	values in Perl.	123	values in Perl.
98		124
99	See MAPPING, below, for more information on how JSON values are	125	See MAPPING, below, for more information on how JSON values are
100	mapped to Perl.	126	mapped to Perl.
101		127
		128	A FEW NOTES ON UNICODE AND PERL
		129	Since this often leads to confusion, here are a few very clear words on
		130	how Unicode works in Perl, modulo bugs.
		131
		132	1. Perl strings can store characters with ordinal values > 255.
		133	This enables you to store Unicode characters as single characters in
		134	a Perl string - very natural.
		135
		136	2. Perl does not associate an encoding with your strings.
		137	... until you force it to, e.g. when matching it against a regex, or
		138	printing the scalar to a file, in which case Perl either interprets
		139	your string as locale-encoded text, octets/binary, or as Unicode,
		140	depending on various settings. In no case is an encoding stored
		141	together with your data, it is use that decides encoding, not any
		142	magical meta data.
		143
		144	3. The internal utf-8 flag has no meaning with regards to the encoding
		145	of your string.
		146	Just ignore that flag unless you debug a Perl bug, a module written
		147	in XS or want to dive into the internals of perl. Otherwise it will
		148	only confuse you, as, despite the name, it says nothing about how
		149	your string is encoded. You can have Unicode strings with that flag
		150	set, with that flag clear, and you can have binary data with that
		151	flag set and that flag clear. Other possibilities exist, too.
		152
		153	If you didn't know about that flag, just the better, pretend it
		154	doesn't exist.
		155
		156	4. A "Unicode String" is simply a string where each character can be
		157	validly interpreted as a Unicode code point.
		158	If you have UTF-8 encoded data, it is no longer a Unicode string,
		159	but a Unicode string encoded in UTF-8, giving you a binary string.
		160
		161	5. A string containing "high" (> 255) character values is not a UTF-8
		162	string.
		163	It's a fact. Learn to live with it.
		164
		165	I hope this helps :)
		166
102	OBJECT-ORIENTED INTERFACE	167	OBJECT-ORIENTED INTERFACE
103	The object oriented interface lets you configure your own encoding or	168	The object oriented interface lets you configure your own encoding or
104	decoding style, within the limits of supported formats.	169	decoding style, within the limits of supported formats.
105		170
106	$json = new JSON::XS	171	$json = new JSON::XS
…		…
113		178
114	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})	179	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
115	=> {"a": [1, 2]}	180	=> {"a": [1, 2]}
116		181
117	$json = $json->ascii ([$enable])	182	$json = $json->ascii ([$enable])
		183	$enabled = $json->get_ascii
118	If $enable is true (or missing), then the "encode" method will not	184	If $enable is true (or missing), then the "encode" method will not
119	generate characters outside the code range 0..127 (which is ASCII).	185	generate characters outside the code range 0..127 (which is ASCII).
120	Any unicode characters outside that range will be escaped using	186	Any Unicode characters outside that range will be escaped using
121	either a single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL	187	either a single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL
122	escape sequence, as per RFC4627. The resulting encoded JSON text can	188	escape sequence, as per RFC4627. The resulting encoded JSON text can
123	be treated as a native unicode string, an ascii-encoded,	189	be treated as a native Unicode string, an ascii-encoded,
124	latin1-encoded or UTF-8 encoded string, or any other superset of	190	latin1-encoded or UTF-8 encoded string, or any other superset of
125	ASCII.	191	ASCII.
126		192
127	If $enable is false, then the "encode" method will not escape	193	If $enable is false, then the "encode" method will not escape
128	Unicode characters unless required by the JSON syntax or other	194	Unicode characters unless required by the JSON syntax or other
129	flags. This results in a faster and more compact format.	195	flags. This results in a faster and more compact format.
130		196
		197	See also the section ENCODING/CODESET FLAG NOTES later in this
		198	document.
		199
131	The main use for this flag is to produce JSON texts that can be	200	The main use for this flag is to produce JSON texts that can be
132	transmitted over a 7-bit channel, as the encoded JSON texts will not	201	transmitted over a 7-bit channel, as the encoded JSON texts will not
133	contain any 8 bit characters.	202	contain any 8 bit characters.
134		203
135	JSON::XS->new->ascii (1)->encode ([chr 0x10401])	204	JSON::XS->new->ascii (1)->encode ([chr 0x10401])
136	=> ["\ud801\udc01"]	205	=> ["\ud801\udc01"]
137		206
138	$json = $json->latin1 ([$enable])	207	$json = $json->latin1 ([$enable])
		208	$enabled = $json->get_latin1
139	If $enable is true (or missing), then the "encode" method will	209	If $enable is true (or missing), then the "encode" method will
140	encode the resulting JSON text as latin1 (or iso-8859-1), escaping	210	encode the resulting JSON text as latin1 (or iso-8859-1), escaping
141	any characters outside the code range 0..255. The resulting string	211	any characters outside the code range 0..255. The resulting string
142	can be treated as a latin1-encoded JSON text or a native unicode	212	can be treated as a latin1-encoded JSON text or a native Unicode
143	string. The "decode" method will not be affected in any way by this	213	string. The "decode" method will not be affected in any way by this
144	flag, as "decode" by default expects unicode, which is a strict	214	flag, as "decode" by default expects Unicode, which is a strict
145	superset of latin1.	215	superset of latin1.
146		216
147	If $enable is false, then the "encode" method will not escape	217	If $enable is false, then the "encode" method will not escape
148	Unicode characters unless required by the JSON syntax or other	218	Unicode characters unless required by the JSON syntax or other
149	flags.	219	flags.
		220
		221	See also the section ENCODING/CODESET FLAG NOTES later in this
		222	document.
150		223
151	The main use for this flag is efficiently encoding binary data as	224	The main use for this flag is efficiently encoding binary data as
152	JSON text, as most octets will not be escaped, resulting in a	225	JSON text, as most octets will not be escaped, resulting in a
153	smaller encoded size. The disadvantage is that the resulting JSON	226	smaller encoded size. The disadvantage is that the resulting JSON
154	text is encoded in latin1 (and must correctly be treated as such	227	text is encoded in latin1 (and must correctly be treated as such
155	when storing and transfering), a rare encoding for JSON. It is	228	when storing and transferring), a rare encoding for JSON. It is
156	therefore most useful when you want to store data structures known	229	therefore most useful when you want to store data structures known
157	to contain binary data efficiently in files or databases, not when	230	to contain binary data efficiently in files or databases, not when
158	talking to other JSON encoders/decoders.	231	talking to other JSON encoders/decoders.
159		232
160	JSON::XS->new->latin1->encode (["\x{89}\x{abc}"]	233	JSON::XS->new->latin1->encode (["\x{89}\x{abc}"]
161	=> ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not)	234	=> ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not)
162		235
163	$json = $json->utf8 ([$enable])	236	$json = $json->utf8 ([$enable])
		237	$enabled = $json->get_utf8
164	If $enable is true (or missing), then the "encode" method will	238	If $enable is true (or missing), then the "encode" method will
165	encode the JSON result into UTF-8, as required by many protocols,	239	encode the JSON result into UTF-8, as required by many protocols,
166	while the "decode" method expects to be handled an UTF-8-encoded	240	while the "decode" method expects to be handled an UTF-8-encoded
167	string. Please note that UTF-8-encoded strings do not contain any	241	string. Please note that UTF-8-encoded strings do not contain any
168	characters outside the range 0..255, they are thus useful for	242	characters outside the range 0..255, they are thus useful for
169	bytewise/binary I/O. In future versions, enabling this option might	243	bytewise/binary I/O. In future versions, enabling this option might
170	enable autodetection of the UTF-16 and UTF-32 encoding families, as	244	enable autodetection of the UTF-16 and UTF-32 encoding families, as
171	described in RFC4627.	245	described in RFC4627.
172		246
173	If $enable is false, then the "encode" method will return the JSON	247	If $enable is false, then the "encode" method will return the JSON
174	string as a (non-encoded) unicode string, while "decode" expects	248	string as a (non-encoded) Unicode string, while "decode" expects
175	thus a unicode string. Any decoding or encoding (e.g. to UTF-8 or	249	thus a Unicode string. Any decoding or encoding (e.g. to UTF-8 or
176	UTF-16) needs to be done yourself, e.g. using the Encode module.	250	UTF-16) needs to be done yourself, e.g. using the Encode module.
		251
		252	See also the section ENCODING/CODESET FLAG NOTES later in this
		253	document.
177		254
178	Example, output UTF-16BE-encoded JSON:	255	Example, output UTF-16BE-encoded JSON:
179		256
180	use Encode;	257	use Encode;
181	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);	258	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);
…		…
200	2	277	2
201	]	278	]
202	}	279	}
203		280
204	$json = $json->indent ([$enable])	281	$json = $json->indent ([$enable])
		282	$enabled = $json->get_indent
205	If $enable is true (or missing), then the "encode" method will use a	283	If $enable is true (or missing), then the "encode" method will use a
206	multiline format as output, putting every array member or	284	multiline format as output, putting every array member or
207	object/hash key-value pair into its own line, identing them	285	object/hash key-value pair into its own line, indenting them
208	properly.	286	properly.
209		287
210	If $enable is false, no newlines or indenting will be produced, and	288	If $enable is false, no newlines or indenting will be produced, and
211	the resulting JSON text is guarenteed not to contain any "newlines".	289	the resulting JSON text is guaranteed not to contain any "newlines".
212		290
213	This setting has no effect when decoding JSON texts.	291	This setting has no effect when decoding JSON texts.
214		292
215	$json = $json->space_before ([$enable])	293	$json = $json->space_before ([$enable])
		294	$enabled = $json->get_space_before
216	If $enable is true (or missing), then the "encode" method will add	295	If $enable is true (or missing), then the "encode" method will add
217	an extra optional space before the ":" separating keys from values	296	an extra optional space before the ":" separating keys from values
218	in JSON objects.	297	in JSON objects.
219		298
220	If $enable is false, then the "encode" method will not add any extra	299	If $enable is false, then the "encode" method will not add any extra
…		…
226	Example, space_before enabled, space_after and indent disabled:	305	Example, space_before enabled, space_after and indent disabled:
227		306
228	{"key" :"value"}	307	{"key" :"value"}
229		308
230	$json = $json->space_after ([$enable])	309	$json = $json->space_after ([$enable])
		310	$enabled = $json->get_space_after
231	If $enable is true (or missing), then the "encode" method will add	311	If $enable is true (or missing), then the "encode" method will add
232	an extra optional space after the ":" separating keys from values in	312	an extra optional space after the ":" separating keys from values in
233	JSON objects and extra whitespace after the "," separating key-value	313	JSON objects and extra whitespace after the "," separating key-value
234	pairs and array members.	314	pairs and array members.
235		315
…		…
241	Example, space_before and indent disabled, space_after enabled:	321	Example, space_before and indent disabled, space_after enabled:
242		322
243	{"key": "value"}	323	{"key": "value"}
244		324
245	$json = $json->relaxed ([$enable])	325	$json = $json->relaxed ([$enable])
		326	$enabled = $json->get_relaxed
246	If $enable is true (or missing), then "decode" will accept some	327	If $enable is true (or missing), then "decode" will accept some
247	extensions to normal JSON syntax (see below). "encode" will not be	328	extensions to normal JSON syntax (see below). "encode" will not be
248	affected in anyway. *Be aware that this option makes you accept	329	affected in anyway. *Be aware that this option makes you accept
249	invalid JSON texts as if they were valid!*. I suggest only to use	330	invalid JSON texts as if they were valid!*. I suggest only to use
250	this option to parse application-specific files written by humans	331	this option to parse application-specific files written by humans
…		…
253	If $enable is false (the default), then "decode" will only accept	334	If $enable is false (the default), then "decode" will only accept
254	valid JSON texts.	335	valid JSON texts.
255		336
256	Currently accepted extensions are:	337	Currently accepted extensions are:
257		338
258	* list items can have an end-comma	339	* list items can have an end-comma
		340
259	JSON separates array elements and key-value pairs with commas.	341	JSON separates array elements and key-value pairs with commas.
260	This can be annoying if you write JSON texts manually and want	342	This can be annoying if you write JSON texts manually and want
261	to be able to quickly append elements, so this extension accepts	343	to be able to quickly append elements, so this extension accepts
262	comma at the end of such items not just between them:	344	comma at the end of such items not just between them:
263		345
…		…
268	{	350	{
269	"k1": "v1",	351	"k1": "v1",
270	"k2": "v2", <- this comma not normally allowed	352	"k2": "v2", <- this comma not normally allowed
271	}	353	}
272		354
273	* shell-style '#'-comments	355	* shell-style '#'-comments
		356
274	Whenever JSON allows whitespace, shell-style comments are	357	Whenever JSON allows whitespace, shell-style comments are
275	additionally allowed. They are terminated by the first	358	additionally allowed. They are terminated by the first
276	carriage-return or line-feed character, after which more	359	carriage-return or line-feed character, after which more
277	white-space and comments are allowed.	360	white-space and comments are allowed.
278		361
…		…
280	1, # this comment not allowed in JSON	363	1, # this comment not allowed in JSON
281	# neither this one...	364	# neither this one...
282	]	365	]
283		366
284	$json = $json->canonical ([$enable])	367	$json = $json->canonical ([$enable])
		368	$enabled = $json->get_canonical
285	If $enable is true (or missing), then the "encode" method will	369	If $enable is true (or missing), then the "encode" method will
286	output JSON objects by sorting their keys. This is adding a	370	output JSON objects by sorting their keys. This is adding a
287	comparatively high overhead.	371	comparatively high overhead.
288		372
289	If $enable is false, then the "encode" method will output key-value	373	If $enable is false, then the "encode" method will output key-value
290	pairs in the order Perl stores them (which will likely change	374	pairs in the order Perl stores them (which will likely change
291	between runs of the same script).	375	between runs of the same script).
292		376
293	This option is useful if you want the same data structure to be	377	This option is useful if you want the same data structure to be
294	encoded as the same JSON text (given the same overall settings). If	378	encoded as the same JSON text (given the same overall settings). If
295	it is disabled, the same hash migh be encoded differently even if	379	it is disabled, the same hash might be encoded differently even if
296	contains the same data, as key-value pairs have no inherent ordering	380	contains the same data, as key-value pairs have no inherent ordering
297	in Perl.	381	in Perl.
298		382
299	This setting has no effect when decoding JSON texts.	383	This setting has no effect when decoding JSON texts.
300		384
301	$json = $json->allow_nonref ([$enable])	385	$json = $json->allow_nonref ([$enable])
		386	$enabled = $json->get_allow_nonref
302	If $enable is true (or missing), then the "encode" method can	387	If $enable is true (or missing), then the "encode" method can
303	convert a non-reference into its corresponding string, number or	388	convert a non-reference into its corresponding string, number or
304	null JSON value, which is an extension to RFC4627. Likewise,	389	null JSON value, which is an extension to RFC4627. Likewise,
305	"decode" will accept those JSON values instead of croaking.	390	"decode" will accept those JSON values instead of croaking.
306		391
…		…
313	"allow_nonref", resulting in an invalid JSON text:	398	"allow_nonref", resulting in an invalid JSON text:
314		399
315	JSON::XS->new->allow_nonref->encode ("Hello, World!")	400	JSON::XS->new->allow_nonref->encode ("Hello, World!")
316	=> "Hello, World!"	401	=> "Hello, World!"
317		402
		403	$json = $json->allow_unknown ([$enable])
		404	$enabled = $json->get_allow_unknown
		405	If $enable is true (or missing), then "encode" will not throw an
		406	exception when it encounters values it cannot represent in JSON (for
		407	example, filehandles) but instead will encode a JSON "null" value.
		408	Note that blessed objects are not included here and are handled
		409	separately by c<allow_nonref>.
		410
		411	If $enable is false (the default), then "encode" will throw an
		412	exception when it encounters anything it cannot encode as JSON.
		413
		414	This option does not affect "decode" in any way, and it is
		415	recommended to leave it off unless you know your communications
		416	partner.
		417
318	$json = $json->allow_blessed ([$enable])	418	$json = $json->allow_blessed ([$enable])
		419	$enabled = $json->get_allow_blessed
319	If $enable is true (or missing), then the "encode" method will not	420	If $enable is true (or missing), then the "encode" method will not
320	barf when it encounters a blessed reference. Instead, the value of	421	barf when it encounters a blessed reference. Instead, the value of
321	the convert_blessed option will decide wether "null"	422	the convert_blessed option will decide whether "null"
322	("convert_blessed" disabled or no "to_json" method found) or a	423	("convert_blessed" disabled or no "TO_JSON" method found) or a
323	representation of the object ("convert_blessed" enabled and	424	representation of the object ("convert_blessed" enabled and
324	"to_json" method found) is being encoded. Has no effect on "decode".	425	"TO_JSON" method found) is being encoded. Has no effect on "decode".
325		426
326	If $enable is false (the default), then "encode" will throw an	427	If $enable is false (the default), then "encode" will throw an
327	exception when it encounters a blessed object.	428	exception when it encounters a blessed object.
328		429
329	$json = $json->convert_blessed ([$enable])	430	$json = $json->convert_blessed ([$enable])
		431	$enabled = $json->get_convert_blessed
330	If $enable is true (or missing), then "encode", upon encountering a	432	If $enable is true (or missing), then "encode", upon encountering a
331	blessed object, will check for the availability of the "TO_JSON"	433	blessed object, will check for the availability of the "TO_JSON"
332	method on the object's class. If found, it will be called in scalar	434	method on the object's class. If found, it will be called in scalar
333	context and the resulting scalar will be encoded instead of the	435	context and the resulting scalar will be encoded instead of the
334	object. If no "TO_JSON" method is found, the value of	436	object. If no "TO_JSON" method is found, the value of
…		…
338	returns other blessed objects, those will be handled in the same	440	returns other blessed objects, those will be handled in the same
339	way. "TO_JSON" must take care of not causing an endless recursion	441	way. "TO_JSON" must take care of not causing an endless recursion
340	cycle (== crash) in this case. The name of "TO_JSON" was chosen	442	cycle (== crash) in this case. The name of "TO_JSON" was chosen
341	because other methods called by the Perl core (== not by the user of	443	because other methods called by the Perl core (== not by the user of
342	the object) are usually in upper case letters and to avoid	444	the object) are usually in upper case letters and to avoid
343	collisions with the "to_json" function.	445	collisions with any "to_json" function or method.
344		446
345	This setting does not yet influence "decode" in any way, but in the	447	This setting does not yet influence "decode" in any way, but in the
346	future, global hooks might get installed that influence "decode" and	448	future, global hooks might get installed that influence "decode" and
347	are enabled by this setting.	449	are enabled by this setting.
348		450
…		…
389		491
390	As this callback gets called less often then the	492	As this callback gets called less often then the
391	"filter_json_object" one, decoding speed will not usually suffer as	493	"filter_json_object" one, decoding speed will not usually suffer as
392	much. Therefore, single-key objects make excellent targets to	494	much. Therefore, single-key objects make excellent targets to
393	serialise Perl objects into, especially as single-key JSON objects	495	serialise Perl objects into, especially as single-key JSON objects
394	are as close to the type-tagged value concept as JSON gets (its	496	are as close to the type-tagged value concept as JSON gets (it's
395	basically an ID/VALUE tuple). Of course, JSON does not support this	497	basically an ID/VALUE tuple). Of course, JSON does not support this
396	in any way, so you need to make sure your data never looks like a	498	in any way, so you need to make sure your data never looks like a
397	serialised Perl hash.	499	serialised Perl hash.
398		500
399	Typical names for the single object key are "__class_whatever__", or	501	Typical names for the single object key are "__class_whatever__", or
…		…
424		526
425	{ __widget__ => $self->{id} }	527	{ __widget__ => $self->{id} }
426	}	528	}
427		529
428	$json = $json->shrink ([$enable])	530	$json = $json->shrink ([$enable])
		531	$enabled = $json->get_shrink
429	Perl usually over-allocates memory a bit when allocating space for	532	Perl usually over-allocates memory a bit when allocating space for
430	strings. This flag optionally resizes strings generated by either	533	strings. This flag optionally resizes strings generated by either
431	"encode" or "decode" to their minimum size possible. This can save	534	"encode" or "decode" to their minimum size possible. This can save
432	memory when your JSON texts are either very very long or you have	535	memory when your JSON texts are either very very long or you have
433	many short strings. It will also try to downgrade any strings to	536	many short strings. It will also try to downgrade any strings to
…		…
451	converting strings that look like integers or floats into integers	554	converting strings that look like integers or floats into integers
452	or floats internally (there is no difference on the Perl level),	555	or floats internally (there is no difference on the Perl level),
453	saving space.	556	saving space.
454		557
455	$json = $json->max_depth ([$maximum_nesting_depth])	558	$json = $json->max_depth ([$maximum_nesting_depth])
		559	$max_depth = $json->get_max_depth
456	Sets the maximum nesting level (default 512) accepted while encoding	560	Sets the maximum nesting level (default 512) accepted while encoding
457	or decoding. If the JSON text or Perl data structure has an equal or	561	or decoding. If a higher nesting level is detected in JSON text or a
458	higher nesting level then this limit, then the encoder and decoder	562	Perl data structure, then the encoder and decoder will stop and
459	will stop and croak at that point.	563	croak at that point.
460		564
461	Nesting level is defined by number of hash- or arrayrefs that the	565	Nesting level is defined by number of hash- or arrayrefs that the
462	encoder needs to traverse to reach a given point or the number of	566	encoder needs to traverse to reach a given point or the number of
463	"{" or "[" characters without their matching closing parenthesis	567	"{" or "[" characters without their matching closing parenthesis
464	crossed to reach a given character in a string.	568	crossed to reach a given character in a string.
465		569
466	Setting the maximum depth to one disallows any nesting, so that	570	Setting the maximum depth to one disallows any nesting, so that
467	ensures that the object is only a single hash/object or array.	571	ensures that the object is only a single hash/object or array.
468		572
469	The argument to "max_depth" will be rounded up to the next highest
470	power of two. If no argument is given, the highest possible setting	573	If no argument is given, the highest possible setting will be used,
471	will be used, which is rarely useful.	574	which is rarely useful.
		575
		576	Note that nesting is implemented by recursion in C. The default
		577	value has been chosen to be as large as typical operating systems
		578	allow without crashing.
472		579
473	See SECURITY CONSIDERATIONS, below, for more info on why this is	580	See SECURITY CONSIDERATIONS, below, for more info on why this is
474	useful.	581	useful.
475		582
476	$json = $json->max_size ([$maximum_string_size])	583	$json = $json->max_size ([$maximum_string_size])
		584	$max_size = $json->get_max_size
477	Set the maximum length a JSON text may have (in bytes) where	585	Set the maximum length a JSON text may have (in bytes) where
478	decoding is being attempted. The default is 0, meaning no limit.	586	decoding is being attempted. The default is 0, meaning no limit.
479	When "decode" is called on a string longer then this number of	587	When "decode" is called on a string that is longer then this many
480	characters it will not attempt to decode the string but throw an	588	bytes, it will not attempt to decode the string but throw an
481	exception. This setting has no effect on "encode" (yet).	589	exception. This setting has no effect on "encode" (yet).
482		590
483	The argument to "max_size" will be rounded up to the next highest
484	power of two (so may be more than requested). If no argument is
485	given, the limit check will be deactivated (same as when 0 is	591	If no argument is given, the limit check will be deactivated (same
486	specified).	592	as when 0 is specified).
487		593
488	See SECURITY CONSIDERATIONS, below, for more info on why this is	594	See SECURITY CONSIDERATIONS, below, for more info on why this is
489	useful.	595	useful.
490		596
491	$json_text = $json->encode ($perl_scalar)	597	$json_text = $json->encode ($perl_scalar)
…		…
516	and you need to know where the JSON text ends.	622	and you need to know where the JSON text ends.
517		623
518	JSON::XS->new->decode_prefix ("[1] the tail")	624	JSON::XS->new->decode_prefix ("[1] the tail")
519	=> ([], 3)	625	=> ([], 3)
520		626
		627	INCREMENTAL PARSING
		628	In some cases, there is the need for incremental parsing of JSON texts.
		629	While this module always has to keep both JSON text and resulting Perl
		630	data structure in memory at one time, it does allow you to parse a JSON
		631	stream incrementally. It does so by accumulating text until it has a
		632	full JSON object, which it then can decode. This process is similar to
		633	using "decode_prefix" to see if a full JSON object is available, but is
		634	much more efficient (and can be implemented with a minimum of method
		635	calls).
		636
		637	JSON::XS will only attempt to parse the JSON text once it is sure it has
		638	enough text to get a decisive result, using a very simple but truly
		639	incremental parser. This means that it sometimes won't stop as early as
		640	the full parser, for example, it doesn't detect parenthese mismatches.
		641	The only thing it guarantees is that it starts decoding as soon as a
		642	syntactically valid JSON text has been seen. This means you need to set
		643	resource limits (e.g. "max_size") to ensure the parser will stop parsing
		644	in the presence if syntax errors.
		645
		646	The following methods implement this incremental parser.
		647
		648	[void, scalar or list context] = $json->incr_parse ([$string])
		649	This is the central parsing function. It can both append new text
		650	and extract objects from the stream accumulated so far (both of
		651	these functions are optional).
		652
		653	If $string is given, then this string is appended to the already
		654	existing JSON fragment stored in the $json object.
		655
		656	After that, if the function is called in void context, it will
		657	simply return without doing anything further. This can be used to
		658	add more text in as many chunks as you want.
		659
		660	If the method is called in scalar context, then it will try to
		661	extract exactly one JSON object. If that is successful, it will
		662	return this object, otherwise it will return "undef". If there is a
		663	parse error, this method will croak just as "decode" would do (one
		664	can then use "incr_skip" to skip the errornous part). This is the
		665	most common way of using the method.
		666
		667	And finally, in list context, it will try to extract as many objects
		668	from the stream as it can find and return them, or the empty list
		669	otherwise. For this to work, there must be no separators between the
		670	JSON objects or arrays, instead they must be concatenated
		671	back-to-back. If an error occurs, an exception will be raised as in
		672	the scalar context case. Note that in this case, any
		673	previously-parsed JSON texts will be lost.
		674
		675	$lvalue_string = $json->incr_text
		676	This method returns the currently stored JSON fragment as an lvalue,
		677	that is, you can manipulate it. This only works when a preceding
		678	call to "incr_parse" in scalar context successfully returned an
		679	object. Under all other circumstances you must not call this
		680	function (I mean it. although in simple tests it might actually
		681	work, it will fail under real world conditions). As a special
		682	exception, you can also call this method before having parsed
		683	anything.
		684
		685	This function is useful in two cases: a) finding the trailing text
		686	after a JSON object or b) parsing multiple JSON objects separated by
		687	non-JSON text (such as commas).
		688
		689	$json->incr_skip
		690	This will reset the state of the incremental parser and will remove
		691	the parsed text from the input buffer. This is useful after
		692	"incr_parse" died, in which case the input buffer and incremental
		693	parser state is left unchanged, to skip the text parsed so far and
		694	to reset the parse state.
		695
		696	$json->incr_reset
		697	This completely resets the incremental parser, that is, after this
		698	call, it will be as if the parser had never parsed anything.
		699
		700	This is useful if you want ot repeatedly parse JSON objects and want
		701	to ignore any trailing data, which means you have to reset the
		702	parser after each successful decode.
		703
		704	LIMITATIONS
		705	All options that affect decoding are supported, except "allow_nonref".
		706	The reason for this is that it cannot be made to work sensibly: JSON
		707	objects and arrays are self-delimited, i.e. you can concatenate them
		708	back to back and still decode them perfectly. This does not hold true
		709	for JSON numbers, however.
		710
		711	For example, is the string 1 a single JSON number, or is it simply the
		712	start of 12? Or is 12 a single JSON number, or the concatenation of 1
		713	and 2? In neither case you can tell, and this is why JSON::XS takes the
		714	conservative route and disallows this case.
		715
		716	EXAMPLES
		717	Some examples will make all this clearer. First, a simple example that
		718	works similarly to "decode_prefix": We want to decode the JSON object at
		719	the start of a string and identify the portion after the JSON object:
		720
		721	my $text = "[1,2,3] hello";
		722
		723	my $json = new JSON::XS;
		724
		725	my $obj = $json->incr_parse ($text)
		726	or die "expected JSON object or array at beginning of string";
		727
		728	my $tail = $json->incr_text;
		729	# $tail now contains " hello"
		730
		731	Easy, isn't it?
		732
		733	Now for a more complicated example: Imagine a hypothetical protocol
		734	where you read some requests from a TCP stream, and each request is a
		735	JSON array, without any separation between them (in fact, it is often
		736	useful to use newlines as "separators", as these get interpreted as
		737	whitespace at the start of the JSON text, which makes it possible to
		738	test said protocol with "telnet"...).
		739
		740	Here is how you'd do it (it is trivial to write this in an event-based
		741	manner):
		742
		743	my $json = new JSON::XS;
		744
		745	# read some data from the socket
		746	while (sysread $socket, my $buf, 4096) {
		747
		748	# split and decode as many requests as possible
		749	for my $request ($json->incr_parse ($buf)) {
		750	# act on the $request
		751	}
		752	}
		753
		754	Another complicated example: Assume you have a string with JSON objects
		755	or arrays, all separated by (optional) comma characters (e.g. "[1],[2],
		756	[3]"). To parse them, we have to skip the commas between the JSON texts,
		757	and here is where the lvalue-ness of "incr_text" comes in useful:
		758
		759	my $text = "[1],[2], [3]";
		760	my $json = new JSON::XS;
		761
		762	# void context, so no parsing done
		763	$json->incr_parse ($text);
		764
		765	# now extract as many objects as possible. note the
		766	# use of scalar context so incr_text can be called.
		767	while (my $obj = $json->incr_parse) {
		768	# do something with $obj
		769
		770	# now skip the optional comma
		771	$json->incr_text =~ s/^ \s* , //x;
		772	}
		773
		774	Now lets go for a very complex example: Assume that you have a gigantic
		775	JSON array-of-objects, many gigabytes in size, and you want to parse it,
		776	but you cannot load it into memory fully (this has actually happened in
		777	the real world :).
		778
		779	Well, you lost, you have to implement your own JSON parser. But JSON::XS
		780	can still help you: You implement a (very simple) array parser and let
		781	JSON decode the array elements, which are all full JSON objects on their
		782	own (this wouldn't work if the array elements could be JSON numbers, for
		783	example):
		784
		785	my $json = new JSON::XS;
		786
		787	# open the monster
		788	open my $fh, "<bigfile.json"
		789	or die "bigfile: $!";
		790
		791	# first parse the initial "["
		792	for (;;) {
		793	sysread $fh, my $buf, 65536
		794	or die "read error: $!";
		795	$json->incr_parse ($buf); # void context, so no parsing
		796
		797	# Exit the loop once we found and removed(!) the initial "[".
		798	# In essence, we are (ab-)using the $json object as a simple scalar
		799	# we append data to.
		800	last if $json->incr_text =~ s/^ \s* \[ //x;
		801	}
		802
		803	# now we have the skipped the initial "[", so continue
		804	# parsing all the elements.
		805	for (;;) {
		806	# in this loop we read data until we got a single JSON object
		807	for (;;) {
		808	if (my $obj = $json->incr_parse) {
		809	# do something with $obj
		810	last;
		811	}
		812
		813	# add more data
		814	sysread $fh, my $buf, 65536
		815	or die "read error: $!";
		816	$json->incr_parse ($buf); # void context, so no parsing
		817	}
		818
		819	# in this loop we read data until we either found and parsed the
		820	# separating "," between elements, or the final "]"
		821	for (;;) {
		822	# first skip whitespace
		823	$json->incr_text =~ s/^\s*//;
		824
		825	# if we find "]", we are done
		826	if ($json->incr_text =~ s/^\]//) {
		827	print "finished.\n";
		828	exit;
		829	}
		830
		831	# if we find ",", we can continue with the next element
		832	if ($json->incr_text =~ s/^,//) {
		833	last;
		834	}
		835
		836	# if we find anything else, we have a parse error!
		837	if (length $json->incr_text) {
		838	die "parse error near ", $json->incr_text;
		839	}
		840
		841	# else add more data
		842	sysread $fh, my $buf, 65536
		843	or die "read error: $!";
		844	$json->incr_parse ($buf); # void context, so no parsing
		845	}
		846
		847	This is a complex example, but most of the complexity comes from the
		848	fact that we are trying to be correct (bear with me if I am wrong, I
		849	never ran the above example :).
		850
521	MAPPING	851	MAPPING
522	This section describes how JSON::XS maps Perl values to JSON values and	852	This section describes how JSON::XS maps Perl values to JSON values and
523	vice versa. These mappings are designed to "do the right thing" in most	853	vice versa. These mappings are designed to "do the right thing" in most
524	circumstances automatically, preserving round-tripping characteristics	854	circumstances automatically, preserving round-tripping characteristics
525	(what you put in comes out as something equivalent).	855	(what you put in comes out as something equivalent).
526		856
527	For the more enlightened: note that in the following descriptions,	857	For the more enlightened: note that in the following descriptions,
528	lowercase perl refers to the Perl interpreter, while uppcercase Perl	858	lowercase perl refers to the Perl interpreter, while uppercase Perl
529	refers to the abstract Perl language itself.	859	refers to the abstract Perl language itself.
530		860
531	JSON -> PERL	861	JSON -> PERL
532	object	862	object
533	A JSON object becomes a reference to a hash in Perl. No ordering of	863	A JSON object becomes a reference to a hash in Perl. No ordering of
534	object keys is preserved (JSON does not preserver object key	864	object keys is preserved (JSON does not preserve object key ordering
535	ordering itself).	865	itself).
536		866
537	array	867	array
538	A JSON array becomes a reference to an array in Perl.	868	A JSON array becomes a reference to an array in Perl.
539		869
540	string	870	string
…		…
546	A JSON number becomes either an integer, numeric (floating point) or	876	A JSON number becomes either an integer, numeric (floating point) or
547	string scalar in perl, depending on its range and any fractional	877	string scalar in perl, depending on its range and any fractional
548	parts. On the Perl level, there is no difference between those as	878	parts. On the Perl level, there is no difference between those as
549	Perl handles all the conversion details, but an integer may take	879	Perl handles all the conversion details, but an integer may take
550	slightly less memory and might represent more values exactly than	880	slightly less memory and might represent more values exactly than
551	(floating point) numbers.	881	floating point numbers.
552		882
553	If the number consists of digits only, JSON::XS will try to	883	If the number consists of digits only, JSON::XS will try to
554	represent it as an integer value. If that fails, it will try to	884	represent it as an integer value. If that fails, it will try to
555	represent it as a numeric (floating point) value if that is possible	885	represent it as a numeric (floating point) value if that is possible
556	without loss of precision. Otherwise it will preserve the number as	886	without loss of precision. Otherwise it will preserve the number as
557	a string value.	887	a string value (in which case you lose roundtripping ability, as the
		888	JSON number will be re-encoded toa JSON string).
558		889
559	Numbers containing a fractional or exponential part will always be	890	Numbers containing a fractional or exponential part will always be
560	represented as numeric (floating point) values, possibly at a loss	891	represented as numeric (floating point) values, possibly at a loss
561	of precision.	892	of precision (in which case you might lose perfect roundtripping
562		893	ability, but the JSON number will still be re-encoded as a JSON
563	This might create round-tripping problems as numbers might become	894	number).
564	strings, but as Perl is typeless there is no other way to do it.
565		895
566	true, false	896	true, false
567	These JSON atoms become "JSON::XS::true" and "JSON::XS::false",	897	These JSON atoms become "JSON::XS::true" and "JSON::XS::false",
568	respectively. They are overloaded to act almost exactly like the	898	respectively. They are overloaded to act almost exactly like the
569	numbers 1 and 0. You can check wether a scalar is a JSON boolean by	899	numbers 1 and 0. You can check whether a scalar is a JSON boolean by
570	using the "JSON::XS::is_bool" function.	900	using the "JSON::XS::is_bool" function.
571		901
572	null	902	null
573	A JSON null atom becomes "undef" in Perl.	903	A JSON null atom becomes "undef" in Perl.
574		904
…		…
597	an exception to be thrown, except for references to the integers 0	927	an exception to be thrown, except for references to the integers 0
598	and 1, which get turned into "false" and "true" atoms in JSON. You	928	and 1, which get turned into "false" and "true" atoms in JSON. You
599	can also use "JSON::XS::false" and "JSON::XS::true" to improve	929	can also use "JSON::XS::false" and "JSON::XS::true" to improve
600	readability.	930	readability.
601		931
602	to_json [\0,JSON::XS::true] # yields [false,true]	932	encode_json [\0, JSON::XS::true] # yields [false,true]
603		933
604	JSON::XS::true, JSON::XS::false	934	JSON::XS::true, JSON::XS::false
605	These special values become JSON true and JSON false values,	935	These special values become JSON true and JSON false values,
606	respectively. You cna alos use "\1" and "\0" directly if you want.	936	respectively. You can also use "\1" and "\0" directly if you want.
607		937
608	blessed objects	938	blessed objects
609	Blessed objects are not allowed. JSON::XS currently tries to encode	939	Blessed objects are not directly representable in JSON. See the
610	their underlying representation (hash- or arrayref), but this	940	"allow_blessed" and "convert_blessed" methods on various options on
611	behaviour might change in future versions.	941	how to deal with this: basically, you can choose between throwing an
		942	exception, encoding the reference as if it weren't blessed, or
		943	provide your own serialiser method.
612		944
613	simple scalars	945	simple scalars
614	Simple Perl scalars (any scalar that is not a reference) are the	946	Simple Perl scalars (any scalar that is not a reference) are the
615	most difficult objects to encode: JSON::XS will encode undefined	947	most difficult objects to encode: JSON::XS will encode undefined
616	scalars as JSON null value, scalars that have last been used in a	948	scalars as JSON "null" values, scalars that have last been used in a
617	string context before encoding as JSON strings and anything else as	949	string context before encoding as JSON strings, and anything else as
618	number value:	950	number value:
619		951
620	# dump as number	952	# dump as number
621	to_json [2] # yields [2]	953	encode_json [2] # yields [2]
622	to_json [-3.0e17] # yields [-3e+17]	954	encode_json [-3.0e17] # yields [-3e+17]
623	my $value = 5; to_json [$value] # yields [5]	955	my $value = 5; encode_json [$value] # yields [5]
624		956
625	# used as string, so dump as string	957	# used as string, so dump as string
626	print $value;	958	print $value;
627	to_json [$value] # yields ["5"]	959	encode_json [$value] # yields ["5"]
628		960
629	# undef becomes null	961	# undef becomes null
630	to_json [undef] # yields [null]	962	encode_json [undef] # yields [null]
631		963
632	You can force the type to be a string by stringifying it:	964	You can force the type to be a JSON string by stringifying it:
633		965
634	my $x = 3.1; # some variable containing a number	966	my $x = 3.1; # some variable containing a number
635	"$x"; # stringified	967	"$x"; # stringified
636	$x .= ""; # another, more awkward way to stringify	968	$x .= ""; # another, more awkward way to stringify
637	print $x; # perl does it for you, too, quite often	969	print $x; # perl does it for you, too, quite often
638		970
639	You can force the type to be a number by numifying it:	971	You can force the type to be a JSON number by numifying it:
640		972
641	my $x = "3"; # some variable containing a string	973	my $x = "3"; # some variable containing a string
642	$x += 0; # numify it, ensuring it will be dumped as a number	974	$x += 0; # numify it, ensuring it will be dumped as a number
643	$x *= 1; # same thing, the choise is yours.	975	$x *= 1; # same thing, the choice is yours.
644		976
645	You can not currently output JSON booleans or force the type in	977	You can not currently force the type in other, less obscure, ways.
646	other, less obscure, ways. Tell me if you need this capability.	978	Tell me if you need this capability (but don't forget to explain why
		979	it's needed :).
647		980
648	COMPARISON	981	ENCODING/CODESET FLAG NOTES
649	As already mentioned, this module was created because none of the	982	The interested reader might have seen a number of flags that signify
650	existing JSON modules could be made to work correctly. First I will	983	encodings or codesets - "utf8", "latin1" and "ascii". There seems to be
651	describe the problems (or pleasures) I encountered with various existing	984	some confusion on what these do, so here is a short comparison:
652	JSON modules, followed by some benchmark values. JSON::XS was designed
653	not to suffer from any of these problems or limitations.
654		985
655	JSON 1.07	986	"utf8" controls whether the JSON text created by "encode" (and expected
656	Slow (but very portable, as it is written in pure Perl).	987	by "decode") is UTF-8 encoded or not, while "latin1" and "ascii" only
		988	control whether "encode" escapes character values outside their
		989	respective codeset range. Neither of these flags conflict with each
		990	other, although some combinations make less sense than others.
657		991
658	Undocumented/buggy Unicode handling (how JSON handles unicode values	992	Care has been taken to make all flags symmetrical with respect to
659	is undocumented. One can get far by feeding it unicode strings and	993	"encode" and "decode", that is, texts encoded with any combination of
660	doing en-/decoding oneself, but unicode escapes are not working	994	these flag values will be correctly decoded when the same flags are used
		995	- in general, if you use different flag settings while encoding vs. when
		996	decoding you likely have a bug somewhere.
		997
		998	Below comes a verbose discussion of these flags. Note that a "codeset"
		999	is simply an abstract set of character-codepoint pairs, while an
		1000	encoding takes those codepoint numbers and encodes them, in our case
		1001	into octets. Unicode is (among other things) a codeset, UTF-8 is an
		1002	encoding, and ISO-8859-1 (= latin 1) and ASCII are both codesets and
		1003	encodings at the same time, which can be confusing.
		1004
		1005	"utf8" flag disabled
		1006	When "utf8" is disabled (the default), then "encode"/"decode"
		1007	generate and expect Unicode strings, that is, characters with high
		1008	ordinal Unicode values (> 255) will be encoded as such characters,
		1009	and likewise such characters are decoded as-is, no canges to them
		1010	will be done, except "(re-)interpreting" them as Unicode codepoints
		1011	or Unicode characters, respectively (to Perl, these are the same
		1012	thing in strings unless you do funny/weird/dumb stuff).
		1013
		1014	This is useful when you want to do the encoding yourself (e.g. when
		1015	you want to have UTF-16 encoded JSON texts) or when some other layer
		1016	does the encoding for you (for example, when printing to a terminal
		1017	using a filehandle that transparently encodes to UTF-8 you certainly
		1018	do NOT want to UTF-8 encode your data first and have Perl encode it
		1019	another time).
		1020
		1021	"utf8" flag enabled
		1022	If the "utf8"-flag is enabled, "encode"/"decode" will encode all
		1023	characters using the corresponding UTF-8 multi-byte sequence, and
		1024	will expect your input strings to be encoded as UTF-8, that is, no
		1025	"character" of the input string must have any value > 255, as UTF-8
		1026	does not allow that.
		1027
		1028	The "utf8" flag therefore switches between two modes: disabled means
		1029	you will get a Unicode string in Perl, enabled means you get an
		1030	UTF-8 encoded octet/binary string in Perl.
		1031
		1032	"latin1" or "ascii" flags enabled
		1033	With "latin1" (or "ascii") enabled, "encode" will escape characters
		1034	with ordinal values > 255 (> 127 with "ascii") and encode the
		1035	remaining characters as specified by the "utf8" flag.
		1036
		1037	If "utf8" is disabled, then the result is also correctly encoded in
		1038	those character sets (as both are proper subsets of Unicode, meaning
		1039	that a Unicode string with all character values < 256 is the same
		1040	thing as a ISO-8859-1 string, and a Unicode string with all
		1041	character values < 128 is the same thing as an ASCII string in
661	properly).	1042	Perl).
662		1043
663	No roundtripping (strings get clobbered if they look like numbers,	1044	If "utf8" is enabled, you still get a correct UTF-8-encoded string,
664	e.g. the string 2.0 will encode to 2.0 instead of "2.0", and that	1045	regardless of these flags, just some more characters will be escaped
665	will decode into the number 2.	1046	using "\uXXXX" then before.
666		1047
667	JSON::PC 0.01	1048	Note that ISO-8859-1-encoded strings are not compatible with UTF-8
668	Very fast.	1049	encoding, while ASCII-encoded strings are. That is because the
		1050	ISO-8859-1 encoding is NOT a subset of UTF-8 (despite the ISO-8859-1
		1051	codeset being a subset of Unicode), while ASCII is.
669		1052
670	Undocumented/buggy Unicode handling.	1053	Surprisingly, "decode" will ignore these flags and so treat all
		1054	input values as governed by the "utf8" flag. If it is disabled, this
		1055	allows you to decode ISO-8859-1- and ASCII-encoded strings, as both
		1056	strict subsets of Unicode. If it is enabled, you can correctly
		1057	decode UTF-8 encoded strings.
671		1058
672	No roundtripping.	1059	So neither "latin1" nor "ascii" are incompatible with the "utf8"
		1060	flag - they only govern when the JSON output engine escapes a
		1061	character or not.
673		1062
674	Has problems handling many Perl values (e.g. regex results and other	1063	The main use for "latin1" is to relatively efficiently store binary
675	magic values will make it croak).	1064	data as JSON, at the expense of breaking compatibility with most
		1065	JSON decoders.
676		1066
677	Does not even generate valid JSON ("{1,2}" gets converted to "{1:2}"	1067	The main use for "ascii" is to force the output to not contain
678	which is not a valid JSON text.	1068	characters with values > 127, which means you can interpret the
679		1069	resulting string as UTF-8, ISO-8859-1, ASCII, KOI8-R or most about
680	Unmaintained (maintainer unresponsive for many months, bugs are not	1070	any character set and 8-bit-encoding, and still get the same data
681	getting fixed).	1071	structure back. This is useful when your channel for JSON transfer
682		1072	is not 8-bit clean or the encoding might be mangled in between (e.g.
683	JSON::Syck 0.21	1073	in mail), and works because ASCII is a proper subset of most 8-bit
684	Very buggy (often crashes).	1074	and multibyte encodings in use in the world.
685
686	Very inflexible (no human-readable format supported, format pretty
687	much undocumented. I need at least a format for easy reading by
688	humans and a single-line compact format for use in a protocol, and
689	preferably a way to generate ASCII-only JSON texts).
690
691	Completely broken (and confusingly documented) Unicode handling
692	(unicode escapes are not working properly, you need to set
693	ImplicitUnicode to different values on en- and decoding to get
694	symmetric behaviour).
695
696	No roundtripping (simple cases work, but this depends on wether the
697	scalar value was used in a numeric context or not).
698
699	Dumping hashes may skip hash values depending on iterator state.
700
701	Unmaintained (maintainer unresponsive for many months, bugs are not
702	getting fixed).
703
704	Does not check input for validity (i.e. will accept non-JSON input
705	and return "something" instead of raising an exception. This is a
706	security issue: imagine two banks transfering money between each
707	other using JSON. One bank might parse a given non-JSON request and
708	deduct money, while the other might reject the transaction with a
709	syntax error. While a good protocol will at least recover, that is
710	extra unnecessary work and the transaction will still not succeed).
711
712	JSON::DWIW 0.04
713	Very fast. Very natural. Very nice.
714
715	Undocumented unicode handling (but the best of the pack. Unicode
716	escapes still don't get parsed properly).
717
718	Very inflexible.
719
720	No roundtripping.
721
722	Does not generate valid JSON texts (key strings are often unquoted,
723	empty keys result in nothing being output)
724
725	Does not check input for validity.
726		1075
727	JSON and YAML	1076	JSON and YAML
728	You often hear that JSON is a subset (or a close subset) of YAML. This	1077	You often hear that JSON is a subset of YAML. This is, however, a mass
729	is, however, a mass hysteria and very far from the truth. In general,	1078	hysteria(*) and very far from the truth (as of the time of this
730	there is no way to configure JSON::XS to output a data structure as	1079	writing), so let me state it clearly: *in general, there is no way to
731	valid YAML.	1080	configure JSON::XS to output a data structure as valid YAML* that works
		1081	in all cases.
732		1082
733	If you really must use JSON::XS to generate YAML, you should use this	1083	If you really must use JSON::XS to generate YAML, you should use this
734	algorithm (subject to change in future versions):	1084	algorithm (subject to change in future versions):
735		1085
736	my $to_yaml = JSON::XS->new->utf8->space_after (1);	1086	my $to_yaml = JSON::XS->new->utf8->space_after (1);
737	my $yaml = $to_yaml->encode ($ref) . "\n";	1087	my $yaml = $to_yaml->encode ($ref) . "\n";
738		1088
739	This will usually generate JSON texts that also parse as valid YAML.	1089	This will usually generate JSON texts that also parse as valid YAML.
740	Please note that YAML has hardcoded limits on (simple) object key	1090	Please note that YAML has hardcoded limits on (simple) object key
741	lengths that JSON doesn't have, so you should make sure that your hash	1091	lengths that JSON doesn't have and also has different and incompatible
		1092	unicode handling, so you should make sure that your hash keys are
742	keys are noticably shorter than the 1024 characters YAML allows.	1093	noticeably shorter than the 1024 "stream characters" YAML allows and
		1094	that you do not have characters with codepoint values outside the
		1095	Unicode BMP (basic multilingual page). YAML also does not allow "\/"
		1096	sequences in strings (which JSON::XS does not currently generate, but
		1097	other JSON generators might).
743		1098
744	There might be other incompatibilities that I am not aware of. In	1099	There might be other incompatibilities that I am not aware of (or the
		1100	YAML specification has been changed yet again - it does so quite often).
745	general you should not try to generate YAML with a JSON generator or	1101	In general you should not try to generate YAML with a JSON generator or
746	vice versa, or try to parse JSON with a YAML parser or vice versa:	1102	vice versa, or try to parse JSON with a YAML parser or vice versa:
747	chances are high that you will run into severe interoperability	1103	chances are high that you will run into severe interoperability problems
748	problems.	1104	when you least expect it.
		1105
		1106	(*) I have been pressured multiple times by Brian Ingerson (one of the
		1107	authors of the YAML specification) to remove this paragraph, despite
		1108	him acknowledging that the actual incompatibilities exist. As I was
		1109	personally bitten by this "JSON is YAML" lie, I refused and said I
		1110	will continue to educate people about these issues, so others do not
		1111	run into the same problem again and again. After this, Brian called
		1112	me a (quote)complete and worthless idiot(unquote).
		1113
		1114	In my opinion, instead of pressuring and insulting people who
		1115	actually clarify issues with YAML and the wrong statements of some
		1116	of its proponents, I would kindly suggest reading the JSON spec
		1117	(which is not that difficult or long) and finally make YAML
		1118	compatible to it, and educating users about the changes, instead of
		1119	spreading lies about the real compatibility for many years and
		1120	trying to silence people who point out that it isn't true.
749		1121
750	SPEED	1122	SPEED
751	It seems that JSON::XS is surprisingly fast, as shown in the following	1123	It seems that JSON::XS is surprisingly fast, as shown in the following
752	tables. They have been generated with the help of the "eg/bench" program	1124	tables. They have been generated with the help of the "eg/bench" program
753	in the JSON::XS distribution, to make it easy to compare on your own	1125	in the JSON::XS distribution, to make it easy to compare on your own
754	system.	1126	system.
755		1127
756	First comes a comparison between various modules using a very short	1128	First comes a comparison between various modules using a very short
757	single-line JSON string:	1129	single-line JSON string (also available at
		1130	<http://dist.schmorp.de/misc/json/short.json>).
758		1131
759	{"method": "handleMessage", "params": ["user1", "we were just talking"], \	1132	{"method": "handleMessage", "params": ["user1",
760	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}	1133	"we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
		1134	true, false]}
761		1135
762	It shows the number of encodes/decodes per second (JSON::XS uses the	1136	It shows the number of encodes/decodes per second (JSON::XS uses the
763	functional interface, while JSON::XS/2 uses the OO interface with	1137	functional interface, while JSON::XS/2 uses the OO interface with
764	pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink).	1138	pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink).
765	Higher is better:	1139	Higher is better:
766		1140
767	Storable \| 15779.925 \| 14169.946 \|
768	-----------+------------+------------+
769	module \| encode \| decode \|	1141	module \| encode \| decode \|
770	-----------\|------------\|------------\|	1142	-----------\|------------\|------------\|
771	JSON \| 4990.842 \| 4088.813 \|	1143	JSON 1.x \| 4990.842 \| 4088.813 \|
772	JSON::DWIW \| 51653.990 \| 71575.154 \|	1144	JSON::DWIW \| 51653.990 \| 71575.154 \|
773	JSON::PC \| 65948.176 \| 74631.744 \|	1145	JSON::PC \| 65948.176 \| 74631.744 \|
774	JSON::PP \| 8931.652 \| 3817.168 \|	1146	JSON::PP \| 8931.652 \| 3817.168 \|
775	JSON::Syck \| 24877.248 \| 27776.848 \|	1147	JSON::Syck \| 24877.248 \| 27776.848 \|
776	JSON::XS \| 388361.481 \| 227951.304 \|	1148	JSON::XS \| 388361.481 \| 227951.304 \|
…		…
778	JSON::XS/3 \| 338250.323 \| 218453.333 \|	1150	JSON::XS/3 \| 338250.323 \| 218453.333 \|
779	Storable \| 16500.016 \| 135300.129 \|	1151	Storable \| 16500.016 \| 135300.129 \|
780	-----------+------------+------------+	1152	-----------+------------+------------+
781		1153
782	That is, JSON::XS is about five times faster than JSON::DWIW on	1154	That is, JSON::XS is about five times faster than JSON::DWIW on
783	encoding, about three times faster on decoding, and over fourty times	1155	encoding, about three times faster on decoding, and over forty times
784	faster than JSON, even with pretty-printing and key sorting. It also	1156	faster than JSON, even with pretty-printing and key sorting. It also
785	compares favourably to Storable for small amounts of data.	1157	compares favourably to Storable for small amounts of data.
786		1158
787	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	1159	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
788	search API (http://nanoref.com/yahooapis/mgPdGg):	1160	search API (<http://dist.schmorp.de/misc/json/long.json>).
789		1161
790	module \| encode \| decode \|	1162	module \| encode \| decode \|
791	-----------\|------------\|------------\|	1163	-----------\|------------\|------------\|
792	JSON \| 55.260 \| 34.971 \|	1164	JSON 1.x \| 55.260 \| 34.971 \|
793	JSON::DWIW \| 825.228 \| 1082.513 \|	1165	JSON::DWIW \| 825.228 \| 1082.513 \|
794	JSON::PC \| 3571.444 \| 2394.829 \|	1166	JSON::PC \| 3571.444 \| 2394.829 \|
795	JSON::PP \| 210.987 \| 32.574 \|	1167	JSON::PP \| 210.987 \| 32.574 \|
796	JSON::Syck \| 552.551 \| 787.544 \|	1168	JSON::Syck \| 552.551 \| 787.544 \|
797	JSON::XS \| 5780.463 \| 4854.519 \|	1169	JSON::XS \| 5780.463 \| 4854.519 \|
…		…
801	-----------+------------+------------+	1173	-----------+------------+------------+
802		1174
803	Again, JSON::XS leads by far (except for Storable which non-surprisingly	1175	Again, JSON::XS leads by far (except for Storable which non-surprisingly
804	decodes faster).	1176	decodes faster).
805		1177
806	On large strings containing lots of high unicode characters, some	1178	On large strings containing lots of high Unicode characters, some
807	modules (such as JSON::PC) seem to decode faster than JSON::XS, but the	1179	modules (such as JSON::PC) seem to decode faster than JSON::XS, but the
808	result will be broken due to missing (or wrong) unicode handling. Others	1180	result will be broken due to missing (or wrong) Unicode handling. Others
809	refuse to decode or encode properly, so it was impossible to prepare a	1181	refuse to decode or encode properly, so it was impossible to prepare a
810	fair comparison table for that case.	1182	fair comparison table for that case.
811		1183
812	SECURITY CONSIDERATIONS	1184	SECURITY CONSIDERATIONS
813	When you are using JSON in a protocol, talking to untrusted potentially	1185	When you are using JSON in a protocol, talking to untrusted potentially
…		…
817	have any buffer overflows. Obviously, this module should ensure that and	1189	have any buffer overflows. Obviously, this module should ensure that and
818	I am trying hard on making that true, but you never know.	1190	I am trying hard on making that true, but you never know.
819		1191
820	Second, you need to avoid resource-starving attacks. That means you	1192	Second, you need to avoid resource-starving attacks. That means you
821	should limit the size of JSON texts you accept, or make sure then when	1193	should limit the size of JSON texts you accept, or make sure then when
822	your resources run out, thats just fine (e.g. by using a separate	1194	your resources run out, that's just fine (e.g. by using a separate
823	process that can crash safely). The size of a JSON text in octets or	1195	process that can crash safely). The size of a JSON text in octets or
824	characters is usually a good indication of the size of the resources	1196	characters is usually a good indication of the size of the resources
825	required to decode it into a Perl structure. While JSON::XS can check	1197	required to decode it into a Perl structure. While JSON::XS can check
826	the size of the JSON text, it might be too late when you already have it	1198	the size of the JSON text, it might be too late when you already have it
827	in memory, so you might want to check the size before you accept the	1199	in memory, so you might want to check the size before you accept the
…		…
830	Third, JSON::XS recurses using the C stack when decoding objects and	1202	Third, JSON::XS recurses using the C stack when decoding objects and
831	arrays. The C stack is a limited resource: for instance, on my amd64	1203	arrays. The C stack is a limited resource: for instance, on my amd64
832	machine with 8MB of stack size I can decode around 180k nested arrays	1204	machine with 8MB of stack size I can decode around 180k nested arrays
833	but only 14k nested JSON objects (due to perl itself recursing deeply on	1205	but only 14k nested JSON objects (due to perl itself recursing deeply on
834	croak to free the temporary). If that is exceeded, the program crashes.	1206	croak to free the temporary). If that is exceeded, the program crashes.
835	to be conservative, the default nesting limit is set to 512. If your	1207	To be conservative, the default nesting limit is set to 512. If your
836	process has a smaller stack, you should adjust this setting accordingly	1208	process has a smaller stack, you should adjust this setting accordingly
837	with the "max_depth" method.	1209	with the "max_depth" method.
838		1210
839	And last but least, something else could bomb you that I forgot to think	1211	Something else could bomb you, too, that I forgot to think of. In that
840	of. In that case, you get to keep the pieces. I am always open for	1212	case, you get to keep the pieces. I am always open for hints, though...
841	hints, though...
842		1213
		1214	Also keep in mind that JSON::XS might leak contents of your Perl data
		1215	structures in its error messages, so when you serialise sensitive
		1216	information you might want to make sure that exceptions thrown by
		1217	JSON::XS will not end up in front of untrusted eyes.
		1218
843	If you are using JSON::XS to return packets to consumption by javascript	1219	If you are using JSON::XS to return packets to consumption by JavaScript
844	scripts in a browser you should have a look at	1220	scripts in a browser you should have a look at
845	<http://jpsykes.com/47/practical-csrf-and-json-security> to see wether	1221	<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether
846	you are vulnerable to some common attack vectors (which really are	1222	you are vulnerable to some common attack vectors (which really are
847	browser design bugs, but it is still you who will have to deal with it,	1223	browser design bugs, but it is still you who will have to deal with it,
848	as major browser developers care only for features, not about doing	1224	as major browser developers care only for features, not about getting
849	security right).	1225	security right).
		1226
		1227	THREADS
		1228	This module is not guaranteed to be thread safe and there are no plans
		1229	to change this until Perl gets thread support (as opposed to the
		1230	horribly slow so-called "threads" which are simply slow and bloated
		1231	process simulations - use fork, it's much faster, cheaper, better).
		1232
		1233	(It might actually work, but you have been warned).
850		1234
851	BUGS	1235	BUGS
852	While the goal of this module is to be correct, that unfortunately does	1236	While the goal of this module is to be correct, that unfortunately does
853	not mean its bug-free, only that I think its design is bug-free. It is	1237	not mean it's bug-free, only that I think its design is bug-free. If you
854	still relatively early in its development. If you keep reporting bugs
855	they will be fixed swiftly, though.	1238	keep reporting bugs they will be fixed swiftly, though.
		1239
		1240	Please refrain from using rt.cpan.org or any other bug reporting
		1241	service. I put the contact address into my modules for a reason.
		1242
		1243	SEE ALSO
		1244	The json_xs command line utility for quick experiments.
856		1245
857	AUTHOR	1246	AUTHOR
858	Marc Lehmann <schmorp@schmorp.de>	1247	Marc Lehmann <schmorp@schmorp.de>
859	http://home.schmorp.de/	1248	http://home.schmorp.de/
860		1249

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing JSON-XS/README (file contents): Revision 1.18 by root, Tue Aug 28 02:06:06 2007 UTC vs. Revision 1.27 by root, Tue Jul 15 11:29:29 2008 UTC

Diff Legend

Comparing JSON-XS/README (file contents):
Revision 1.18 by root, Tue Aug 28 02:06:06 2007 UTC vs.
Revision 1.27 by root, Tue Jul 15 11:29:29 2008 UTC