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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.72 by root, Sun Nov 25 19:11:07 2007 UTC vs.
Revision 1.142 by root, Fri Oct 25 19:57:42 2013 UTC

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

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.72 by root, Sun Nov 25 19:11:07 2007 UTC vs. Revision 1.142 by root, Fri Oct 25 19:57:42 2013 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.72 by root, Sun Nov 25 19:11:07 2007 UTC vs.
Revision 1.142 by root, Fri Oct 25 19:57:42 2013 UTC