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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.14 by root, Fri Mar 23 19:02:02 2007 UTC vs.
Revision 1.21 by root, Sun Mar 25 02:32:40 2007 UTC

…		…
8		8
9	# exported functions, croak on error	9	# exported functions, croak on error
10		10
11	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;	11	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;
12	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;	12	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;
		13
		14	# objToJson and jsonToObj are exported for JSON
		15	# compatibility, but should not be used in new code.
13		16
14	# oo-interface	17	# oo-interface
15		18
16	$coder = JSON::XS->new->ascii->pretty->allow_nonref;	19	$coder = JSON::XS->new->ascii->pretty->allow_nonref;
17	$pretty_printed_unencoded = $coder->encode ($perl_scalar);	20	$pretty_printed_unencoded = $coder->encode ($perl_scalar);
…		…
36		39
37	=head2 FEATURES	40	=head2 FEATURES
38		41
39	=over 4	42	=over 4
40		43
41	=item * correct handling of unicode issues	44	=item * correct unicode handling
42		45
43	This module knows how to handle Unicode, and even documents how and when	46	This module knows how to handle Unicode, and even documents how and when
44	it does so.	47	it does so.
45		48
46	=item * round-trip integrity	49	=item * round-trip integrity
47		50
48	When you serialise a perl data structure using only datatypes supported	51	When you serialise a perl data structure using only datatypes supported
49	by JSON, the deserialised data structure is identical on the Perl level.	52	by JSON, the deserialised data structure is identical on the Perl level.
50	(e.g. the string "2.0" doesn't suddenly become "2").	53	(e.g. the string "2.0" doesn't suddenly become "2" just because it looks
		54	like a number).
51		55
52	=item * strict checking of JSON correctness	56	=item * strict checking of JSON correctness
53		57
54	There is no guessing, no generating of illegal JSON strings by default,	58	There is no guessing, no generating of illegal JSON texts by default,
55	and only JSON is accepted as input by default (the latter is a security	59	and only JSON is accepted as input by default (the latter is a security
56	feature).	60	feature).
57		61
58	=item * fast	62	=item * fast
59		63
…		…
66	interface.	70	interface.
67		71
68	=item * reasonably versatile output formats	72	=item * reasonably versatile output formats
69		73
70	You can choose between the most compact guarenteed single-line format	74	You can choose between the most compact guarenteed single-line format
71	possible (nice for simple line-based protocols), a pure-ascii format (for	75	possible (nice for simple line-based protocols), a pure-ascii format
72	when your transport is not 8-bit clean), or a pretty-printed format (for	76	(for when your transport is not 8-bit clean, still supports the whole
73	when you want to read that stuff). Or you can combine those features in	77	unicode range), or a pretty-printed format (for when you want to read that
74	whatever way you like.	78	stuff). Or you can combine those features in whatever way you like.
75		79
76	=back	80	=back
77		81
78	=cut	82	=cut
79		83
80	package JSON::XS;	84	package JSON::XS;
81		85
		86	use strict;
		87
82	BEGIN {	88	BEGIN {
83	$VERSION = '0.3';	89	our $VERSION = '0.8';
84	@ISA = qw(Exporter);	90	our @ISA = qw(Exporter);
85		91
86	@EXPORT = qw(to_json from_json);	92	our @EXPORT = qw(to_json from_json objToJson jsonToObj);
87	require Exporter;	93	require Exporter;
88		94
89	require XSLoader;	95	require XSLoader;
90	XSLoader::load JSON::XS::, $VERSION;	96	XSLoader::load JSON::XS::, $VERSION;
91	}	97	}
…		…
95	The following convinience methods are provided by this module. They are	101	The following convinience methods are provided by this module. They are
96	exported by default:	102	exported by default:
97		103
98	=over 4	104	=over 4
99		105
100	=item $json_string = to_json $perl_scalar	106	=item $json_text = to_json $perl_scalar
101		107
102	Converts the given Perl data structure (a simple scalar or a reference to	108	Converts the given Perl data structure (a simple scalar or a reference to
103	a hash or array) to a UTF-8 encoded, binary string (that is, the string contains	109	a hash or array) to a UTF-8 encoded, binary string (that is, the string contains
104	octets only). Croaks on error.	110	octets only). Croaks on error.
105		111
106	This function call is functionally identical to C<< JSON::XS->new->utf8->encode ($perl_scalar) >>.	112	This function call is functionally identical to:
107		113
		114	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)
		115
		116	except being faster.
		117
