[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.110 by root, Sun Jul 20 17:55:19 2008 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
…		…
42		58
43	=head2 FEATURES	59	=head2 FEATURES
44		60
45	=over 4	61	=over 4
46		62
47	=item * correct unicode handling	63	=item * correct Unicode handling
48		64
49	This module knows how to handle Unicode, and even documents how and when	65	This module knows how to handle Unicode, documents how and when it does
50	it does so.	66	so, and even documents what "correct" means.
51		67
52	=item * round-trip integrity	68	=item * round-trip integrity
53		69
54	When you serialise a perl data structure using only datatypes supported	70	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.	71	by JSON, the deserialised data structure is identical on the Perl level.
56	(e.g. the string "2.0" doesn't suddenly become "2" just because it looks	72	(e.g. the string "2.0" doesn't suddenly become "2" just because it looks
57	like a number).	73	like a number). There minor I<are> exceptions to this, read the MAPPING
		74	section below to learn about those.
58		75
59	=item * strict checking of JSON correctness	76	=item * strict checking of JSON correctness
60		77
61	There is no guessing, no generating of illegal JSON texts by default,	78	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	79	and only JSON is accepted as input by default (the latter is a security
63	feature).	80	feature).
64		81
65	=item * fast	82	=item * fast
66		83
67	Compared to other JSON modules, this module compares favourably in terms	84	Compared to other JSON modules and other serialisers such as Storable,
68	of speed, too.	85	this module usually compares favourably in terms of speed, too.
69		86
70	=item * simple to use	87	=item * simple to use
71		88
72	This module has both a simple functional interface as well as an OO	89	This module has both a simple functional interface as well as an object
73	interface.	90	oriented interface interface.
74		91
75	=item * reasonably versatile output formats	92	=item * reasonably versatile output formats
76		93
77	You can choose between the most compact guarenteed single-line format	94	You can choose between the most compact guaranteed-single-line format
78	possible (nice for simple line-based protocols), a pure-ascii format	95	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	96	(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	97	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.	98	stuff). Or you can combine those features in whatever way you like.
82		99
83	=back	100	=back
84		101
85	=cut	102	=cut
86		103
87	package JSON::XS;	104	package JSON::XS;
88		105
		106	no warnings;
89	use strict;	107	use strict;
90		108
91	our $VERSION = '1.5';	109	our $VERSION = '2.2222';
92	our @ISA = qw(Exporter);	110	our @ISA = qw(Exporter);
93		111
94	our @EXPORT = qw(to_json from_json);	112	our @EXPORT = qw(encode_json decode_json to_json from_json);
		113
		114	sub to_json($) {
		115	require Carp;
		116	Carp::croak ("JSON::XS::to_json has been renamed to encode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call");
		117	}
		118
		119	sub from_json($) {
		120	require Carp;
		121	Carp::croak ("JSON::XS::from_json has been renamed to decode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call");
		122	}
95		123
96	use Exporter;	124	use Exporter;
97	use XSLoader;	125	use XSLoader;
98		126
99	=head1 FUNCTIONAL INTERFACE	127	=head1 FUNCTIONAL INTERFACE
100		128
101	The following convinience methods are provided by this module. They are	129	The following convenience methods are provided by this module. They are
102	exported by default:	130	exported by default:
103		131
104	=over 4	132	=over 4
105		133
106	=item $json_text = to_json $perl_scalar	134	=item $json_text = encode_json $perl_scalar
107		135
108	Converts the given Perl data structure (a simple scalar or a reference to	136	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	137	(that is, the string contains octets only). Croaks on error.
110	octets only). Croaks on error.
111		138
112	This function call is functionally identical to:	139	This function call is functionally identical to:
113		140
114	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)	141	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)
115		142
116	except being faster.	143	Except being faster.
117		144
118	=item $perl_scalar = from_json $json_text	145	=item $perl_scalar = decode_json $json_text
119		146
120	The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to	147	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	148	to parse that as an UTF-8 encoded JSON text, returning the resulting
122	scalar or reference. Croaks on error.	149	reference. Croaks on error.
123		150
124	This function call is functionally identical to:	151	This function call is functionally identical to:
125		152
126	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	153	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
127		154
128	except being faster.	155	Except being faster.
129		156
130	=item $is_boolean = JSON::XS::is_bool $scalar	157	=item $is_boolean = JSON::XS::is_bool $scalar
131		158
132	Returns true if the passed scalar represents either JSON::XS::true or	159	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	160	JSON::XS::false, two constants that act like C<1> and C<0>, respectively
…		…
137	Perl.	164	Perl.
138		165
139	=back	166	=back
140		167
141		168
		169	=head1 A FEW NOTES ON UNICODE AND PERL
		170
		171	Since this often leads to confusion, here are a few very clear words on
		172	how Unicode works in Perl, modulo bugs.
		173
		174	=over 4
		175
		176	=item 1. Perl strings can store characters with ordinal values > 255.
		177
		178	This enables you to store Unicode characters as single characters in a
		179	Perl string - very natural.
		180
		181	=item 2. Perl does I<not> associate an encoding with your strings.
		182
		183	... until you force it to, e.g. when matching it against a regex, or
		184	printing the scalar to a file, in which case Perl either interprets your
		185	string as locale-encoded text, octets/binary, or as Unicode, depending
		186	on various settings. In no case is an encoding stored together with your
		187	data, it is I<use> that decides encoding, not any magical meta data.
		188
		189	=item 3. The internal utf-8 flag has no meaning with regards to the
		190	encoding of your string.
		191
		192	Just ignore that flag unless you debug a Perl bug, a module written in
		193	XS or want to dive into the internals of perl. Otherwise it will only
		194	confuse you, as, despite the name, it says nothing about how your string
		195	is encoded. You can have Unicode strings with that flag set, with that
		196	flag clear, and you can have binary data with that flag set and that flag
		197	clear. Other possibilities exist, too.
		198
		199	If you didn't know about that flag, just the better, pretend it doesn't
		200	exist.
		201
		202	=item 4. A "Unicode String" is simply a string where each character can be
		203	validly interpreted as a Unicode code point.
		204
		205	If you have UTF-8 encoded data, it is no longer a Unicode string, but a
		206	Unicode string encoded in UTF-8, giving you a binary string.
		207
		208	=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string.
		209
		210	It's a fact. Learn to live with it.
		211
		212	=back
		213
		214	I hope this helps :)
		215
		216
