[ViewVC] Diff of: cvs/JSON-XS/XS.pm

Comparing JSON-XS/XS.pm (file contents):
Revision 1.62 by root, Thu Oct 11 22:52:52 2007 UTC vs.
Revision 1.143 by root, Fri Oct 25 20:02:54 2013 UTC

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

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.62 by root, Thu Oct 11 22:52:52 2007 UTC vs. Revision 1.143 by root, Fri Oct 25 20:02:54 2013 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.62 by root, Thu Oct 11 22:52:52 2007 UTC vs.
Revision 1.143 by root, Fri Oct 25 20:02:54 2013 UTC