108	=item $perl_scalar = from_json $json_string	118	=item $perl_scalar = from_json $json_text
109		119
110	The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to	120	The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to
111	parse that as an UTF-8 encoded JSON string, returning the resulting simple	121	parse that as an UTF-8 encoded JSON text, returning the resulting simple
112	scalar or reference. Croaks on error.	122	scalar or reference. Croaks on error.
113		123
114	This function call is functionally identical to C<< JSON::XS->new->utf8->decode ($json_string) >>.	124	This function call is functionally identical to:
		125
		126	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
		127
		128	except being faster.
115		129
116	=back	130	=back
117		131
118	=head1 OBJECT-ORIENTED INTERFACE	132	=head1 OBJECT-ORIENTED INTERFACE
119		133
…		…
128	strings. All boolean flags described below are by default I<disabled>.	142	strings. All boolean flags described below are by default I<disabled>.
129		143
130	The mutators for flags all return the JSON object again and thus calls can	144	The mutators for flags all return the JSON object again and thus calls can
131	be chained:	145	be chained:
132		146
133	my $json = JSON::XS->new->utf8(1)->space_after(1)->encode ({a => [1,2]})	147	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
134	=> {"a": [1, 2]}	148	=> {"a": [1, 2]}
135		149
136	=item $json = $json->ascii ([$enable])	150	=item $json = $json->ascii ([$enable])
137		151
138	If C<$enable> is true (or missing), then the C<encode> method will	152	If C<$enable> is true (or missing), then the C<encode> method will not
139	not generate characters outside the code range C<0..127>. Any unicode	153	generate characters outside the code range C<0..127> (which is ASCII). Any
140	characters outside that range will be escaped using either a single	154	unicode characters outside that range will be escaped using either a
141	\uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, as per	155	single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence,
142	RFC4627.	156	as per RFC4627.
143		157
144	If C<$enable> is false, then the C<encode> method will not escape Unicode	158	If C<$enable> is false, then the C<encode> method will not escape Unicode
145	characters unless necessary.	159	characters unless required by the JSON syntax. This results in a faster
		160	and more compact format.
146		161
147	JSON::XS->new->ascii (1)->encode (chr 0x10401)	162	JSON::XS->new->ascii (1)->encode ([chr 0x10401])
148	=> \ud801\udc01	163	=> ["\ud801\udc01"]
149		164
150	=item $json = $json->utf8 ([$enable])	165	=item $json = $json->utf8 ([$enable])
151		166
152	If C<$enable> is true (or missing), then the C<encode> method will encode	167	If C<$enable> is true (or missing), then the C<encode> method will encode
153	the JSON string into UTF-8, as required by many protocols, while the	168	the JSON result into UTF-8, as required by many protocols, while the
154	C<decode> method expects to be handled an UTF-8-encoded string. Please	169	C<decode> method expects to be handled an UTF-8-encoded string. Please
155	note that UTF-8-encoded strings do not contain any characters outside the	170	note that UTF-8-encoded strings do not contain any characters outside the
156	range C<0..255>, they are thus useful for bytewise/binary I/O.	171	range C<0..255>, they are thus useful for bytewise/binary I/O. In future
		172	versions, enabling this option might enable autodetection of the UTF-16
		173	and UTF-32 encoding families, as described in RFC4627.
157		174
158	If C<$enable> is false, then the C<encode> method will return the JSON	175	If C<$enable> is false, then the C<encode> method will return the JSON
159	string as a (non-encoded) unicode string, while C<decode> expects thus a	176	string as a (non-encoded) unicode string, while C<decode> expects thus a
160	unicode string. Any decoding or encoding (e.g. to UTF-8 or UTF-16) needs	177	unicode string. Any decoding or encoding (e.g. to UTF-8 or UTF-16) needs
161	to be done yourself, e.g. using the Encode module.	178	to be done yourself, e.g. using the Encode module.
162		179
163	Example, output UTF-16-encoded JSON:	180	Example, output UTF-16BE-encoded JSON:
		181
		182	use Encode;
		183	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);
		184
		185	Example, decode UTF-32LE-encoded JSON:
		186
		187	use Encode;
		188	$object = JSON::XS->new->decode (decode "UTF-32LE", $jsontext);