142	=head1 OBJECT-ORIENTED INTERFACE	217	=head1 OBJECT-ORIENTED INTERFACE
143		218
144	The object oriented interface lets you configure your own encoding or	219	The object oriented interface lets you configure your own encoding or
145	decoding style, within the limits of supported formats.	220	decoding style, within the limits of supported formats.
146		221
…		…
157	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})	232	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
158	=> {"a": [1, 2]}	233	=> {"a": [1, 2]}
159		234
160	=item $json = $json->ascii ([$enable])	235	=item $json = $json->ascii ([$enable])
161		236
		237	=item $enabled = $json->get_ascii
		238
162	If C<$enable> is true (or missing), then the C<encode> method will not	239	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	240	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	241	Unicode characters outside that range will be escaped using either a
165	single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence,	242	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	243	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,	244	Unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string,
168	or any other superset of ASCII.	245	or any other superset of ASCII.
169		246
170	If C<$enable> is false, then the C<encode> method will not escape Unicode	247	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	248	characters unless required by the JSON syntax or other flags. This results
172	in a faster and more compact format.	249	in a faster and more compact format.
173		250
		251	See also the section I<ENCODING/CODESET FLAG NOTES> later in this
		252	document.
		253
174	The main use for this flag is to produce JSON texts that can be	254	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	255	transmitted over a 7-bit channel, as the encoded JSON texts will not
176	contain any 8 bit characters.	256	contain any 8 bit characters.
177		257
178	JSON::XS->new->ascii (1)->encode ([chr 0x10401])	258	JSON::XS->new->ascii (1)->encode ([chr 0x10401])
179	=> ["\ud801\udc01"]	259	=> ["\ud801\udc01"]
180		260
181	=item $json = $json->latin1 ([$enable])	261	=item $json = $json->latin1 ([$enable])
182		262
		263	=item $enabled = $json->get_latin1
		264
183	If C<$enable> is true (or missing), then the C<encode> method will encode	265	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	266	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	267	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	268	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	269	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.	270	expects Unicode, which is a strict superset of latin1.
189		271
190	If C<$enable> is false, then the C<encode> method will not escape Unicode	272	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.	273	characters unless required by the JSON syntax or other flags.
		274
		275	See also the section I<ENCODING/CODESET FLAG NOTES> later in this
		276	document.
192		277
193	The main use for this flag is efficiently encoding binary data as JSON	278	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	279	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	280	size. The disadvantage is that the resulting JSON text is encoded
196	in latin1 (and must correctly be treated as such when storing and	281	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	282	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	283	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.	284	in files or databases, not when talking to other JSON encoders/decoders.
200		285
201	JSON::XS->new->latin1->encode (["\x{89}\x{abc}"]	286	JSON::XS->new->latin1->encode (["\x{89}\x{abc}"]
202	=> ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not)	287	=> ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not)
203		288
204	=item $json = $json->utf8 ([$enable])	289	=item $json = $json->utf8 ([$enable])
		290
		291	=item $enabled = $json->get_utf8
205		292
206	If C<$enable> is true (or missing), then the C<encode> method will encode	293	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	294	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	295	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	296	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	297	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	298	versions, enabling this option might enable autodetection of the UTF-16
212	and UTF-32 encoding families, as described in RFC4627.	299	and UTF-32 encoding families, as described in RFC4627.
213		300
214	If C<$enable> is false, then the C<encode> method will return the JSON	301	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	302	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	303	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.	304	to be done yourself, e.g. using the Encode module.
		305
		306	See also the section I<ENCODING/CODESET FLAG NOTES> later in this
		307	document.
218		308
219	Example, output UTF-16BE-encoded JSON:	309	Example, output UTF-16BE-encoded JSON:
220		310
221	use Encode;	311	use Encode;
222	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);	312	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);
…		…
243	]	333	]
244	}	334	}
245		335
246	=item $json = $json->indent ([$enable])	336	=item $json = $json->indent ([$enable])
247		337
		338	=item $enabled = $json->get_indent
		339
248	If C<$enable> is true (or missing), then the C<encode> method will use a multiline	340	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	341	format as output, putting every array member or object/hash key-value pair
250	into its own line, identing them properly.	342	into its own line, indenting them properly.
251		343
252	If C<$enable> is false, no newlines or indenting will be produced, and the	344	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>.	345	resulting JSON text is guaranteed not to contain any C<newlines>.
254		346
255	This setting has no effect when decoding JSON texts.	347	This setting has no effect when decoding JSON texts.
256		348
257	=item $json = $json->space_before ([$enable])	349	=item $json = $json->space_before ([$enable])
		350
		351	=item $enabled = $json->get_space_before
258		352
259	If C<$enable> is true (or missing), then the C<encode> method will add an extra	353	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.	354	optional space before the C<:> separating keys from values in JSON objects.
261		355
262	If C<$enable> is false, then the C<encode> method will not add any extra	356	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:	362	Example, space_before enabled, space_after and indent disabled:
269		363
270	{"key" :"value"}	364	{"key" :"value"}
271		365
272	=item $json = $json->space_after ([$enable])	366	=item $json = $json->space_after ([$enable])
		367
		368	=item $enabled = $json->get_space_after
273		369
274	If C<$enable> is true (or missing), then the C<encode> method will add an extra	370	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	371	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	372	and extra whitespace after the C<,> separating key-value pairs and array
277	members.	373	members.
…		…
284	Example, space_before and indent disabled, space_after enabled:	380	Example, space_before and indent disabled, space_after enabled:
285		381
286	{"key": "value"}	382	{"key": "value"}
287		383
288	=item $json = $json->relaxed ([$enable])	384	=item $json = $json->relaxed ([$enable])
		385
		386	=item $enabled = $json->get_relaxed
289		387
290	If C<$enable> is true (or missing), then C<decode> will accept some	388	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	389	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	390	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	391	JSON texts as if they were valid!>. I suggest only to use this option to
…		…
330		428
331	=back	429	=back
332		430
333	=item $json = $json->canonical ([$enable])	431	=item $json = $json->canonical ([$enable])
334		432
		433	=item $enabled = $json->get_canonical
		434
335	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects	435	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.	436	by sorting their keys. This is adding a comparatively high overhead.
337		437
338	If C<$enable> is false, then the C<encode> method will output key-value	438	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	439	pairs in the order Perl stores them (which will likely change between runs
340	of the same script).	440	of the same script).
341		441
342	This option is useful if you want the same data structure to be encoded as	442	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,	443	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,	444	the same hash might be encoded differently even if contains the same data,
345	as key-value pairs have no inherent ordering in Perl.	445	as key-value pairs have no inherent ordering in Perl.
346		446
347	This setting has no effect when decoding JSON texts.	447	This setting has no effect when decoding JSON texts.
348		448
349	=item $json = $json->allow_nonref ([$enable])	449	=item $json = $json->allow_nonref ([$enable])
		450
		451	=item $enabled = $json->get_allow_nonref
350		452
351	If C<$enable> is true (or missing), then the C<encode> method can convert a	453	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,	454	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	455	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON
354	values instead of croaking.	456	values instead of croaking.
…		…
362	resulting in an invalid JSON text:	464	resulting in an invalid JSON text:
363		465
364	JSON::XS->new->allow_nonref->encode ("Hello, World!")	466	JSON::XS->new->allow_nonref->encode ("Hello, World!")
365	=> "Hello, World!"	467	=> "Hello, World!"
366		468
		469	=item $json = $json->allow_unknown ([$enable])
		470
		471	=item $enabled = $json->get_allow_unknown
		472
		473	If C<$enable> is true (or missing), then C<encode> will I<not> throw an
		474	exception when it encounters values it cannot represent in JSON (for
		475	example, filehandles) but instead will encode a JSON C<null> value. Note
		476	that blessed objects are not included here and are handled separately by
		477	c<allow_nonref>.
		478
		479	If C<$enable> is false (the default), then C<encode> will throw an
		480	exception when it encounters anything it cannot encode as JSON.
		481
		482	This option does not affect C<decode> in any way, and it is recommended to
		483	leave it off unless you know your communications partner.
		484
367	=item $json = $json->allow_blessed ([$enable])	485	=item $json = $json->allow_blessed ([$enable])
		486
		487	=item $enabled = $json->get_allow_blessed
368		488
369	If C<$enable> is true (or missing), then the C<encode> method will not	489	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	490	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>	491	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	492	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	493	object (C<convert_blessed> enabled and C<TO_JSON> method found) is being
374	encoded. Has no effect on C<decode>.	494	encoded. Has no effect on C<decode>.
375		495
376	If C<$enable> is false (the default), then C<encode> will throw an	496	If C<$enable> is false (the default), then C<encode> will throw an
377	exception when it encounters a blessed object.	497	exception when it encounters a blessed object.
378		498
379	=item $json = $json->convert_blessed ([$enable])	499	=item $json = $json->convert_blessed ([$enable])
		500
		501	=item $enabled = $json->get_convert_blessed
380		502
381	If C<$enable> is true (or missing), then C<encode>, upon encountering a	503	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	504	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	505	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	506	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>	510	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	511	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	512	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	513	(== 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	514	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>	515	usually in upper case letters and to avoid collisions with any C<to_json>
394	function.	516	function or method.
395		517
396	This setting does not yet influence C<decode> in any way, but in the	518	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	519	future, global hooks might get installed that influence C<decode> and are
398	enabled by this setting.	520	enabled by this setting.
399		521
…		…
441		563
442	As this callback gets called less often then the C<filter_json_object>	564	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	565	one, decoding speed will not usually suffer as much. Therefore, single-key
444	objects make excellent targets to serialise Perl objects into, especially	566	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	567	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	568	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	569	support this in any way, so you need to make sure your data never looks
448	like a serialised Perl hash.	570	like a serialised Perl hash.
449		571
450	Typical names for the single object key are C<__class_whatever__>, or	572	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	573	C<$__dollars_are_rarely_used__$> or C<}ugly_brace_placement>, or even
…		…
475		597
476	{ __widget__ => $self->{id} }	598	{ __widget__ => $self->{id} }
477	}	599	}
478		600
479	=item $json = $json->shrink ([$enable])	601	=item $json = $json->shrink ([$enable])
		602
		603	=item $enabled = $json->get_shrink
