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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.45 by root, Mon Jun 25 04:16:46 2007 UTC vs.
Revision 1.98 by root, Wed Mar 26 02:36:18 2008 UTC

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

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.45 by root, Mon Jun 25 04:16:46 2007 UTC vs. Revision 1.98 by root, Wed Mar 26 02:36:18 2008 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.45 by root, Mon Jun 25 04:16:46 2007 UTC vs.
Revision 1.98 by root, Wed Mar 26 02:36:18 2008 UTC