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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.12 by root, Fri Mar 23 18:33:50 2007 UTC vs.
Revision 1.20 by root, Sun Mar 25 00:47:42 2007 UTC

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

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.12 by root, Fri Mar 23 18:33:50 2007 UTC vs.
Revision 1.20 by root, Sun Mar 25 00:47:42 2007 UTC