480		604
481	Perl usually over-allocates memory a bit when allocating space for	605	Perl usually over-allocates memory a bit when allocating space for
482	strings. This flag optionally resizes strings generated by either	606	strings. This flag optionally resizes strings generated by either
483	C<encode> or C<decode> to their minimum size possible. This can save	607	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	608	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	626	strings that look like integers or floats into integers or floats
503	internally (there is no difference on the Perl level), saving space.	627	internally (there is no difference on the Perl level), saving space.
504		628
505	=item $json = $json->max_depth ([$maximum_nesting_depth])	629	=item $json = $json->max_depth ([$maximum_nesting_depth])
506		630
		631	=item $max_depth = $json->get_max_depth
		632
507	Sets the maximum nesting level (default C<512>) accepted while encoding	633	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	634	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	635	data structure, then the encoder and decoder will stop and croak at that
510	stop and croak at that point.	636	point.
511		637
512	Nesting level is defined by number of hash- or arrayrefs that the encoder	638	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<[>	639	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	640	characters without their matching closing parenthesis crossed to reach a
515	given character in a string.	641	given character in a string.
516		642
517	Setting the maximum depth to one disallows any nesting, so that ensures	643	Setting the maximum depth to one disallows any nesting, so that ensures
518	that the object is only a single hash/object or array.	644	that the object is only a single hash/object or array.
519		645
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	646	If no argument is given, the highest possible setting will be used, which
522	used, which is rarely useful.	647	is rarely useful.
		648
		649	Note that nesting is implemented by recursion in C. The default value has
		650	been chosen to be as large as typical operating systems allow without
		651	crashing.
523		652
524	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	653	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
525		654
526	=item $json = $json->max_size ([$maximum_string_size])	655	=item $json = $json->max_size ([$maximum_string_size])
		656
		657	=item $max_size = $json->get_max_size
527		658
528	Set the maximum length a JSON text may have (in bytes) where decoding is	659	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>	660	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	661	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	662	attempt to decode the string but throw an exception. This setting has no
532	effect on C<encode> (yet).	663	effect on C<encode> (yet).
533		664
534	The argument to C<max_size> will be rounded up to the next B<highest>	665	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	666	C<0> is specified).
536	limit check will be deactivated (same as when C<0> is specified).
537		667
538	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	668	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
539		669
540	=item $json_text = $json->encode ($perl_scalar)	670	=item $json_text = $json->encode ($perl_scalar)
541		671
…		…
570	=> ([], 3)	700	=> ([], 3)
571		701
572	=back	702	=back
573		703
574		704
		705	=head1 INCREMENTAL PARSING
		706
		707	In some cases, there is the need for incremental parsing of JSON
		708	texts. While this module always has to keep both JSON text and resulting
		709	Perl data structure in memory at one time, it does allow you to parse a
		710	JSON stream incrementally. It does so by accumulating text until it has
		711	a full JSON object, which it then can decode. This process is similar to
		712	using C<decode_prefix> to see if a full JSON object is available, but
		713	is much more efficient (and can be implemented with a minimum of method
		714	calls).
		715
		716	JSON::XS will only attempt to parse the JSON text once it is sure it
		717	has enough text to get a decisive result, using a very simple but
		718	truly incremental parser. This means that it sometimes won't stop as
		719	early as the full parser, for example, it doesn't detect parenthese
		720	mismatches. The only thing it guarantees is that it starts decoding as
		721	soon as a syntactically valid JSON text has been seen. This means you need
		722	to set resource limits (e.g. C<max_size>) to ensure the parser will stop
		723	parsing in the presence if syntax errors.
		724
		725	The following methods implement this incremental parser.
		726
		727	=over 4
		728
		729	=item [void, scalar or list context] = $json->incr_parse ([$string])
		730
		731	This is the central parsing function. It can both append new text and
		732	extract objects from the stream accumulated so far (both of these
		733	functions are optional).
		734
		735	If C<$string> is given, then this string is appended to the already
		736	existing JSON fragment stored in the C<$json> object.
		737
		738	After that, if the function is called in void context, it will simply
		739	return without doing anything further. This can be used to add more text
		740	in as many chunks as you want.
		741
		742	If the method is called in scalar context, then it will try to extract
		743	exactly I<one> JSON object. If that is successful, it will return this
		744	object, otherwise it will return C<undef>. If there is a parse error,
		745	this method will croak just as C<decode> would do (one can then use
		746	C<incr_skip> to skip the errornous part). This is the most common way of
		747	using the method.
		748
		749	And finally, in list context, it will try to extract as many objects
		750	from the stream as it can find and return them, or the empty list
		751	otherwise. For this to work, there must be no separators between the JSON
		752	objects or arrays, instead they must be concatenated back-to-back. If
		753	an error occurs, an exception will be raised as in the scalar context
		754	case. Note that in this case, any previously-parsed JSON texts will be
		755	lost.
		756
		757	=item $lvalue_string = $json->incr_text
		758
		759	This method returns the currently stored JSON fragment as an lvalue, that
		760	is, you can manipulate it. This I<only> works when a preceding call to
		761	C<incr_parse> in I<scalar context> successfully returned an object. Under
		762	all other circumstances you must not call this function (I mean it.
		763	although in simple tests it might actually work, it I<will> fail under
		764	real world conditions). As a special exception, you can also call this
		765	method before having parsed anything.
		766
		767	This function is useful in two cases: a) finding the trailing text after a
		768	JSON object or b) parsing multiple JSON objects separated by non-JSON text
		769	(such as commas).
		770
		771	=item $json->incr_skip
		772
		773	This will reset the state of the incremental parser and will remove the
		774	parsed text from the input buffer. This is useful after C<incr_parse>
		775	died, in which case the input buffer and incremental parser state is left
		776	unchanged, to skip the text parsed so far and to reset the parse state.
		777
		778	=item $json->incr_reset
		779
		780	This completely resets the incremental parser, that is, after this call,
		781	it will be as if the parser had never parsed anything.
		782
		783	This is useful if you want ot repeatedly parse JSON objects and want to
		784	ignore any trailing data, which means you have to reset the parser after
		785	each successful decode.
		786
		787	=back
		788
		789	=head2 LIMITATIONS
		790
		791	All options that affect decoding are supported, except
		792	C<allow_nonref>. The reason for this is that it cannot be made to
		793	work sensibly: JSON objects and arrays are self-delimited, i.e. you can concatenate
		794	them back to back and still decode them perfectly. This does not hold true
		795	for JSON numbers, however.
		796
		797	For example, is the string C<1> a single JSON number, or is it simply the
		798	start of C<12>? Or is C<12> a single JSON number, or the concatenation
		799	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS
		800	takes the conservative route and disallows this case.
		801
		802	=head2 EXAMPLES
		803
		804	Some examples will make all this clearer. First, a simple example that
		805	works similarly to C<decode_prefix>: We want to decode the JSON object at
		806	the start of a string and identify the portion after the JSON object:
		807
		808	my $text = "[1,2,3] hello";
		809
		810	my $json = new JSON::XS;
		811
		812	my $obj = $json->incr_parse ($text)
		813	or die "expected JSON object or array at beginning of string";
		814
		815	my $tail = $json->incr_text;
		816	# $tail now contains " hello"
		817
		818	Easy, isn't it?
		819
		820	Now for a more complicated example: Imagine a hypothetical protocol where
		821	you read some requests from a TCP stream, and each request is a JSON
		822	array, without any separation between them (in fact, it is often useful to
		823	use newlines as "separators", as these get interpreted as whitespace at
		824	the start of the JSON text, which makes it possible to test said protocol
		825	with C<telnet>...).
		826
		827	Here is how you'd do it (it is trivial to write this in an event-based
		828	manner):
		829
		830	my $json = new JSON::XS;
		831
		832	# read some data from the socket
		833	while (sysread $socket, my $buf, 4096) {
		834
		835	# split and decode as many requests as possible
		836	for my $request ($json->incr_parse ($buf)) {
		837	# act on the $request
		838	}
		839	}
		840
		841	Another complicated example: Assume you have a string with JSON objects
		842	or arrays, all separated by (optional) comma characters (e.g. C<[1],[2],
		843	[3]>). To parse them, we have to skip the commas between the JSON texts,
		844	and here is where the lvalue-ness of C<incr_text> comes in useful:
		845
		846	my $text = "[1],[2], [3]";
		847	my $json = new JSON::XS;
		848
		849	# void context, so no parsing done
		850	$json->incr_parse ($text);
		851
		852	# now extract as many objects as possible. note the
		853	# use of scalar context so incr_text can be called.
		854	while (my $obj = $json->incr_parse) {
		855	# do something with $obj
		856
		857	# now skip the optional comma
		858	$json->incr_text =~ s/^ \s* , //x;
		859	}
		860
		861	Now lets go for a very complex example: Assume that you have a gigantic
		862	JSON array-of-objects, many gigabytes in size, and you want to parse it,
		863	but you cannot load it into memory fully (this has actually happened in
		864	the real world :).
		865
		866	Well, you lost, you have to implement your own JSON parser. But JSON::XS
		867	can still help you: You implement a (very simple) array parser and let
		868	JSON decode the array elements, which are all full JSON objects on their
		869	own (this wouldn't work if the array elements could be JSON numbers, for
		870	example):
		871
		872	my $json = new JSON::XS;
		873
		874	# open the monster
		875	open my $fh, "<bigfile.json"
		876	or die "bigfile: $!";
		877
		878	# first parse the initial "["
		879	for (;;) {
		880	sysread $fh, my $buf, 65536
		881	or die "read error: $!";
		882	$json->incr_parse ($buf); # void context, so no parsing
		883
		884	# Exit the loop once we found and removed(!) the initial "[".
		885	# In essence, we are (ab-)using the $json object as a simple scalar
		886	# we append data to.
		887	last if $json->incr_text =~ s/^ \s* \[ //x;
		888	}
		889
		890	# now we have the skipped the initial "[", so continue
		891	# parsing all the elements.
		892	for (;;) {
		893	# in this loop we read data until we got a single JSON object
		894	for (;;) {
		895	if (my $obj = $json->incr_parse) {
		896	# do something with $obj
		897	last;
		898	}
		899
		900	# add more data
		901	sysread $fh, my $buf, 65536
		902	or die "read error: $!";
		903	$json->incr_parse ($buf); # void context, so no parsing
		904	}
		905
		906	# in this loop we read data until we either found and parsed the
		907	# separating "," between elements, or the final "]"
		908	for (;;) {
		909	# first skip whitespace
		910	$json->incr_text =~ s/^\s*//;
		911
		912	# if we find "]", we are done
		913	if ($json->incr_text =~ s/^\]//) {
		914	print "finished.\n";
		915	exit;
		916	}
		917
		918	# if we find ",", we can continue with the next element
		919	if ($json->incr_text =~ s/^,//) {
		920	last;
		921	}
		922
		923	# if we find anything else, we have a parse error!
		924	if (length $json->incr_text) {
		925	die "parse error near ", $json->incr_text;
		926	}
		927
		928	# else add more data
		929	sysread $fh, my $buf, 65536
		930	or die "read error: $!";
		931	$json->incr_parse ($buf); # void context, so no parsing
		932	}
		933
		934	This is a complex example, but most of the complexity comes from the fact
		935	that we are trying to be correct (bear with me if I am wrong, I never ran
		936	the above example :).
		937
		938
		939
575	=head1 MAPPING	940	=head1 MAPPING
576		941
577	This section describes how JSON::XS maps Perl values to JSON values and	942	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	943	vice versa. These mappings are designed to "do the right thing" in most
579	circumstances automatically, preserving round-tripping characteristics	944	circumstances automatically, preserving round-tripping characteristics
580	(what you put in comes out as something equivalent).	945	(what you put in comes out as something equivalent).
581		946
582	For the more enlightened: note that in the following descriptions,	947	For the more enlightened: note that in the following descriptions,
583	lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl>	948	lowercase I<perl> refers to the Perl interpreter, while uppercase I<Perl>
584	refers to the abstract Perl language itself.	949	refers to the abstract Perl language itself.
585		950
586		951
587	=head2 JSON -> PERL	952	=head2 JSON -> PERL
588		953
589	=over 4	954	=over 4
590		955
591	=item object	956	=item object
592		957
593	A JSON object becomes a reference to a hash in Perl. No ordering of object	958	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).	959	keys is preserved (JSON does not preserve object key ordering itself).
595		960
596	=item array	961	=item array
597		962
598	A JSON array becomes a reference to an array in Perl.	963	A JSON array becomes a reference to an array in Perl.
599		964
…		…
607		972
608	A JSON number becomes either an integer, numeric (floating point) or	973	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	974	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	975	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	976	the conversion details, but an integer may take slightly less memory and
612	might represent more values exactly than (floating point) numbers.	977	might represent more values exactly than floating point numbers.
613		978
614	If the number consists of digits only, JSON::XS will try to represent	979	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	980	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	981	a numeric (floating point) value if that is possible without loss of
617	precision. Otherwise it will preserve the number as a string value.	982	precision. Otherwise it will preserve the number as a string value (in
		983	which case you lose roundtripping ability, as the JSON number will be
		984	re-encoded toa JSON string).
