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

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

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.75 by root, Thu Nov 29 13:35:35 2007 UTC vs. Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.75 by root, Thu Nov 29 13:35:35 2007 UTC vs.
Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC