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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.20 by root, Sun Mar 25 00:47:42 2007 UTC vs.
Revision 1.32 by root, Thu Apr 12 07:25:29 2007 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use JSON::XS;	7	use JSON::XS;
8		8
9	# exported functions, croak on error	9	# exported functions, they croak on error
		10	# and expect/generate UTF-8
10		11
11	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;	12	$utf8_encoded_json_text = to_json $perl_hash_or_arrayref;
12	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;	13	$perl_hash_or_arrayref = from_json $utf8_encoded_json_text;
13		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
14	# oo-interface	19	# OO-interface
15		20
16	$coder = JSON::XS->new->ascii->pretty->allow_nonref;	21	$coder = JSON::XS->new->ascii->pretty->allow_nonref;
17	$pretty_printed_unencoded = $coder->encode ($perl_scalar);	22	$pretty_printed_unencoded = $coder->encode ($perl_scalar);
18	$perl_scalar = $coder->decode ($unicode_json_text);	23	$perl_scalar = $coder->decode ($unicode_json_text);
19		24
…		…
36		41
37	=head2 FEATURES	42	=head2 FEATURES
38		43
39	=over 4	44	=over 4
40		45
41	=item * correct handling of unicode issues	46	=item * correct unicode handling
42		47
43	This module knows how to handle Unicode, and even documents how and when	48	This module knows how to handle Unicode, and even documents how and when
44	it does so.	49	it does so.
45		50
46	=item * round-trip integrity	51	=item * round-trip integrity
47		52
48	When you serialise a perl data structure using only datatypes supported	53	When you serialise a perl data structure using only datatypes supported
49	by JSON, the deserialised data structure is identical on the Perl level.	54	by JSON, the deserialised data structure is identical on the Perl level.
50	(e.g. the string "2.0" doesn't suddenly become "2").	55	(e.g. the string "2.0" doesn't suddenly become "2" just because it looks
		56	like a number).
