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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.84 by root, Wed Mar 19 02:52:15 2008 UTC vs.
Revision 1.96 by root, Wed Mar 26 01:40:42 2008 UTC

…		…
		1	=head1 NAME
		2
1	=encoding utf-8	3	=encoding utf-8
2
3	=head1 NAME
4		4
5	JSON::XS - JSON serialising/deserialising, done correctly and fast	5	JSON::XS - JSON serialising/deserialising, done correctly and fast
6		6
7	JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ	7	JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ
8	(http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html)	8	(http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html)
103		103
104	package JSON::XS;	104	package JSON::XS;
105		105
106	use strict;	106	use strict;
107		107
108	our $VERSION = '2.01';	108	our $VERSION = '2.1';
109	our @ISA = qw(Exporter);	109	our @ISA = qw(Exporter);
110		110
111	our @EXPORT = qw(encode_json decode_json to_json from_json);	111	our @EXPORT = qw(encode_json decode_json to_json from_json);
112		112
113	sub to_json($) {	113	sub to_json($) {
…		…
245		245
246	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
247	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
248	in a faster and more compact format.	248	in a faster and more compact format.
249		249
		250	See also the section I<ENCODING/CODESET FLAG NOTES> later in this
		251	document.
		252
250	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
251	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
252	contain any 8 bit characters.	255	contain any 8 bit characters.
253		256
254	JSON::XS->new->ascii (1)->encode ([chr 0x10401])	257	JSON::XS->new->ascii (1)->encode ([chr 0x10401])
…		…
265	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
266	expects Unicode, which is a strict superset of latin1.	269	expects Unicode, which is a strict superset of latin1.
267		270
268	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
269	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.
270		276
271	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
272	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
273	size. The disadvantage is that the resulting JSON text is encoded	279	size. The disadvantage is that the resulting JSON text is encoded
274	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
…		…
293		299
294	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
295	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
296	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
297	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.
298		307
299	Example, output UTF-16BE-encoded JSON:	308	Example, output UTF-16BE-encoded JSON:
300		309
301	use Encode;	310	use Encode;
302	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);	311	$jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);
…		…
672	=> ([], 3)	681	=> ([], 3)
673		682
674	=back	683	=back
675		684
676		685
		686	=head1 INCREMENTAL PARSING
		687
		688	[This section 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	If there is a parse
		733
		734	=item $lvalue_string = $json->incr_text
		735
		736	This method returns the currently stored JSON fragment as an lvalue, that
		737	is, you can manipulate it. This I<only> works when a preceding call to
		738	C<incr_parse> in I<scalar context> successfully returned an object. Under
		739	all other circumstances you must not call this function (I mean it.
		740	although in simple tests it might actually work, it I<will> fail under
		741	real world conditions). As a special exception, you can also call this
		742	method before having parsed anything.
		743
		744	This function is useful in two cases: a) finding the trailing text after a
		745	JSON object or b) parsing multiple JSON objects separated by non-JSON text
		746	(such as commas).
		747
		748	=back
		749
		750	=head2 LIMITATIONS
		751
		752	All options that affect decoding are supported, except
		753	C<allow_nonref>. The reason for this is that it cannot be made to
		754	work sensibly: JSON objects and arrays are self-delimited, i.e. you can concatenate
		755	them back to back and still decode them perfectly. This does not hold true
		756	for JSON numbers, however.
		757
		758	For example, is the string C<1> a single JSON number, or is it simply the
		759	start of C<12>? Or is C<12> a single JSON number, or the concatenation
		760	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS
		761	takes the conservative route and disallows this case.
		762
		763	=head2 EXAMPLES
		764
		765	Some examples will make all this clearer. First, a simple example that
		766	works similarly to C<decode_prefix>: We want to decode the JSON object at
		767	the start of a string and identify the portion after the JSON object:
		768
		769	my $text = "[1,2,3] hello";
		770
		771	my $json = new JSON::XS;
		772
		773	my $obj = $json->incr_parse ($text)
		774	or die "expected JSON object or array at beginning of string";
		775
		776	my $tail = $json->incr_text;
		777	# $tail now contains " hello"
		778
		779	Easy, isn't it?
		780
		781	Now for a more complicated example: Imagine a hypothetical protocol where
		782	you read some requests from a TCP stream, and each request is a JSON
		783	array, without any separation between them (in fact, it is often useful to
		784	use newlines as "separators", as these get interpreted as whitespace at
		785	the start of the JSON text, which makes it possible to test said protocol
		786	with C<telnet>...).
		787
		788	Here is how you'd do it (it is trivial to write this in an event-based
		789	manner):
		790
		791	my $json = new JSON::XS;
		792
		793	# read some data from the socket
		794	while (sysread $socket, my $buf, 4096) {
		795
		796	# split and decode as many requests as possible
		797	for my $request ($json->incr_parse ($buf)) {
		798	# act on the $request
		799	}
		800	}
		801
		802	Another complicated example: Assume you have a string with JSON objects
		803	or arrays, all separated by (optional) comma characters (e.g. C<[1],[2],
		804	[3]>). To parse them, we have to skip the commas between the JSON texts,
		805	and here is where the lvalue-ness of C<incr_text> comes in useful:
		806
		807	my $text = "[1],[2], [3]";
		808	my $json = new JSON::XS;
		809
		810	# void context, so no parsing done
		811	$json->incr_parse ($text);
		812
		813	# now extract as many objects as possible. note the
		814	# use of scalar context so incr_text can be called.
		815	while (my $obj = $json->incr_parse) {
		816	# do something with $obj
		817
		818	# now skip the optional comma
		819	$json->incr_text =~ s/^ \s* , //x;
		820	}
		821
		822	Now lets go for a very complex example: Assume that you have a gigantic
		823	JSON array-of-objects, many gigabytes in size, and you want to parse it,
		824	but you cannot load it into memory fully (this has actually happened in
		825	the real world :).
		826
		827	Well, you lost, you have to implement your own JSON parser. But JSON::XS
		828	can still help you: You implement a (very simple) array parser and let
		829	JSON decode the array elements, which are all full JSON objects on their
		830	own (this wouldn't work if the array elements could be JSON numbers, for
		831	example):
		832
		833	my $json = new JSON::XS;
		834
		835	# open the monster
		836	open my $fh, "<bigfile.json"
		837	or die "bigfile: $!";
		838
		839	# first parse the initial "["
		840	for (;;) {
		841	sysread $fh, my $buf, 65536
		842	or die "read error: $!";
		843	$json->incr_parse ($buf); # void context, so no parsing
		844
		845	# Exit the loop once we found and removed(!) the initial "[".
		846	# In essence, we are (ab-)using the $json object as a simple scalar
		847	# we append data to.
		848	last if $json->incr_text =~ s/^ \s* \[ //x;
		849	}
		850
		851	# now we have the skipped the initial "[", so continue
		852	# parsing all the elements.
		853	for (;;) {
		854	# in this loop we read data until we got a single JSON object
		855	for (;;) {
		856	if (my $obj = $json->incr_parse) {
		857	# do something with $obj
		858	last;
		859	}
		860
		861	# add more data
		862	sysread $fh, my $buf, 65536
		863	or die "read error: $!";
		864	$json->incr_parse ($buf); # void context, so no parsing
		865	}
		866
		867	# in this loop we read data until we either found and parsed the
		868	# separating "," between elements, or the final "]"
		869	for (;;) {
		870	# first skip whitespace
		871	$json->incr_text =~ s/^\s*//;
		872
		873	# if we find "]", we are done
		874	if ($json->incr_text =~ s/^\]//) {
		875	print "finished.\n";
		876	exit;
		877	}
		878
		879	# if we find ",", we can continue with the next element
		880	if ($json->incr_text =~ s/^,//) {
		881	last;
		882	}
		883
		884	# if we find anything else, we have a parse error!
		885	if (length $json->incr_text) {
		886	die "parse error near ", $json->incr_text;
		887	}
		888
		889	# else add more data
		890	sysread $fh, my $buf, 65536
		891	or die "read error: $!";
		892	$json->incr_parse ($buf); # void context, so no parsing
		893	}
		894
		895	This is a complex example, but most of the complexity comes from the fact
		896	that we are trying to be correct (bear with me if I am wrong, I never ran
		897	the above example :).
		898
		899
		900
677	=head1 MAPPING	901	=head1 MAPPING
678		902
679	This section describes how JSON::XS maps Perl values to JSON values and	903	This section describes how JSON::XS maps Perl values to JSON values and
680	vice versa. These mappings are designed to "do the right thing" in most	904	vice versa. These mappings are designed to "do the right thing" in most
681	circumstances automatically, preserving round-tripping characteristics	905	circumstances automatically, preserving round-tripping characteristics
…		…
816	my $x = "3"; # some variable containing a string	1040	my $x = "3"; # some variable containing a string
817	$x += 0; # numify it, ensuring it will be dumped as a number	1041	$x += 0; # numify it, ensuring it will be dumped as a number
818	$x *= 1; # same thing, the choice is yours.	1042	$x *= 1; # same thing, the choice is yours.
819		1043
820	You can not currently force the type in other, less obscure, ways. Tell me	1044	You can not currently force the type in other, less obscure, ways. Tell me
821	if you need this capability (but don't forget to explain why its needed	1045	if you need this capability (but don't forget to explain why it's needed
822	:).	1046	:).
823		1047
824	=back	1048	=back
825		1049
826		1050
…		…
828		1052
829	The interested reader might have seen a number of flags that signify	1053	The interested reader might have seen a number of flags that signify
830	encodings or codesets - C<utf8>, C<latin1> and C<ascii>. There seems to be	1054	encodings or codesets - C<utf8>, C<latin1> and C<ascii>. There seems to be
831	some confusion on what these do, so here is a short comparison:	1055	some confusion on what these do, so here is a short comparison:
832		1056
833	C<utf8> controls wether the JSON text created by C<encode> (and expected	1057	C<utf8> controls whether the JSON text created by C<encode> (and expected
834	by C<decode>) is UTF-8 encoded or not, while C<latin1> and C<ascii> only	1058	by C<decode>) is UTF-8 encoded or not, while C<latin1> and C<ascii> only
835	control wether C<encode> escapes character values outside their respective	1059	control whether C<encode> escapes character values outside their respective
836	codeset range. Neither of these flags conflict with each other, although	1060	codeset range. Neither of these flags conflict with each other, although
837	some combinations make less sense than others.	1061	some combinations make less sense than others.
838		1062
839	Care has been taken to make all flags symmetrical with respect to	1063	Care has been taken to make all flags symmetrical with respect to
840	C<encode> and C<decode>, that is, texts encoded with any combination of	1064	C<encode> and C<decode>, that is, texts encoded with any combination of
…		…
920	proper subset of most 8-bit and multibyte encodings in use in the world.	1144	proper subset of most 8-bit and multibyte encodings in use in the world.
921		1145
922	=back	1146	=back
923		1147
924		1148
925	=head1 COMPARISON
926
927	As already mentioned, this module was created because none of the existing
928	JSON modules could be made to work correctly. First I will describe the
929	problems (or pleasures) I encountered with various existing JSON modules,
930	followed by some benchmark values. JSON::XS was designed not to suffer
931	from any of these problems or limitations.
932
933	=over 4
934
935	=item JSON 2.xx
936
937	A marvellous piece of engineering, this module either uses JSON::XS
938	directly when available (so will be 100% compatible with it, including
939	speed), or it uses JSON::PP, which is basically JSON::XS translated to
940	Pure Perl, which should be 100% compatible with JSON::XS, just a bit
941	slower.
942
943	You cannot really lose by using this module.
944
945	=item JSON 1.07
946
947	Slow (but very portable, as it is written in pure Perl).
948
949	Undocumented/buggy Unicode handling (how JSON handles Unicode values is
950	undocumented. One can get far by feeding it Unicode strings and doing
951	en-/decoding oneself, but Unicode escapes are not working properly).
952
953	No round-tripping (strings get clobbered if they look like numbers, e.g.
954	the string C<2.0> will encode to C<2.0> instead of C<"2.0">, and that will
955	decode into the number 2.
956
957	=item JSON::PC 0.01
958
959	Very fast.
960
961	Undocumented/buggy Unicode handling.
962
963	No round-tripping.
964
965	Has problems handling many Perl values (e.g. regex results and other magic
966	values will make it croak).
967
968	Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}>
969	which is not a valid JSON text.
970
971	Unmaintained (maintainer unresponsive for many months, bugs are not
972	getting fixed).
973
974	=item JSON::Syck 0.21
975
976	Very buggy (often crashes).
977
978	Very inflexible (no human-readable format supported, format pretty much
979	undocumented. I need at least a format for easy reading by humans and a
980	single-line compact format for use in a protocol, and preferably a way to
981	generate ASCII-only JSON texts).
982
983	Completely broken (and confusingly documented) Unicode handling (Unicode
984	escapes are not working properly, you need to set ImplicitUnicode to
985	I<different> values on en- and decoding to get symmetric behaviour).
986
987	No round-tripping (simple cases work, but this depends on whether the scalar
988	value was used in a numeric context or not).
989
990	Dumping hashes may skip hash values depending on iterator state.
991
992	Unmaintained (maintainer unresponsive for many months, bugs are not
993	getting fixed).
994
995	Does not check input for validity (i.e. will accept non-JSON input and
996	return "something" instead of raising an exception. This is a security
997	issue: imagine two banks transferring money between each other using
998	JSON. One bank might parse a given non-JSON request and deduct money,
999	while the other might reject the transaction with a syntax error. While a
1000	good protocol will at least recover, that is extra unnecessary work and
1001	the transaction will still not succeed).
1002
1003	=item JSON::DWIW 0.04
1004
1005	Very fast. Very natural. Very nice.
1006
1007	Undocumented Unicode handling (but the best of the pack. Unicode escapes
1008	still don't get parsed properly).
1009
1010	Very inflexible.
1011
1012	No round-tripping.
1013
1014	Does not generate valid JSON texts (key strings are often unquoted, empty keys
1015	result in nothing being output)
1016
1017	Does not check input for validity.
1018
1019	=back
1020
1021
1022	=head2 JSON and YAML	1149	=head2 JSON and YAML
1023		1150
1024	You often hear that JSON is a subset of YAML. This is, however, a mass	1151	You often hear that JSON is a subset of YAML. This is, however, a mass
1025	hysteria(*) and very far from the truth. In general, there is no way to	1152	hysteria(*) and very far from the truth (as of the time of this writing),
		1153	so let me state it clearly: I<in general, there is no way to configure
1026	configure JSON::XS to output a data structure as valid YAML that works for	1154	JSON::XS to output a data structure as valid YAML> that works in all
1027	all cases.	1155	cases.
1028		1156
1029	If you really must use JSON::XS to generate YAML, you should use this	1157	If you really must use JSON::XS to generate YAML, you should use this
1030	algorithm (subject to change in future versions):	1158	algorithm (subject to change in future versions):
1031		1159
1032	my $to_yaml = JSON::XS->new->utf8->space_after (1);	1160	my $to_yaml = JSON::XS->new->utf8->space_after (1);
…		…
1035	This will I<usually> generate JSON texts that also parse as valid	1163	This will I<usually> generate JSON texts that also parse as valid
1036	YAML. Please note that YAML has hardcoded limits on (simple) object key	1164	YAML. Please note that YAML has hardcoded limits on (simple) object key
1037	lengths that JSON doesn't have and also has different and incompatible	1165	lengths that JSON doesn't have and also has different and incompatible
1038	unicode handling, so you should make sure that your hash keys are	1166	unicode handling, so you should make sure that your hash keys are
1039	noticeably shorter than the 1024 "stream characters" YAML allows and that	1167	noticeably shorter than the 1024 "stream characters" YAML allows and that
1040	you do not have codepoints with values outside the Unicode BMP (basic	1168	you do not have characters with codepoint values outside the Unicode BMP
1041	multilingual page). YAML also does not allow C<\/> sequences in strings	1169	(basic multilingual page). YAML also does not allow C<\/> sequences in
1042	(which JSON::XS does not I<currently> generate).	1170	strings (which JSON::XS does not I<currently> generate, but other JSON
		1171	generators might).
1043		1172
1044	There might be other incompatibilities that I am not aware of (or the YAML	1173	There might be other incompatibilities that I am not aware of (or the YAML
1045	specification has been changed yet again - it does so quite often). In	1174	specification has been changed yet again - it does so quite often). In
1046	general you should not try to generate YAML with a JSON generator or vice	1175	general you should not try to generate YAML with a JSON generator or vice
1047	versa, or try to parse JSON with a YAML parser or vice versa: chances are	1176	versa, or try to parse JSON with a YAML parser or vice versa: chances are
…		…
1050		1179
1051	=over 4	1180	=over 4
1052		1181
1053	=item (*)	1182	=item (*)
1054		1183
1055	This is spread actively by the YAML team, however. For many years now they	1184	I have been pressured multiple times by Brian Ingerson (one of the
1056	claim YAML were a superset of JSON, even when proven otherwise.	1185	authors of the YAML specification) to remove this paragraph, despite him
		1186	acknowledging that the actual incompatibilities exist. As I was personally
		1187	bitten by this "JSON is YAML" lie, I refused and said I will continue to
		1188	educate people about these issues, so others do not run into the same
		1189	problem again and again. After this, Brian called me a (quote)I<complete
		1190	and worthless idiot>(unquote).
1057		1191
1058	Even the author of this manpage was at some point accused of providing	1192	In my opinion, instead of pressuring and insulting people who actually
1059	"incorrect" information, despite the evidence presented (claims ranged	1193	clarify issues with YAML and the wrong statements of some of its
1060	from "your documentation contains inaccurate and negative statements about	1194	proponents, I would kindly suggest reading the JSON spec (which is not
1061	YAML" (the only negative comment is this footnote, and it didn't exist	1195	that difficult or long) and finally make YAML compatible to it, and
1062	back then; the question on which claims were inaccurate was never answered	1196	educating users about the changes, instead of spreading lies about the
1063	etc.) to "the YAML spec is not up-to-date" (the real and supposedly	1197	real compatibility for many I<years> and trying to silence people who
1064	JSON-compatible spec is apparently not currently publicly available)	1198	point out that it isn't true.
1065	to actual requests to replace this section by incorrect information,
1066	suppressing information about the real problem).
1067
1068	So whenever you are told that YAML was a superset of JSON, first check
1069	wether it is really true (it might be when you check it, but it certainly
1070	was not true when this was written). I would much prefer if the YAML team
1071	would spent their time on actually making JSON compatibility a truth
1072	(JSON, after all, has a very small and simple specification) instead of
1073	trying to lobby/force people into reporting untruths.
1074		1199
1075	=back	1200	=back
1076		1201
1077		1202
1078	=head2 SPEED	1203	=head2 SPEED
…		…
1080	It seems that JSON::XS is surprisingly fast, as shown in the following	1205	It seems that JSON::XS is surprisingly fast, as shown in the following
1081	tables. They have been generated with the help of the C<eg/bench> program	1206	tables. They have been generated with the help of the C<eg/bench> program
1082	in the JSON::XS distribution, to make it easy to compare on your own	1207	in the JSON::XS distribution, to make it easy to compare on your own
1083	system.	1208	system.
1084		1209
1085	First comes a comparison between various modules using a very short	1210	First comes a comparison between various modules using
1086	single-line JSON string:	1211	a very short single-line JSON string (also available at
		1212	L<http://dist.schmorp.de/misc/json/short.json>).
1087		1213
1088	{"method": "handleMessage", "params": ["user1", "we were just talking"], \	1214	{"method": "handleMessage", "params": ["user1", "we were just talking"], \
1089	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}	1215	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}
1090		1216
1091	It shows the number of encodes/decodes per second (JSON::XS uses	1217	It shows the number of encodes/decodes per second (JSON::XS uses
…		…
1110	about three times faster on decoding, and over forty times faster	1236	about three times faster on decoding, and over forty times faster
1111	than JSON, even with pretty-printing and key sorting. It also compares	1237	than JSON, even with pretty-printing and key sorting. It also compares
1112	favourably to Storable for small amounts of data.	1238	favourably to Storable for small amounts of data.
1113		1239
1114	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	1240	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
1115	search API (http://nanoref.com/yahooapis/mgPdGg):	1241	search API (L<http://dist.schmorp.de/misc/json/long.json>).
1116		1242
1117	module \| encode \| decode \|	1243	module \| encode \| decode \|
1118	-----------\|------------\|------------\|	1244	-----------\|------------\|------------\|
1119	JSON 1.x \| 55.260 \| 34.971 \|	1245	JSON 1.x \| 55.260 \| 34.971 \|
1120	JSON::DWIW \| 825.228 \| 1082.513 \|	1246	JSON::DWIW \| 825.228 \| 1082.513 \|
…		…
1162	to free the temporary). If that is exceeded, the program crashes. To be	1288	to free the temporary). If that is exceeded, the program crashes. To be
1163	conservative, the default nesting limit is set to 512. If your process	1289	conservative, the default nesting limit is set to 512. If your process
1164	has a smaller stack, you should adjust this setting accordingly with the	1290	has a smaller stack, you should adjust this setting accordingly with the
1165	C<max_depth> method.	1291	C<max_depth> method.
1166		1292
1167	And last but least, something else could bomb you that I forgot to think	1293	Something else could bomb you, too, that I forgot to think of. In that
1168	of. In that case, you get to keep the pieces. I am always open for hints,	1294	case, you get to keep the pieces. I am always open for hints, though...
1169	though...	1295
		1296	Also keep in mind that JSON::XS might leak contents of your Perl data
		1297	structures in its error messages, so when you serialise sensitive
		1298	information you might want to make sure that exceptions thrown by JSON::XS
		1299	will not end up in front of untrusted eyes.
1170		1300
1171	If you are using JSON::XS to return packets to consumption	1301	If you are using JSON::XS to return packets to consumption
1172	by JavaScript scripts in a browser you should have a look at	1302	by JavaScript scripts in a browser you should have a look at
1173	L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether	1303	L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether
1174	you are vulnerable to some common attack vectors (which really are browser	1304	you are vulnerable to some common attack vectors (which really are browser
…		…
1180	=head1 THREADS	1310	=head1 THREADS
1181		1311
1182	This module is I<not> guaranteed to be thread safe and there are no	1312	This module is I<not> guaranteed to be thread safe and there are no
1183	plans to change this until Perl gets thread support (as opposed to the	1313	plans to change this until Perl gets thread support (as opposed to the
1184	horribly slow so-called "threads" which are simply slow and bloated	1314	horribly slow so-called "threads" which are simply slow and bloated
1185	process simulations - use fork, its I<much> faster, cheaper, better).	1315	process simulations - use fork, it's I<much> faster, cheaper, better).
1186		1316
1187	(It might actually work, but you have been warned).	1317	(It might actually work, but you have been warned).
1188		1318
1189		1319
1190	=head1 BUGS	1320	=head1 BUGS
1191		1321
1192	While the goal of this module is to be correct, that unfortunately does	1322	While the goal of this module is to be correct, that unfortunately does
1193	not mean its bug-free, only that I think its design is bug-free. It is	1323	not mean it's bug-free, only that I think its design is bug-free. It is
1194	still relatively early in its development. If you keep reporting bugs they	1324	still relatively early in its development. If you keep reporting bugs they
1195	will be fixed swiftly, though.	1325	will be fixed swiftly, though.
1196		1326
1197	Please refrain from using rt.cpan.org or any other bug reporting	1327	Please refrain from using rt.cpan.org or any other bug reporting
1198	service. I put the contact address into my modules for a reason.	1328	service. I put the contact address into my modules for a reason.
…		…
1220	"--" => sub { $_[0] = ${$_[0]} - 1 },	1350	"--" => sub { $_[0] = ${$_[0]} - 1 },
1221	fallback => 1;	1351	fallback => 1;
1222		1352
1223	1;	1353	1;
1224		1354
		1355	=head1 SEE ALSO
		1356
		1357	The F<json_xs> command line utility for quick experiments.
		1358
1225	=head1 AUTHOR	1359	=head1 AUTHOR
1226		1360
1227	Marc Lehmann <schmorp@schmorp.de>	1361	Marc Lehmann <schmorp@schmorp.de>
1228	http://home.schmorp.de/	1362	http://home.schmorp.de/
1229		1363

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.84 by root, Wed Mar 19 02:52:15 2008 UTC vs. Revision 1.96 by root, Wed Mar 26 01:40:42 2008 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.84 by root, Wed Mar 19 02:52:15 2008 UTC vs.
Revision 1.96 by root, Wed Mar 26 01:40:42 2008 UTC