618		985
619	Numbers containing a fractional or exponential part will always be	986	Numbers containing a fractional or exponential part will always be
620	represented as numeric (floating point) values, possibly at a loss of	987	represented as numeric (floating point) values, possibly at a loss of
621	precision.	988	precision (in which case you might lose perfect roundtripping ability, but
622		989	the JSON number will still be re-encoded as a JSON number).
623	This might create round-tripping problems as numbers might become strings,
624	but as Perl is typeless there is no other way to do it.
625		990
626	=item true, false	991	=item true, false
627		992
628	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,	993	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	994	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	995	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.	996	the C<JSON::XS::is_bool> function.
632		997
633	=item null	998	=item null
634		999
635	A JSON null atom becomes C<undef> in Perl.	1000	A JSON null atom becomes C<undef> in Perl.
…		…
666	Other unblessed references are generally not allowed and will cause an	1031	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	1032	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	1033	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.	1034	also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
670		1035
671	to_json [\0,JSON::XS::true] # yields [false,true]	1036	encode_json [\0, JSON::XS::true] # yields [false,true]
672		1037
673	=item JSON::XS::true, JSON::XS::false	1038	=item JSON::XS::true, JSON::XS::false
674		1039
675	These special values become JSON true and JSON false values,	1040	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.	1041	respectively. You can also use C<\1> and C<\0> directly if you want.
677		1042
678	=item blessed objects	1043	=item blessed objects
679		1044
680	Blessed objects are not allowed. JSON::XS currently tries to encode their	1045	Blessed objects are not directly representable in JSON. See the
681	underlying representation (hash- or arrayref), but this behaviour might	1046	C<allow_blessed> and C<convert_blessed> methods on various options on
682	change in future versions.	1047	how to deal with this: basically, you can choose between throwing an
		1048	exception, encoding the reference as if it weren't blessed, or provide
		1049	your own serialiser method.