164		189
165	=item $json = $json->pretty ([$enable])	190	=item $json = $json->pretty ([$enable])
166		191
167	This enables (or disables) all of the C<indent>, C<space_before> and	192	This enables (or disables) all of the C<indent>, C<space_before> and
168	C<space_after> (and in the future possibly more) flags in one call to	193	C<space_after> (and in the future possibly more) flags in one call to
…		…
184	If C<$enable> is true (or missing), then the C<encode> method will use a multiline	209	If C<$enable> is true (or missing), then the C<encode> method will use a multiline
185	format as output, putting every array member or object/hash key-value pair	210	format as output, putting every array member or object/hash key-value pair
186	into its own line, identing them properly.	211	into its own line, identing them properly.
187		212
188	If C<$enable> is false, no newlines or indenting will be produced, and the	213	If C<$enable> is false, no newlines or indenting will be produced, and the
189	resulting JSON strings is guarenteed not to contain any C<newlines>.	214	resulting JSON text is guarenteed not to contain any C<newlines>.
190		215
191	This setting has no effect when decoding JSON strings.	216	This setting has no effect when decoding JSON texts.
192		217
193	=item $json = $json->space_before ([$enable])	218	=item $json = $json->space_before ([$enable])
194		219
195	If C<$enable> is true (or missing), then the C<encode> method will add an extra	220	If C<$enable> is true (or missing), then the C<encode> method will add an extra
196	optional space before the C<:> separating keys from values in JSON objects.	221	optional space before the C<:> separating keys from values in JSON objects.
197		222
198	If C<$enable> is false, then the C<encode> method will not add any extra	223	If C<$enable> is false, then the C<encode> method will not add any extra
199	space at those places.	224	space at those places.
200		225
201	This setting has no effect when decoding JSON strings. You will also most	226	This setting has no effect when decoding JSON texts. You will also
202	likely combine this setting with C<space_after>.	227	most likely combine this setting with C<space_after>.
203		228
204	Example, space_before enabled, space_after and indent disabled:	229	Example, space_before enabled, space_after and indent disabled:
205		230
206	{"key" :"value"}	231	{"key" :"value"}
207		232
…		…
213	members.	238	members.
214		239
215	If C<$enable> is false, then the C<encode> method will not add any extra	240	If C<$enable> is false, then the C<encode> method will not add any extra
216	space at those places.	241	space at those places.
217		242
218	This setting has no effect when decoding JSON strings.	243	This setting has no effect when decoding JSON texts.
219		244
220	Example, space_before and indent disabled, space_after enabled:	245	Example, space_before and indent disabled, space_after enabled:
221		246
222	{"key": "value"}	247	{"key": "value"}
223		248
…		…
229	If C<$enable> is false, then the C<encode> method will output key-value	254	If C<$enable> is false, then the C<encode> method will output key-value
230	pairs in the order Perl stores them (which will likely change between runs	255	pairs in the order Perl stores them (which will likely change between runs
231	of the same script).	256	of the same script).
232		257
233	This option is useful if you want the same data structure to be encoded as	258	This option is useful if you want the same data structure to be encoded as
234	the same JSON string (given the same overall settings). If it is disabled,	259	the same JSON text (given the same overall settings). If it is disabled,
235	the same hash migh be encoded differently even if contains the same data,	260	the same hash migh be encoded differently even if contains the same data,
236	as key-value pairs have no inherent ordering in Perl.	261	as key-value pairs have no inherent ordering in Perl.
237		262
238	This setting has no effect when decoding JSON strings.	263	This setting has no effect when decoding JSON texts.
239		264
240	=item $json = $json->allow_nonref ([$enable])	265	=item $json = $json->allow_nonref ([$enable])
241		266
242	If C<$enable> is true (or missing), then the C<encode> method can convert a	267	If C<$enable> is true (or missing), then the C<encode> method can convert a
243	non-reference into its corresponding string, number or null JSON value,	268	non-reference into its corresponding string, number or null JSON value,
244	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON	269	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON
245	values instead of croaking.	270	values instead of croaking.
246		271
247	If C<$enable> is false, then the C<encode> method will croak if it isn't	272	If C<$enable> is false, then the C<encode> method will croak if it isn't
248	passed an arrayref or hashref, as JSON strings must either be an object	273	passed an arrayref or hashref, as JSON texts must either be an object
249	or array. Likewise, C<decode> will croak if given something that is not a	274	or array. Likewise, C<decode> will croak if given something that is not a
250	JSON object or array.	275	JSON object or array.
251		276
252	Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>,	277	Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>,
253	resulting in an invalid JSON text:	278	resulting in an invalid JSON text:
…		…
258	=item $json = $json->shrink ([$enable])	283	=item $json = $json->shrink ([$enable])
259		284
260	Perl usually over-allocates memory a bit when allocating space for	285	Perl usually over-allocates memory a bit when allocating space for
261	strings. This flag optionally resizes strings generated by either	286	strings. This flag optionally resizes strings generated by either
262	C<encode> or C<decode> to their minimum size possible. This can save	287	C<encode> or C<decode> to their minimum size possible. This can save
263	memory when your JSON strings are either very very long or you have many	288	memory when your JSON texts are either very very long or you have many
264	short strings. It will also try to downgrade any strings to octet-form	289	short strings. It will also try to downgrade any strings to octet-form
265	if possible: perl stores strings internally either in an encoding called	290	if possible: perl stores strings internally either in an encoding called
266	UTF-X or in octet-form. The latter cannot store everything but uses less	291	UTF-X or in octet-form. The latter cannot store everything but uses less
267	space in general.	292	space in general.
268		293
…		…
274		299
275	In the future, this setting might control other things, such as converting	300	In the future, this setting might control other things, such as converting
276	strings that look like integers or floats into integers or floats	301	strings that look like integers or floats into integers or floats
277	internally (there is no difference on the Perl level), saving space.	302	internally (there is no difference on the Perl level), saving space.
278		303
279	=item $json_string = $json->encode ($perl_scalar)	304	=item $json_text = $json->encode ($perl_scalar)
280		305
281	Converts the given Perl data structure (a simple scalar or a reference	306	Converts the given Perl data structure (a simple scalar or a reference
282	to a hash or array) to its JSON representation. Simple scalars will be	307	to a hash or array) to its JSON representation. Simple scalars will be
283	converted into JSON string or number sequences, while references to arrays	308	converted into JSON string or number sequences, while references to arrays
284	become JSON arrays and references to hashes become JSON objects. Undefined	309	become JSON arrays and references to hashes become JSON objects. Undefined
285	Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true>	310	Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true>
286	nor C<false> values will be generated.	311	nor C<false> values will be generated.
287		312
288	=item $perl_scalar = $json->decode ($json_string)	313	=item $perl_scalar = $json->decode ($json_text)
289		314
290	The opposite of C<encode>: expects a JSON string and tries to parse it,	315	The opposite of C<encode>: expects a JSON text and tries to parse it,
291	returning the resulting simple scalar or reference. Croaks on error.	316	returning the resulting simple scalar or reference. Croaks on error.
292		317
293	JSON numbers and strings become simple Perl scalars. JSON arrays become	318	JSON numbers and strings become simple Perl scalars. JSON arrays become
294	Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes	319	Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes
295	C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.	320	C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.
…		…
448		473
449	Has problems handling many Perl values (e.g. regex results and other magic	474	Has problems handling many Perl values (e.g. regex results and other magic
450	values will make it croak).	475	values will make it croak).
451		476
452	Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}>	477	Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}>
453	which is not a valid JSON string.	478	which is not a valid JSON text.
454		479
455	Unmaintained (maintainer unresponsive for many months, bugs are not	480	Unmaintained (maintainer unresponsive for many months, bugs are not
456	getting fixed).	481	getting fixed).
457		482
458	=item JSON::Syck 0.21	483	=item JSON::Syck 0.21
…		…
460	Very buggy (often crashes).	485	Very buggy (often crashes).
461		486
462	Very inflexible (no human-readable format supported, format pretty much	487	Very inflexible (no human-readable format supported, format pretty much
463	undocumented. I need at least a format for easy reading by humans and a	488	undocumented. I need at least a format for easy reading by humans and a
464	single-line compact format for use in a protocol, and preferably a way to	489	single-line compact format for use in a protocol, and preferably a way to
465	generate ASCII-only JSON strings).	490	generate ASCII-only JSON texts).
466		491
467	Completely broken (and confusingly documented) Unicode handling (unicode	492	Completely broken (and confusingly documented) Unicode handling (unicode
468	escapes are not working properly, you need to set ImplicitUnicode to	493	escapes are not working properly, you need to set ImplicitUnicode to
469	I<different> values on en- and decoding to get symmetric behaviour).	494	I<different> values on en- and decoding to get symmetric behaviour).
470		495
…		…
493		518
494	Very inflexible.	519	Very inflexible.
495		520
496	No roundtripping.	521	No roundtripping.
497		522
498	Does not generate valid JSON (key strings are often unquoted, empty keys	523	Does not generate valid JSON texts (key strings are often unquoted, empty keys
499	result in nothing being output)	524	result in nothing being output)
500		525
501	Does not check input for validity.	526	Does not check input for validity.
502		527
503	=back	528	=back
…		…
508	tables. They have been generated with the help of the C<eg/bench> program	533	tables. They have been generated with the help of the C<eg/bench> program
509	in the JSON::XS distribution, to make it easy to compare on your own	534	in the JSON::XS distribution, to make it easy to compare on your own
510	system.	535	system.
511		536
512	First comes a comparison between various modules using a very short JSON	537	First comes a comparison between various modules using a very short JSON
513	string (83 bytes), showing the number of encodes/decodes per second	538	string:
514	(JSON::XS is the functional interface, while JSON::XS/2 is the OO	539
		540	{"method": "handleMessage", "params": ["user1", "we were just talking"], "id": null}
		541
		542	It shows the number of encodes/decodes per second (JSON::XS uses the
		543	functional interface, while JSON::XS/2 uses the OO interface with
515	interface with pretty-printing and hashkey sorting enabled). Higher is	544	pretty-printing and hashkey sorting enabled). Higher is better:
516	better:
517		545
518	module \| encode \| decode \|	546	module \| encode \| decode \|
519	-----------\|------------\|------------\|	547	-----------\|------------\|------------\|
520	JSON \| 14006 \| 6820 \|	548	JSON \| 11488.516 \| 7823.035 \|
521	JSON::DWIW \| 200937 \| 120386 \|	549	JSON::DWIW \| 94708.054 \| 129094.260 \|
522	JSON::PC \| 85065 \| 129366 \|	550	JSON::PC \| 63884.157 \| 128528.212 \|
523	JSON::Syck \| 59898 \| 44232 \|	551	JSON::Syck \| 34898.677 \| 42096.911 \|
524	JSON::XS \| 1171478 \| 342435 \|	552	JSON::XS \| 654027.064 \| 396423.669 \|
525	JSON::XS/2 \| 730760 \| 328714 \|	553	JSON::XS/2 \| 371564.190 \| 371725.613 \|
526	-----------+------------+------------+	554	-----------+------------+------------+
527		555
528	That is, JSON::XS is 6 times faster than than JSON::DWIW and about 80	556	That is, JSON::XS is more than six times faster than JSON::DWIW on
		557	encoding, more than three times faster on decoding, and about thirty times