51		57
52	=item * strict checking of JSON correctness	58	=item * strict checking of JSON correctness
53		59
54	There is no guessing, no generating of illegal JSON texts by default,	60	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	61	and only JSON is accepted as input by default (the latter is a security
…		…
66	interface.	72	interface.
67		73
68	=item * reasonably versatile output formats	74	=item * reasonably versatile output formats
69		75
70	You can choose between the most compact guarenteed single-line format	76	You can choose between the most compact guarenteed single-line format
71	possible (nice for simple line-based protocols), a pure-ascii format (for	77	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	78	(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	79	unicode range), or a pretty-printed format (for when you want to read that
74	whatever way you like.	80	stuff). Or you can combine those features in whatever way you like.
75		81
76	=back	82	=back
77		83
78	=cut	84	=cut
79		85
80	package JSON::XS;	86	package JSON::XS;
81		87
82	use strict;	88	use strict;
83		89
84	BEGIN {	90	BEGIN {
85	our $VERSION = '0.7';	91	our $VERSION = '1.12';
86	our @ISA = qw(Exporter);	92	our @ISA = qw(Exporter);
87		93
88	our @EXPORT = qw(to_json from_json);	94	our @EXPORT = qw(to_json from_json objToJson jsonToObj);
89	require Exporter;	95	require Exporter;
90		96
91	require XSLoader;	97	require XSLoader;
92	XSLoader::load JSON::XS::, $VERSION;	98	XSLoader::load JSON::XS::, $VERSION;
93	}	99	}
…		…
122	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	128	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
123		129
124	except being faster.	130	except being faster.
125		131
126	=back	132	=back
		133
127		134
128	=head1 OBJECT-ORIENTED INTERFACE	135	=head1 OBJECT-ORIENTED INTERFACE
129		136
130	The object oriented interface lets you configure your own encoding or	137	The object oriented interface lets you configure your own encoding or
131	decoding style, within the limits of supported formats.	138	decoding style, within the limits of supported formats.
…		…
147		154
148	If C<$enable> is true (or missing), then the C<encode> method will not	155	If C<$enable> is true (or missing), then the C<encode> method will not
149	generate characters outside the code range C<0..127> (which is ASCII). Any	156	generate characters outside the code range C<0..127> (which is ASCII). Any
150	unicode characters outside that range will be escaped using either a	157	unicode characters outside that range will be escaped using either a
151	single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence,	158	single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence,
152	as per RFC4627.	159	as per RFC4627. The resulting encoded JSON text can be treated as a native
		160	unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string,
		161	or any other superset of ASCII.
153		162
154	If C<$enable> is false, then the C<encode> method will not escape Unicode	163	If C<$enable> is false, then the C<encode> method will not escape Unicode
155	characters unless required by the JSON syntax. This results in a faster	164	characters unless required by the JSON syntax. This results in a faster
156	and more compact format.	165	and more compact format.
157		166
…		…
277	=> "Hello, World!"	286	=> "Hello, World!"
278		287
279	=item $json = $json->shrink ([$enable])	288	=item $json = $json->shrink ([$enable])
280		289
281	Perl usually over-allocates memory a bit when allocating space for	290	Perl usually over-allocates memory a bit when allocating space for
282	strings. This flag optionally resizes strings generated by either	291	strings. This flag optionally resizes strings generated by either
283	C<encode> or C<decode> to their minimum size possible. This can save	292	C<encode> or C<decode> to their minimum size possible. This can save
284	memory when your JSON texts are either very very long or you have many	293	memory when your JSON texts are either very very long or you have many
285	short strings. It will also try to downgrade any strings to octet-form	294	short strings. It will also try to downgrade any strings to octet-form
286	if possible: perl stores strings internally either in an encoding called	295	if possible: perl stores strings internally either in an encoding called
287	UTF-X or in octet-form. The latter cannot store everything but uses less	296	UTF-X or in octet-form. The latter cannot store everything but uses less
288	space in general.	297	space in general (and some buggy Perl or C code might even rely on that
		298	internal representation being used).
289		299
		300	The actual definition of what shrink does might change in future versions,
		301	but it will always try to save space at the expense of time.
		302
290	If C<$enable> is true (or missing), the string returned by C<encode> will be shrunk-to-fit,	303	If C<$enable> is true (or missing), the string returned by C<encode> will
291	while all strings generated by C<decode> will also be shrunk-to-fit.	304	be shrunk-to-fit, while all strings generated by C<decode> will also be
		305	shrunk-to-fit.
292		306
293	If C<$enable> is false, then the normal perl allocation algorithms are used.	307	If C<$enable> is false, then the normal perl allocation algorithms are used.
294	If you work with your data, then this is likely to be faster.	308	If you work with your data, then this is likely to be faster.
295		309
296	In the future, this setting might control other things, such as converting	310	In the future, this setting might control other things, such as converting
297	strings that look like integers or floats into integers or floats	311	strings that look like integers or floats into integers or floats
298	internally (there is no difference on the Perl level), saving space.	312	internally (there is no difference on the Perl level), saving space.
		313
		314	=item $json = $json->max_depth ([$maximum_nesting_depth])
		315
		316	Sets the maximum nesting level (default C<512>) accepted while encoding
		317	or decoding. If the JSON text or Perl data structure has an equal or
		318	higher nesting level then this limit, then the encoder and decoder will
		319	stop and croak at that point.
		320
		321	Nesting level is defined by number of hash- or arrayrefs that the encoder
		322	needs to traverse to reach a given point or the number of C<{> or C<[>
		323	characters without their matching closing parenthesis crossed to reach a
		324	given character in a string.
		325
		326	Setting the maximum depth to one disallows any nesting, so that ensures
		327	that the object is only a single hash/object or array.
		328
		329	The argument to C<max_depth> will be rounded up to the next nearest power
		330	of two.
		331
		332	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
299		333
300	=item $json_text = $json->encode ($perl_scalar)	334	=item $json_text = $json->encode ($perl_scalar)
301		335
302	Converts the given Perl data structure (a simple scalar or a reference	336	Converts the given Perl data structure (a simple scalar or a reference
303	to a hash or array) to its JSON representation. Simple scalars will be	337	to a hash or array) to its JSON representation. Simple scalars will be
…		…
315	Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes	349	Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes
316	C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.	350	C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.
317		351
318	=back	352	=back
319		353
		354
320	=head1 MAPPING	355	=head1 MAPPING
321		356
322	This section describes how JSON::XS maps Perl values to JSON values and	357	This section describes how JSON::XS maps Perl values to JSON values and
323	vice versa. These mappings are designed to "do the right thing" in most	358	vice versa. These mappings are designed to "do the right thing" in most
324	circumstances automatically, preserving round-tripping characteristics	359	circumstances automatically, preserving round-tripping characteristics
…		…
377	=over 4	412	=over 4
378		413
379	=item hash references	414	=item hash references
380		415
381	Perl hash references become JSON objects. As there is no inherent ordering	416	Perl hash references become JSON objects. As there is no inherent ordering
382	in hash keys, they will usually be encoded in a pseudo-random order that	417	in hash keys (or JSON objects), they will usually be encoded in a
383	can change between runs of the same program but stays generally the same	418	pseudo-random order that can change between runs of the same program but
384	within a single run of a program. JSON::XS can optionally sort the hash	419	stays generally the same within a single run of a program. JSON::XS can
385	keys (determined by the I<canonical> flag), so the same datastructure	420	optionally sort the hash keys (determined by the I<canonical> flag), so
386	will serialise to the same JSON text (given same settings and version of	421	the same datastructure will serialise to the same JSON text (given same
387	JSON::XS), but this incurs a runtime overhead.	422	settings and version of JSON::XS), but this incurs a runtime overhead
		423	and is only rarely useful, e.g. when you want to compare some JSON text
		424	against another for equality.
388		425
389	=item array references	426	=item array references
390		427
391	Perl array references become JSON arrays.	428	Perl array references become JSON arrays.
		429
		430	=item other references
		431
		432	Other unblessed references are generally not allowed and will cause an
		433	exception to be thrown, except for references to the integers C<0> and
		434	C<1>, which get turned into C<false> and C<true> atoms in JSON. You can
		435	also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
		436
		437	to_json [\0,JSON::XS::true] # yields [false,true]
392		438
393	=item blessed objects	439	=item blessed objects
394		440
395	Blessed objects are not allowed. JSON::XS currently tries to encode their	441	Blessed objects are not allowed. JSON::XS currently tries to encode their
396	underlying representation (hash- or arrayref), but this behaviour might	442	underlying representation (hash- or arrayref), but this behaviour might
…		…
429	$x *= 1; # same thing, the choise is yours.	475	$x *= 1; # same thing, the choise is yours.
430		476
431	You can not currently output JSON booleans or force the type in other,	477	You can not currently output JSON booleans or force the type in other,
432	less obscure, ways. Tell me if you need this capability.	478	less obscure, ways. Tell me if you need this capability.
433		479
434	=item circular data structures
435
436	Those will be encoded until memory or stackspace runs out.
437
438	=back	480	=back
		481
439		482
440	=head1 COMPARISON	483	=head1 COMPARISON
441		484
442	As already mentioned, this module was created because none of the existing	485	As already mentioned, this module was created because none of the existing
443	JSON modules could be made to work correctly. First I will describe the	486	JSON modules could be made to work correctly. First I will describe the
…		…
572	(such as JSON::PC) seem to decode faster than JSON::XS, but the result	615	(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	616	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	617	to decode or encode properly, so it was impossible to prepare a fair
575	comparison table for that case.	618	comparison table for that case.
576		619
577	=head1 RESOURCE LIMITS
578		620
579	JSON::XS does not impose any limits on the size of JSON texts or Perl	621	=head1 SECURITY CONSIDERATIONS
580	values they represent - if your machine can handle it, JSON::XS will	622
581	encode or decode it. Future versions might optionally impose structure	623	When you are using JSON in a protocol, talking to untrusted potentially
582	depth and memory use resource limits.	624	hostile creatures requires relatively few measures.
		625
		626	First of all, your JSON decoder should be secure, that is, should not have
		627	any buffer overflows. Obviously, this module should ensure that and I am
		628	trying hard on making that true, but you never know.
		629
		630	Second, you need to avoid resource-starving attacks. That means you should
		631	limit the size of JSON texts you accept, or make sure then when your
		632	resources run out, thats just fine (e.g. by using a separate process that
		633	can crash safely). The size of a JSON text in octets or characters is
		634	usually a good indication of the size of the resources required to decode
		635	it into a Perl structure.
		636
		637	Third, JSON::XS recurses using the C stack when decoding objects and
		638	arrays. The C stack is a limited resource: for instance, on my amd64
		639	machine with 8MB of stack size I can decode around 180k nested arrays but
		640	only 14k nested JSON objects (due to perl itself recursing deeply on croak
		641	to free the temporary). If that is exceeded, the program crashes. to be
		642	conservative, the default nesting limit is set to 512. If your process
		643	has a smaller stack, you should adjust this setting accordingly with the
		644	C<max_depth> method.
		645
		646	And last but least, something else could bomb you that I forgot to think
		647	of. In that case, you get to keep the pieces. I am always open for hints,
		648	though...
		649
583		650
584	=head1 BUGS	651	=head1 BUGS
585		652
586	While the goal of this module is to be correct, that unfortunately does	653	While the goal of this module is to be correct, that unfortunately does
587	not mean its bug-free, only that I think its design is bug-free. It is	654	not mean its bug-free, only that I think its design is bug-free. It is
588	still very young and not well-tested. If you keep reporting bugs they will	655	still relatively early in its development. If you keep reporting bugs they
589	be fixed swiftly, though.	656	will be fixed swiftly, though.
590		657
591	=cut	658	=cut
		659
		660	sub true() { \1 }
		661	sub false() { \0 }
592		662
593	1;	663	1;
594		664
595	=head1 AUTHOR	665	=head1 AUTHOR
596		666

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.20 by root, Sun Mar 25 00:47:42 2007 UTC vs. Revision 1.32 by root, Thu Apr 12 07:25:29 2007 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.20 by root, Sun Mar 25 00:47:42 2007 UTC vs.
Revision 1.32 by root, Thu Apr 12 07:25:29 2007 UTC