683		1050
684	=item simple scalars	1051	=item simple scalars
685		1052
686	Simple Perl scalars (any scalar that is not a reference) are the most	1053	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	1054	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	1055	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:	1056	before encoding as JSON strings, and anything else as number value:
690		1057
691	# dump as number	1058	# dump as number
692	to_json [2] # yields [2]	1059	encode_json [2] # yields [2]
693	to_json [-3.0e17] # yields [-3e+17]	1060	encode_json [-3.0e17] # yields [-3e+17]
694	my $value = 5; to_json [$value] # yields [5]	1061	my $value = 5; encode_json [$value] # yields [5]
695		1062
696	# used as string, so dump as string	1063	# used as string, so dump as string
697	print $value;	1064	print $value;
698	to_json [$value] # yields ["5"]	1065	encode_json [$value] # yields ["5"]
699		1066
700	# undef becomes null	1067	# undef becomes null
701	to_json [undef] # yields [null]	1068	encode_json [undef] # yields [null]
702		1069
703	You can force the type to be a string by stringifying it:	1070	You can force the type to be a JSON string by stringifying it:
704		1071
705	my $x = 3.1; # some variable containing a number	1072	my $x = 3.1; # some variable containing a number
706	"$x"; # stringified	1073	"$x"; # stringified
707	$x .= ""; # another, more awkward way to stringify	1074	$x .= ""; # another, more awkward way to stringify
708	print $x; # perl does it for you, too, quite often	1075	print $x; # perl does it for you, too, quite often
709		1076
710	You can force the type to be a number by numifying it:	1077	You can force the type to be a JSON number by numifying it:
711		1078
712	my $x = "3"; # some variable containing a string	1079	my $x = "3"; # some variable containing a string
713	$x += 0; # numify it, ensuring it will be dumped as a number	1080	$x += 0; # numify it, ensuring it will be dumped as a number
714	$x *= 1; # same thing, the choise is yours.	1081	$x *= 1; # same thing, the choice is yours.
715		1082
716	You can not currently output JSON booleans or force the type in other,	1083	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.	1084	if you need this capability (but don't forget to explain why it's needed
		1085	:).
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 canges 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
809	=head2 JSON and YAML	1188	=head2 JSON and YAML
810		1189
811	You often hear that JSON is a subset (or a close subset) of YAML. This is,	1190	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	1191	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.	1192	so let me state it clearly: I<in general, there is no way to configure
		1193	JSON::XS to output a data structure as valid YAML> that works in all
		1194	cases.