529	times faster than JSON, even with pretty-printing and key sorting.	558	faster than JSON, even with pretty-printing and key sorting.
530		559
531	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	560	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
532	search API (http://nanoref.com/yahooapis/mgPdGg):	561	search API (http://nanoref.com/yahooapis/mgPdGg):
533		562
534	module \| encode \| decode \|	563	module \| encode \| decode \|
535	-----------\|------------\|------------\|	564	-----------\|------------\|------------\|
536	JSON \| 673 \| 38 \|	565	JSON \| 273.023 \| 44.674 \|
537	JSON::DWIW \| 5271 \| 770 \|	566	JSON::DWIW \| 1089.383 \| 1145.704 \|
538	JSON::PC \| 9901 \| 2491 \|	567	JSON::PC \| 3097.419 \| 2393.921 \|
539	JSON::Syck \| 2360 \| 786 \|	568	JSON::Syck \| 514.060 \| 843.053 \|
540	JSON::XS \| 37398 \| 3202 \|	569	JSON::XS \| 6479.668 \| 3636.364 \|
541	JSON::XS/2 \| 13765 \| 3153 \|	570	JSON::XS/2 \| 3774.221 \| 3599.124 \|
542	-----------+------------+------------+	571	-----------+------------+------------+
543		572
544	Again, JSON::XS leads by far in the encoding case, while still beating	573	Again, JSON::XS leads by far.
545	every other module in the decoding case.
546		574
547	On large strings containing lots of unicode characters, some modules	575	On large strings containing lots of high unicode characters, some modules
548	(such as JSON::PC) decode faster than JSON::XS, but the result will be	576	(such as JSON::PC) seem to decode faster than JSON::XS, but the result
549	broken due to missing unicode handling. Others refuse to decode or encode	577	will be broken due to missing (or wrong) unicode handling. Others refuse
550	properly, so it was impossible to prepare a fair comparison table for that	578	to decode or encode properly, so it was impossible to prepare a fair
551	case.	579	comparison table for that case.
552		580
553	=head1 RESOURCE LIMITS	581	=head1 RESOURCE LIMITS
554		582
555	JSON::XS does not impose any limits on the size of JSON texts or Perl	583	JSON::XS does not impose any limits on the size of JSON texts or Perl
556	values they represent - if your machine can handle it, JSON::XS will	584	values they represent - if your machine can handle it, JSON::XS will

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.14 by root, Fri Mar 23 19:02:02 2007 UTC vs. Revision 1.21 by root, Sun Mar 25 02:32:40 2007 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.14 by root, Fri Mar 23 19:02:02 2007 UTC vs.
Revision 1.21 by root, Sun Mar 25 02:32:40 2007 UTC