814		1195
815	If you really must use JSON::XS to generate YAML, you should use this	1196	If you really must use JSON::XS to generate YAML, you should use this
816	algorithm (subject to change in future versions):	1197	algorithm (subject to change in future versions):
817		1198
818	my $to_yaml = JSON::XS->new->utf8->space_after (1);	1199	my $to_yaml = JSON::XS->new->utf8->space_after (1);
819	my $yaml = $to_yaml->encode ($ref) . "\n";	1200	my $yaml = $to_yaml->encode ($ref) . "\n";
820		1201
821	This will usually generate JSON texts that also parse as valid	1202	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	1203	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	1204	lengths that JSON doesn't have and also has different and incompatible
		1205	unicode handling, so you should make sure that your hash keys are
824	keys are noticably shorter than the 1024 characters YAML allows.	1206	noticeably shorter than the 1024 "stream characters" YAML allows and that
		1207	you do not have characters with codepoint values outside the Unicode BMP
		1208	(basic multilingual page). YAML also does not allow C<\/> sequences in
		1209	strings (which JSON::XS does not I<currently> generate, but other JSON
		1210	generators might).
825		1211
826	There might be other incompatibilities that I am not aware of. In general	1212	There might be other incompatibilities that I am not aware of (or the YAML
		1213	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,	1214	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	1215	versa, or try to parse JSON with a YAML parser or vice versa: chances are
829	that you will run into severe interoperability problems.	1216	high that you will run into severe interoperability problems when you
		1217	least expect it.
		1218
		1219	=over 4
		1220
		1221	=item (*)
		1222
		1223	I have been pressured multiple times by Brian Ingerson (one of the
		1224	authors of the YAML specification) to remove this paragraph, despite him
		1225	acknowledging that the actual incompatibilities exist. As I was personally
		1226	bitten by this "JSON is YAML" lie, I refused and said I will continue to
		1227	educate people about these issues, so others do not run into the same
		1228	problem again and again. After this, Brian called me a (quote)I<complete
		1229	and worthless idiot>(unquote).
		1230
		1231	In my opinion, instead of pressuring and insulting people who actually
		1232	clarify issues with YAML and the wrong statements of some of its
		1233	proponents, I would kindly suggest reading the JSON spec (which is not
		1234	that difficult or long) and finally make YAML compatible to it, and
		1235	educating users about the changes, instead of spreading lies about the
		1236	real compatibility for many I<years> and trying to silence people who
		1237	point out that it isn't true.
		1238
		1239	=back
830		1240
831		1241
832	=head2 SPEED	1242	=head2 SPEED
833		1243
834	It seems that JSON::XS is surprisingly fast, as shown in the following	1244	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	1245	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	1246	in the JSON::XS distribution, to make it easy to compare on your own
837	system.	1247	system.
838		1248
839	First comes a comparison between various modules using a very short	1249	First comes a comparison between various modules using
840	single-line JSON string:	1250	a very short single-line JSON string (also available at
		1251	L<http://dist.schmorp.de/misc/json/short.json>).
841		1252
842	{"method": "handleMessage", "params": ["user1", "we were just talking"], \	1253	{"method": "handleMessage", "params": ["user1",
843	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}	1254	"we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
		1255	true, false]}
844		1256
845	It shows the number of encodes/decodes per second (JSON::XS uses	1257	It shows the number of encodes/decodes per second (JSON::XS uses
846	the functional interface, while JSON::XS/2 uses the OO interface	1258	the functional interface, while JSON::XS/2 uses the OO interface
847	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables	1259	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
848	shrink). Higher is better:	1260	shrink). Higher is better:
849		1261
850	Storable \| 15779.925 \| 14169.946 \|
851	-----------+------------+------------+
852	module \| encode \| decode \|	1262	module \| encode \| decode \|
853	-----------\|------------\|------------\|	1263	-----------\|------------\|------------\|
854	JSON \| 4990.842 \| 4088.813 \|	1264	JSON 1.x \| 4990.842 \| 4088.813 \|
855	JSON::DWIW \| 51653.990 \| 71575.154 \|	1265	JSON::DWIW \| 51653.990 \| 71575.154 \|
856	JSON::PC \| 65948.176 \| 74631.744 \|	1266	JSON::PC \| 65948.176 \| 74631.744 \|
857	JSON::PP \| 8931.652 \| 3817.168 \|	1267	JSON::PP \| 8931.652 \| 3817.168 \|
858	JSON::Syck \| 24877.248 \| 27776.848 \|	1268	JSON::Syck \| 24877.248 \| 27776.848 \|
859	JSON::XS \| 388361.481 \| 227951.304 \|	1269	JSON::XS \| 388361.481 \| 227951.304 \|
…		…
861	JSON::XS/3 \| 338250.323 \| 218453.333 \|	1271	JSON::XS/3 \| 338250.323 \| 218453.333 \|
862	Storable \| 16500.016 \| 135300.129 \|	1272	Storable \| 16500.016 \| 135300.129 \|
863	-----------+------------+------------+	1273	-----------+------------+------------+
864		1274
865	That is, JSON::XS is about five times faster than JSON::DWIW on encoding,	1275	That is, JSON::XS is about five times faster than JSON::DWIW on encoding,
866	about three times faster on decoding, and over fourty times faster	1276	about three times faster on decoding, and over forty times faster
867	than JSON, even with pretty-printing and key sorting. It also compares	1277	than JSON, even with pretty-printing and key sorting. It also compares
868	favourably to Storable for small amounts of data.	1278	favourably to Storable for small amounts of data.
869		1279
870	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	1280	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
871	search API (http://nanoref.com/yahooapis/mgPdGg):	1281	search API (L<http://dist.schmorp.de/misc/json/long.json>).
872		1282
873	module \| encode \| decode \|	1283	module \| encode \| decode \|
874	-----------\|------------\|------------\|	1284	-----------\|------------\|------------\|
875	JSON \| 55.260 \| 34.971 \|	1285	JSON 1.x \| 55.260 \| 34.971 \|
876	JSON::DWIW \| 825.228 \| 1082.513 \|	1286	JSON::DWIW \| 825.228 \| 1082.513 \|
877	JSON::PC \| 3571.444 \| 2394.829 \|	1287	JSON::PC \| 3571.444 \| 2394.829 \|
878	JSON::PP \| 210.987 \| 32.574 \|	1288	JSON::PP \| 210.987 \| 32.574 \|
879	JSON::Syck \| 552.551 \| 787.544 \|	1289	JSON::Syck \| 552.551 \| 787.544 \|
880	JSON::XS \| 5780.463 \| 4854.519 \|	1290	JSON::XS \| 5780.463 \| 4854.519 \|
…		…
884	-----------+------------+------------+	1294	-----------+------------+------------+
885		1295
886	Again, JSON::XS leads by far (except for Storable which non-surprisingly	1296	Again, JSON::XS leads by far (except for Storable which non-surprisingly
887	decodes faster).	1297	decodes faster).
888		1298
889	On large strings containing lots of high unicode characters, some modules	1299	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	1300	(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	1301	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	1302	to decode or encode properly, so it was impossible to prepare a fair
893	comparison table for that case.	1303	comparison table for that case.
894		1304
895		1305
896	=head1 SECURITY CONSIDERATIONS	1306	=head1 SECURITY CONSIDERATIONS
…		…
902	any buffer overflows. Obviously, this module should ensure that and I am	1312	any buffer overflows. Obviously, this module should ensure that and I am
903	trying hard on making that true, but you never know.	1313	trying hard on making that true, but you never know.
904		1314
905	Second, you need to avoid resource-starving attacks. That means you should	1315	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	1316	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	1317	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	1318	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	1319	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	1320	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	1321	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.	1322	might want to check the size before you accept the string.
913		1323
914	Third, JSON::XS recurses using the C stack when decoding objects and	1324	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	1325	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	1326	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	1327	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	1328	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	1329	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	1330	has a smaller stack, you should adjust this setting accordingly with the
921	C<max_depth> method.	1331	C<max_depth> method.
922		1332
923	And last but least, something else could bomb you that I forgot to think	1333	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,	1334	case, you get to keep the pieces. I am always open for hints, though...
925	though...	1335
		1336	Also keep in mind that JSON::XS might leak contents of your Perl data
		1337	structures in its error messages, so when you serialise sensitive
		1338	information you might want to make sure that exceptions thrown by JSON::XS
		1339	will not end up in front of untrusted eyes.
926		1340
927	If you are using JSON::XS to return packets to consumption	1341	If you are using JSON::XS to return packets to consumption
928	by javascript scripts in a browser you should have a look at	1342	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	1343	L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether
930	you are vulnerable to some common attack vectors (which really are browser	1344	you are vulnerable to some common attack vectors (which really are browser
931	design bugs, but it is still you who will have to deal with it, as major	1345	design bugs, but it is still you who will have to deal with it, as major
932	browser developers care only for features, not about doing security	1346	browser developers care only for features, not about getting security
933	right).	1347	right).
934		1348
935		1349
		1350	=head1 THREADS
		1351
		1352	This module is I<not> guaranteed to be thread safe and there are no
		1353	plans to change this until Perl gets thread support (as opposed to the
		1354	horribly slow so-called "threads" which are simply slow and bloated
		1355	process simulations - use fork, it's I<much> faster, cheaper, better).
		1356
		1357	(It might actually work, but you have been warned).
		1358
		1359
936	=head1 BUGS	1360	=head1 BUGS
937		1361
938	While the goal of this module is to be correct, that unfortunately does	1362	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	1363	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	1364	keep reporting bugs they will be fixed swiftly, though.
941	will be fixed swiftly, though.	1365
		1366	Please refrain from using rt.cpan.org or any other bug reporting
		1367	service. I put the contact address into my modules for a reason.
942		1368
943	=cut	1369	=cut
944		1370
945	our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };	1371	our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };
946	our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };	1372	our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };
…		…
963	"--" => sub { $_[0] = ${$_[0]} - 1 },	1389	"--" => sub { $_[0] = ${$_[0]} - 1 },
964	fallback => 1;	1390	fallback => 1;
965		1391
966	1;	1392	1;
967		1393
		1394	=head1 SEE ALSO
		1395
		1396	The F<json_xs> command line utility for quick experiments.
		1397
968	=head1 AUTHOR	1398	=head1 AUTHOR
969		1399
970	Marc Lehmann <schmorp@schmorp.de>	1400	Marc Lehmann <schmorp@schmorp.de>
971	http://home.schmorp.de/	1401	http://home.schmorp.de/
972		1402

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.110 by root, Sun Jul 20 17:55:19 2008 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.110 by root, Sun Jul 20 17:55:19 2008 UTC