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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.94 by root, Tue Mar 25 07:46:15 2008 UTC vs.
Revision 1.162 by root, Wed Nov 23 05:57:12 2016 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
		3	JSON::XS - JSON serialising/deserialising, done correctly and fast
		4
3	=encoding utf-8	5	=encoding utf-8
4
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)
9		9
10	=head1 SYNOPSIS	10	=head1 SYNOPSIS
37	primary goal is to be I<correct> and its secondary goal is to be	37	primary goal is to be I<correct> and its secondary goal is to be
38	I<fast>. To reach the latter goal it was written in C.	38	I<fast>. To reach the latter goal it was written in C.
39		39
40	Beginning with version 2.0 of the JSON module, when both JSON and	40	Beginning with version 2.0 of the JSON module, when both JSON and
41	JSON::XS are installed, then JSON will fall back on JSON::XS (this can be	41	JSON::XS are installed, then JSON will fall back on JSON::XS (this can be
42	overriden) with no overhead due to emulation (by inheritign constructor	42	overridden) with no overhead due to emulation (by inheriting constructor
43	and methods). If JSON::XS is not available, it will fall back to the	43	and methods). If JSON::XS is not available, it will fall back to the
44	compatible JSON::PP module as backend, so using JSON instead of JSON::XS	44	compatible JSON::PP module as backend, so using JSON instead of JSON::XS
45	gives you a portable JSON API that can be fast when you need and doesn't	45	gives you a portable JSON API that can be fast when you need it and
46	require a C compiler when that is a problem.	46	doesn't require a C compiler when that is a problem.
47		47
48	As this is the n-th-something JSON module on CPAN, what was the reason	48	As this is the n-th-something JSON module on CPAN, what was the reason
49	to write yet another JSON module? While it seems there are many JSON	49	to write yet another JSON module? While it seems there are many JSON
50	modules, none of them correctly handle all corner cases, and in most cases	50	modules, none of them correctly handle all corner cases, and in most cases
51	their maintainers are unresponsive, gone missing, or not listening to bug	51	their maintainers are unresponsive, gone missing, or not listening to bug
52	reports for other reasons.	52	reports for other reasons.
53		53
54	See COMPARISON, below, for a comparison to some other JSON modules.
55
56	See MAPPING, below, on how JSON::XS maps perl values to JSON values and	54	See MAPPING, below, on how JSON::XS maps perl values to JSON values and
57	vice versa.	55	vice versa.
58		56
59	=head2 FEATURES	57	=head2 FEATURES
60		58
…		…
65	This module knows how to handle Unicode, documents how and when it does	63	This module knows how to handle Unicode, documents how and when it does
66	so, and even documents what "correct" means.	64	so, and even documents what "correct" means.
67		65
68	=item * round-trip integrity	66	=item * round-trip integrity
69		67
70	When you serialise a perl data structure using only datatypes supported	68	When you serialise a perl data structure using only data types supported
71	by JSON, the deserialised data structure is identical on the Perl level.	69	by JSON and Perl, the deserialised data structure is identical on the Perl
72	(e.g. the string "2.0" doesn't suddenly become "2" just because it looks	70	level. (e.g. the string "2.0" doesn't suddenly become "2" just because
73	like a number). There minor I<are> exceptions to this, read the MAPPING	71	it looks like a number). There I<are> minor exceptions to this, read the
74	section below to learn about those.	72	MAPPING section below to learn about those.
75		73
76	=item * strict checking of JSON correctness	74	=item * strict checking of JSON correctness
77		75
78	There is no guessing, no generating of illegal JSON texts by default,	76	There is no guessing, no generating of illegal JSON texts by default,
79	and only JSON is accepted as input by default (the latter is a security	77	and only JSON is accepted as input by default (the latter is a security
…		…
84	Compared to other JSON modules and other serialisers such as Storable,	82	Compared to other JSON modules and other serialisers such as Storable,
85	this module usually compares favourably in terms of speed, too.	83	this module usually compares favourably in terms of speed, too.
86		84
87	=item * simple to use	85	=item * simple to use
88		86
89	This module has both a simple functional interface as well as an objetc	87	This module has both a simple functional interface as well as an object
90	oriented interface interface.	88	oriented interface.
91		89
92	=item * reasonably versatile output formats	90	=item * reasonably versatile output formats
93		91
94	You can choose between the most compact guaranteed-single-line format	92	You can choose between the most compact guaranteed-single-line format
95	possible (nice for simple line-based protocols), a pure-ascii format	93	possible (nice for simple line-based protocols), a pure-ASCII format
96	(for when your transport is not 8-bit clean, still supports the whole	94	(for when your transport is not 8-bit clean, still supports the whole
97	Unicode range), or a pretty-printed format (for when you want to read that	95	Unicode range), or a pretty-printed format (for when you want to read that
98	stuff). Or you can combine those features in whatever way you like.	96	stuff). Or you can combine those features in whatever way you like.
99		97
100	=back	98	=back
101		99
102	=cut	100	=cut
103		101
104	package JSON::XS;	102	package JSON::XS;
105		103
106	use strict;	104	use common::sense;
107		105
108	our $VERSION = '2.1';	106	our $VERSION = 3.03;
109	our @ISA = qw(Exporter);	107	our @ISA = qw(Exporter);
110		108
111	our @EXPORT = qw(encode_json decode_json to_json from_json);	109	our @EXPORT = qw(encode_json decode_json);
112
113	sub to_json($) {
114	require Carp;
115	Carp::croak ("JSON::XS::to_json has been renamed to encode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call");
116	}
117
118	sub from_json($) {
119	require Carp;
120	Carp::croak ("JSON::XS::from_json has been renamed to decode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call");
121	}
122		110
123	use Exporter;	111	use Exporter;
124	use XSLoader;	112	use XSLoader;
125		113
		114	use Types::Serialiser ();
		115
126	=head1 FUNCTIONAL INTERFACE	116	=head1 FUNCTIONAL INTERFACE
127		117
128	The following convenience methods are provided by this module. They are	118	The following convenience methods are provided by this module. They are
129	exported by default:	119	exported by default:
130		120
…		…
137		127
138	This function call is functionally identical to:	128	This function call is functionally identical to:
139		129
140	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)	130	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)
141		131
142	except being faster.	132	Except being faster.
143		133
144	=item $perl_scalar = decode_json $json_text	134	=item $perl_scalar = decode_json $json_text
145		135
146	The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries	136	The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries
147	to parse that as an UTF-8 encoded JSON text, returning the resulting	137	to parse that as an UTF-8 encoded JSON text, returning the resulting
…		…
149		139
150	This function call is functionally identical to:	140	This function call is functionally identical to:
151		141
152	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	142	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
153		143
154	except being faster.	144	Except being faster.
155
156	=item $is_boolean = JSON::XS::is_bool $scalar
157
158	Returns true if the passed scalar represents either JSON::XS::true or
159	JSON::XS::false, two constants that act like C<1> and C<0>, respectively
160	and are used to represent JSON C<true> and C<false> values in Perl.
161
162	See MAPPING, below, for more information on how JSON values are mapped to
163	Perl.
164		145
165	=back	146	=back
166		147
167		148
168	=head1 A FEW NOTES ON UNICODE AND PERL	149	=head1 A FEW NOTES ON UNICODE AND PERL
…		…
197		178
198	If you didn't know about that flag, just the better, pretend it doesn't	179	If you didn't know about that flag, just the better, pretend it doesn't
199	exist.	180	exist.
200		181
201	=item 4. A "Unicode String" is simply a string where each character can be	182	=item 4. A "Unicode String" is simply a string where each character can be
202	validly interpreted as a Unicode codepoint.	183	validly interpreted as a Unicode code point.
203		184
204	If you have UTF-8 encoded data, it is no longer a Unicode string, but a	185	If you have UTF-8 encoded data, it is no longer a Unicode string, but a
205	Unicode string encoded in UTF-8, giving you a binary string.	186	Unicode string encoded in UTF-8, giving you a binary string.
206		187
207	=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string.	188	=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string.
…		…
423	[	404	[
424	1, # this comment not allowed in JSON	405	1, # this comment not allowed in JSON
425	# neither this one...	406	# neither this one...
426	]	407	]
427		408
		409	=item * literal ASCII TAB characters in strings
		410
		411	Literal ASCII TAB characters are now allowed in strings (and treated as
		412	C<\t>).
		413
		414	[
		415	"Hello\tWorld",
		416	"Hello<TAB>World", # literal <TAB> would not normally be allowed
		417	]
		418
428	=back	419	=back
429		420
430	=item $json = $json->canonical ([$enable])	421	=item $json = $json->canonical ([$enable])
431		422
432	=item $enabled = $json->get_canonical	423	=item $enabled = $json->get_canonical
…		…
434	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects	425	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
435	by sorting their keys. This is adding a comparatively high overhead.	426	by sorting their keys. This is adding a comparatively high overhead.
436		427
437	If C<$enable> is false, then the C<encode> method will output key-value	428	If C<$enable> is false, then the C<encode> method will output key-value
438	pairs in the order Perl stores them (which will likely change between runs	429	pairs in the order Perl stores them (which will likely change between runs
439	of the same script).	430	of the same script, and can change even within the same run from 5.18
		431	onwards).
440		432
441	This option is useful if you want the same data structure to be encoded as	433	This option is useful if you want the same data structure to be encoded as
442	the same JSON text (given the same overall settings). If it is disabled,	434	the same JSON text (given the same overall settings). If it is disabled,
443	the same hash might be encoded differently even if contains the same data,	435	the same hash might be encoded differently even if contains the same data,
444	as key-value pairs have no inherent ordering in Perl.	436	as key-value pairs have no inherent ordering in Perl.
445		437
446	This setting has no effect when decoding JSON texts.	438	This setting has no effect when decoding JSON texts.
447		439
		440	This setting has currently no effect on tied hashes.
		441
448	=item $json = $json->allow_nonref ([$enable])	442	=item $json = $json->allow_nonref ([$enable])
449		443
450	=item $enabled = $json->get_allow_nonref	444	=item $enabled = $json->get_allow_nonref
451		445
452	If C<$enable> is true (or missing), then the C<encode> method can convert a	446	If C<$enable> is true (or missing), then the C<encode> method can convert a
…		…
463	resulting in an invalid JSON text:	457	resulting in an invalid JSON text:
464		458
465	JSON::XS->new->allow_nonref->encode ("Hello, World!")	459	JSON::XS->new->allow_nonref->encode ("Hello, World!")
466	=> "Hello, World!"	460	=> "Hello, World!"
467		461
		462	=item $json = $json->allow_unknown ([$enable])
		463
		464	=item $enabled = $json->get_allow_unknown
		465
		466	If C<$enable> is true (or missing), then C<encode> will I<not> throw an
		467	exception when it encounters values it cannot represent in JSON (for
		468	example, filehandles) but instead will encode a JSON C<null> value. Note
		469	that blessed objects are not included here and are handled separately by
		470	c<allow_nonref>.
		471
		472	If C<$enable> is false (the default), then C<encode> will throw an
		473	exception when it encounters anything it cannot encode as JSON.
		474
		475	This option does not affect C<decode> in any way, and it is recommended to
		476	leave it off unless you know your communications partner.
		477
468	=item $json = $json->allow_blessed ([$enable])	478	=item $json = $json->allow_blessed ([$enable])
469		479
470	=item $enabled = $json->get_allow_blessed	480	=item $enabled = $json->get_allow_blessed
471		481
		482	See L<OBJECT SERIALISATION> for details.
		483
472	If C<$enable> is true (or missing), then the C<encode> method will not	484	If C<$enable> is true (or missing), then the C<encode> method will not
473	barf when it encounters a blessed reference. Instead, the value of the	485	barf when it encounters a blessed reference that it cannot convert
474	B<convert_blessed> option will decide whether C<null> (C<convert_blessed>	486	otherwise. Instead, a JSON C<null> value is encoded instead of the object.
475	disabled or no C<TO_JSON> method found) or a representation of the
476	object (C<convert_blessed> enabled and C<TO_JSON> method found) is being
477	encoded. Has no effect on C<decode>.
478		487
479	If C<$enable> is false (the default), then C<encode> will throw an	488	If C<$enable> is false (the default), then C<encode> will throw an
480	exception when it encounters a blessed object.	489	exception when it encounters a blessed object that it cannot convert
		490	otherwise.
		491
		492	This setting has no effect on C<decode>.
481		493
482	=item $json = $json->convert_blessed ([$enable])	494	=item $json = $json->convert_blessed ([$enable])
483		495
484	=item $enabled = $json->get_convert_blessed	496	=item $enabled = $json->get_convert_blessed
		497
		498	See L<OBJECT SERIALISATION> for details.
485		499
486	If C<$enable> is true (or missing), then C<encode>, upon encountering a	500	If C<$enable> is true (or missing), then C<encode>, upon encountering a
487	blessed object, will check for the availability of the C<TO_JSON> method	501	blessed object, will check for the availability of the C<TO_JSON> method
488	on the object's class. If found, it will be called in scalar context	502	on the object's class. If found, it will be called in scalar context and
489	and the resulting scalar will be encoded instead of the object. If no	503	the resulting scalar will be encoded instead of the object.
490	C<TO_JSON> method is found, the value of C<allow_blessed> will decide what
491	to do.
492		504
493	The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON>	505	The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON>
494	returns other blessed objects, those will be handled in the same	506	returns other blessed objects, those will be handled in the same
495	way. C<TO_JSON> must take care of not causing an endless recursion cycle	507	way. C<TO_JSON> must take care of not causing an endless recursion cycle
496	(== crash) in this case. The name of C<TO_JSON> was chosen because other	508	(== crash) in this case. The name of C<TO_JSON> was chosen because other
497	methods called by the Perl core (== not by the user of the object) are	509	methods called by the Perl core (== not by the user of the object) are
498	usually in upper case letters and to avoid collisions with any C<to_json>	510	usually in upper case letters and to avoid collisions with any C<to_json>
499	function or method.	511	function or method.
500		512
501	This setting does not yet influence C<decode> in any way, but in the	513	If C<$enable> is false (the default), then C<encode> will not consider
502	future, global hooks might get installed that influence C<decode> and are	514	this type of conversion.
503	enabled by this setting.
504		515
505	If C<$enable> is false, then the C<allow_blessed> setting will decide what	516	This setting has no effect on C<decode>.
506	to do when a blessed object is found.	517
		518	=item $json = $json->allow_tags ([$enable])
		519
		520	=item $enabled = $json->allow_tags
		521
		522	See L<OBJECT SERIALISATION> for details.
		523
		524	If C<$enable> is true (or missing), then C<encode>, upon encountering a
		525	blessed object, will check for the availability of the C<FREEZE> method on
		526	the object's class. If found, it will be used to serialise the object into
		527	a nonstandard tagged JSON value (that JSON decoders cannot decode).
		528
		529	It also causes C<decode> to parse such tagged JSON values and deserialise
		530	them via a call to the C<THAW> method.
		531
		532	If C<$enable> is false (the default), then C<encode> will not consider
		533	this type of conversion, and tagged JSON values will cause a parse error
		534	in C<decode>, as if tags were not part of the grammar.
507		535
508	=item $json = $json->filter_json_object ([$coderef->($hashref)])	536	=item $json = $json->filter_json_object ([$coderef->($hashref)])
509		537
510	When C<$coderef> is specified, it will be called from C<decode> each	538	When C<$coderef> is specified, it will be called from C<decode> each
511	time it decodes a JSON object. The only argument is a reference to the	539	time it decodes a JSON object. The only argument is a reference to the
…		…
612	=item $json = $json->max_depth ([$maximum_nesting_depth])	640	=item $json = $json->max_depth ([$maximum_nesting_depth])
613		641
614	=item $max_depth = $json->get_max_depth	642	=item $max_depth = $json->get_max_depth
615		643
616	Sets the maximum nesting level (default C<512>) accepted while encoding	644	Sets the maximum nesting level (default C<512>) accepted while encoding
617	or decoding. If the JSON text or Perl data structure has an equal or	645	or decoding. If a higher nesting level is detected in JSON text or a Perl
618	higher nesting level then this limit, then the encoder and decoder will	646	data structure, then the encoder and decoder will stop and croak at that
619	stop and croak at that point.	647	point.
620		648
621	Nesting level is defined by number of hash- or arrayrefs that the encoder	649	Nesting level is defined by number of hash- or arrayrefs that the encoder
622	needs to traverse to reach a given point or the number of C<{> or C<[>	650	needs to traverse to reach a given point or the number of C<{> or C<[>
623	characters without their matching closing parenthesis crossed to reach a	651	characters without their matching closing parenthesis crossed to reach a
624	given character in a string.	652	given character in a string.
625		653
626	Setting the maximum depth to one disallows any nesting, so that ensures	654	Setting the maximum depth to one disallows any nesting, so that ensures
627	that the object is only a single hash/object or array.	655	that the object is only a single hash/object or array.
628		656
629	The argument to C<max_depth> will be rounded up to the next highest power
630	of two. If no argument is given, the highest possible setting will be	657	If no argument is given, the highest possible setting will be used, which
631	used, which is rarely useful.	658	is rarely useful.
		659
		660	Note that nesting is implemented by recursion in C. The default value has
		661	been chosen to be as large as typical operating systems allow without
		662	crashing.
632		663
633	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	664	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
634		665
635	=item $json = $json->max_size ([$maximum_string_size])	666	=item $json = $json->max_size ([$maximum_string_size])
636		667
637	=item $max_size = $json->get_max_size	668	=item $max_size = $json->get_max_size
638		669
639	Set the maximum length a JSON text may have (in bytes) where decoding is	670	Set the maximum length a JSON text may have (in bytes) where decoding is
640	being attempted. The default is C<0>, meaning no limit. When C<decode>	671	being attempted. The default is C<0>, meaning no limit. When C<decode>
641	is called on a string longer then this number of characters it will not	672	is called on a string that is longer then this many bytes, it will not
642	attempt to decode the string but throw an exception. This setting has no	673	attempt to decode the string but throw an exception. This setting has no
643	effect on C<encode> (yet).	674	effect on C<encode> (yet).
644		675
645	The argument to C<max_size> will be rounded up to the next B<highest>	676	If no argument is given, the limit check will be deactivated (same as when
646	power of two (so may be more than requested). If no argument is given, the	677	C<0> is specified).
647	limit check will be deactivated (same as when C<0> is specified).
648		678
649	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	679	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
650		680
651	=item $json_text = $json->encode ($perl_scalar)	681	=item $json_text = $json->encode ($perl_scalar)
652		682
653	Converts the given Perl data structure (a simple scalar or a reference	683	Converts the given Perl value or data structure to its JSON
654	to a hash or array) to its JSON representation. Simple scalars will be	684	representation. Croaks on error.
655	converted into JSON string or number sequences, while references to arrays
656	become JSON arrays and references to hashes become JSON objects. Undefined
657	Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true>
658	nor C<false> values will be generated.
659		685
660	=item $perl_scalar = $json->decode ($json_text)	686	=item $perl_scalar = $json->decode ($json_text)
661		687
662	The opposite of C<encode>: expects a JSON text and tries to parse it,	688	The opposite of C<encode>: expects a JSON text and tries to parse it,
663	returning the resulting simple scalar or reference. Croaks on error.	689	returning the resulting simple scalar or reference. Croaks on error.
664
665	JSON numbers and strings become simple Perl scalars. JSON arrays become
666	Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes
667	C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.
668		690
669	=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text)	691	=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text)
670		692
671	This works like the C<decode> method, but instead of raising an exception	693	This works like the C<decode> method, but instead of raising an exception
672	when there is trailing garbage after the first JSON object, it will	694	when there is trailing garbage after the first JSON object, it will
673	silently stop parsing there and return the number of characters consumed	695	silently stop parsing there and return the number of characters consumed
674	so far.	696	so far.
675		697
676	This is useful if your JSON texts are not delimited by an outer protocol	698	This is useful if your JSON texts are not delimited by an outer protocol
677	(which is not the brightest thing to do in the first place) and you need
678	to know where the JSON text ends.	699	and you need to know where the JSON text ends.
679		700
680	JSON::XS->new->decode_prefix ("[1] the tail")	701	JSON::XS->new->decode_prefix ("[1] the tail")
681	=> ([], 3)	702	=> ([1], 3)
682		703
683	=back	704	=back
684		705
685		706
686	=head1 INCREMENTAL PARSING	707	=head1 INCREMENTAL PARSING
687
688	[This section is still EXPERIMENTAL]
689		708
690	In some cases, there is the need for incremental parsing of JSON	709	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	710	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	711	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	712	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	713	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	714	using C<decode_prefix> to see if a full JSON object is available, but
696	much more efficient (JSON::XS will only attempt to parse the JSON text	715	is much more efficient (and can be implemented with a minimum of method
		716	calls).
		717
		718	JSON::XS will only attempt to parse the JSON text once it is sure it
697	once it is sure it has enough text to get a decisive result, using a very	719	has enough text to get a decisive result, using a very simple but
698	simple but truly incremental parser).	720	truly incremental parser. This means that it sometimes won't stop as
		721	early as the full parser, for example, it doesn't detect mismatched
		722	parentheses. The only thing it guarantees is that it starts decoding as
		723	soon as a syntactically valid JSON text has been seen. This means you need
		724	to set resource limits (e.g. C<max_size>) to ensure the parser will stop
		725	parsing in the presence if syntax errors.
699		726
700	The following two methods deal with this.	727	The following methods implement this incremental parser.
701		728
702	=over 4	729	=over 4
703		730
704	=item [void, scalar or list context] = $json->incr_parse ([$string])	731	=item [void, scalar or list context] = $json->incr_parse ([$string])
705		732
…		…
714	return without doing anything further. This can be used to add more text	741	return without doing anything further. This can be used to add more text
715	in as many chunks as you want.	742	in as many chunks as you want.
716		743
717	If the method is called in scalar context, then it will try to extract	744	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	745	exactly I<one> JSON object. If that is successful, it will return this
719	object, otherwise it will return C<undef>. This is the most common way of	746	object, otherwise it will return C<undef>. If there is a parse error,
		747	this method will croak just as C<decode> would do (one can then use
		748	C<incr_skip> to skip the erroneous part). This is the most common way of
720	using the method.	749	using the method.
721		750
722	And finally, in list context, it will try to extract as many objects	751	And finally, in list context, it will try to extract as many objects
723	from the stream as it can find and return them, or the empty list	752	from the stream as it can find and return them, or the empty list
724	otherwise. For this to work, there must be no separators between the JSON	753	otherwise. For this to work, there must be no separators (other than
725	objects or arrays, instead they must be concatenated back-to-back.	754	whitespace) between the JSON objects or arrays, instead they must be
		755	concatenated back-to-back. If an error occurs, an exception will be
		756	raised as in the scalar context case. Note that in this case, any
		757	previously-parsed JSON texts will be lost.
		758
		759	Example: Parse some JSON arrays/objects in a given string and return
		760	them.
		761
		762	my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
726		763
727	=item $lvalue_string = $json->incr_text	764	=item $lvalue_string = $json->incr_text
728		765
729	This method returns the currently stored JSON fragment as an lvalue, that	766	This method returns the currently stored JSON fragment as an lvalue, that
730	is, you can manipulate it. This I<only> works when a preceding call to	767	is, you can manipulate it. This I<only> works when a preceding call to
…		…
732	all other circumstances you must not call this function (I mean it.	769	all other circumstances you must not call this function (I mean it.
733	although in simple tests it might actually work, it I<will> fail under	770	although in simple tests it might actually work, it I<will> fail under
734	real world conditions). As a special exception, you can also call this	771	real world conditions). As a special exception, you can also call this
735	method before having parsed anything.	772	method before having parsed anything.
736		773
		774	That means you can only use this function to look at or manipulate text
		775	before or after complete JSON objects, not while the parser is in the
		776	middle of parsing a JSON object.
		777
737	This function is useful in two cases: a) finding the trailing text after a	778	This function is useful in two cases: a) finding the trailing text after a
738	JSON object or b) parsing multiple JSON objects separated by non-JSON text	779	JSON object or b) parsing multiple JSON objects separated by non-JSON text
739	(such as commas).	780	(such as commas).
740		781
		782	=item $json->incr_skip
		783
		784	This will reset the state of the incremental parser and will remove
		785	the parsed text from the input buffer so far. This is useful after
		786	C<incr_parse> died, in which case the input buffer and incremental parser
		787	state is left unchanged, to skip the text parsed so far and to reset the
		788	parse state.
		789
		790	The difference to C<incr_reset> is that only text until the parse error
		791	occurred is removed.
		792
		793	=item $json->incr_reset
		794
		795	This completely resets the incremental parser, that is, after this call,
		796	it will be as if the parser had never parsed anything.
		797
		798	This is useful if you want to repeatedly parse JSON objects and want to
		799	ignore any trailing data, which means you have to reset the parser after
		800	each successful decode.
		801
741	=back	802	=back
742		803
743	=head2 LIMITATIONS	804	=head2 LIMITATIONS
744		805
745	All options that affect decoding are supported, except	806	All options that affect decoding are supported, except
746	C<allow_nonref>. The reason for this is that it cannot be made to	807	C<allow_nonref>. The reason for this is that it cannot be made to work
747	work sensibly: JSON objects and arrays are self-delimited, i.e. you can concatenate	808	sensibly: JSON objects and arrays are self-delimited, i.e. you can
748	them back to back and still decode them perfectly. This does not hold true	809	concatenate them back to back and still decode them perfectly. This does
749	for JSON numbers, however.	810	not hold true for JSON numbers, however.
750		811
751	For example, is the string C<1> a single JSON number, or is it simply the	812	For example, is the string C<1> a single JSON number, or is it simply the
752	start of C<12>? Or is C<12> a single JSON number, or the concatenation	813	start of C<12>? Or is C<12> a single JSON number, or the concatenation
753	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS	814	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS
754	takes the conservative route and disallows this case.	815	takes the conservative route and disallows this case.
…		…
933	If the number consists of digits only, JSON::XS will try to represent	994	If the number consists of digits only, JSON::XS will try to represent
934	it as an integer value. If that fails, it will try to represent it as	995	it as an integer value. If that fails, it will try to represent it as
935	a numeric (floating point) value if that is possible without loss of	996	a numeric (floating point) value if that is possible without loss of
936	precision. Otherwise it will preserve the number as a string value (in	997	precision. Otherwise it will preserve the number as a string value (in
937	which case you lose roundtripping ability, as the JSON number will be	998	which case you lose roundtripping ability, as the JSON number will be
938	re-encoded toa JSON string).	999	re-encoded to a JSON string).
939		1000
940	Numbers containing a fractional or exponential part will always be	1001	Numbers containing a fractional or exponential part will always be
941	represented as numeric (floating point) values, possibly at a loss of	1002	represented as numeric (floating point) values, possibly at a loss of
942	precision (in which case you might lose perfect roundtripping ability, but	1003	precision (in which case you might lose perfect roundtripping ability, but
943	the JSON number will still be re-encoded as a JSON number).	1004	the JSON number will still be re-encoded as a JSON number).
944		1005
		1006	Note that precision is not accuracy - binary floating point values cannot
		1007	represent most decimal fractions exactly, and when converting from and to
		1008	floating point, JSON::XS only guarantees precision up to but not including
		1009	the least significant bit.
		1010
945	=item true, false	1011	=item true, false
946		1012
947	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,	1013	These JSON atoms become C<Types::Serialiser::true> and
948	respectively. They are overloaded to act almost exactly like the numbers	1014	C<Types::Serialiser::false>, respectively. They are overloaded to act
949	C<1> and C<0>. You can check whether a scalar is a JSON boolean by using	1015	almost exactly like the numbers C<1> and C<0>. You can check whether
950	the C<JSON::XS::is_bool> function.	1016	a scalar is a JSON boolean by using the C<Types::Serialiser::is_bool>
		1017	function (after C<use Types::Serialier>, of course).
951		1018
952	=item null	1019	=item null
953		1020
954	A JSON null atom becomes C<undef> in Perl.	1021	A JSON null atom becomes C<undef> in Perl.
		1022
		1023	=item shell-style comments (C<< # I<text> >>)
		1024
		1025	As a nonstandard extension to the JSON syntax that is enabled by the
		1026	C<relaxed> setting, shell-style comments are allowed. They can start
		1027	anywhere outside strings and go till the end of the line.
		1028
		1029	=item tagged values (C<< (I<tag>)I<value> >>).
		1030
		1031	Another nonstandard extension to the JSON syntax, enabled with the
		1032	C<allow_tags> setting, are tagged values. In this implementation, the
		1033	I<tag> must be a perl package/class name encoded as a JSON string, and the
		1034	I<value> must be a JSON array encoding optional constructor arguments.
		1035
		1036	See L<OBJECT SERIALISATION>, below, for details.
955		1037
956	=back	1038	=back
957		1039
958		1040
959	=head2 PERL -> JSON	1041	=head2 PERL -> JSON
…		…
964		1046
965	=over 4	1047	=over 4
966		1048
967	=item hash references	1049	=item hash references
968		1050
969	Perl hash references become JSON objects. As there is no inherent ordering	1051	Perl hash references become JSON objects. As there is no inherent
970	in hash keys (or JSON objects), they will usually be encoded in a	1052	ordering in hash keys (or JSON objects), they will usually be encoded
971	pseudo-random order that can change between runs of the same program but	1053	in a pseudo-random order. JSON::XS can optionally sort the hash keys
972	stays generally the same within a single run of a program. JSON::XS can	1054	(determined by the I<canonical> flag), so the same datastructure will
973	optionally sort the hash keys (determined by the I<canonical> flag), so	1055	serialise to the same JSON text (given same settings and version of
974	the same datastructure will serialise to the same JSON text (given same	1056	JSON::XS), but this incurs a runtime overhead and is only rarely useful,
975	settings and version of JSON::XS), but this incurs a runtime overhead	1057	e.g. when you want to compare some JSON text against another for equality.
976	and is only rarely useful, e.g. when you want to compare some JSON text
977	against another for equality.
978		1058
979	=item array references	1059	=item array references
980		1060
981	Perl array references become JSON arrays.	1061	Perl array references become JSON arrays.
982		1062
983	=item other references	1063	=item other references
984		1064
985	Other unblessed references are generally not allowed and will cause an	1065	Other unblessed references are generally not allowed and will cause an
986	exception to be thrown, except for references to the integers C<0> and	1066	exception to be thrown, except for references to the integers C<0> and
987	C<1>, which get turned into C<false> and C<true> atoms in JSON. You can	1067	C<1>, which get turned into C<false> and C<true> atoms in JSON.
988	also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
989		1068
		1069	Since C<JSON::XS> uses the boolean model from L<Types::Serialiser>, you
		1070	can also C<use Types::Serialiser> and then use C<Types::Serialiser::false>
		1071	and C<Types::Serialiser::true> to improve readability.
		1072
		1073	use Types::Serialiser;
990	encode_json [\0,JSON::XS::true] # yields [false,true]	1074	encode_json [\0, Types::Serialiser::true] # yields [false,true]
991		1075
992	=item JSON::XS::true, JSON::XS::false	1076	=item Types::Serialiser::true, Types::Serialiser::false
993		1077
994	These special values become JSON true and JSON false values,	1078	These special values from the L<Types::Serialiser> module become JSON true
995	respectively. You can also use C<\1> and C<\0> directly if you want.	1079	and JSON false values, respectively. You can also use C<\1> and C<\0>
		1080	directly if you want.
996		1081
997	=item blessed objects	1082	=item blessed objects
998		1083
999	Blessed objects are not directly representable in JSON. See the	1084	Blessed objects are not directly representable in JSON, but C<JSON::XS>
1000	C<allow_blessed> and C<convert_blessed> methods on various options on	1085	allows various ways of handling objects. See L<OBJECT SERIALISATION>,
1001	how to deal with this: basically, you can choose between throwing an	1086	below, for details.
1002	exception, encoding the reference as if it weren't blessed, or provide
1003	your own serialiser method.
1004		1087
1005	=item simple scalars	1088	=item simple scalars
1006		1089
1007	Simple Perl scalars (any scalar that is not a reference) are the most	1090	Simple Perl scalars (any scalar that is not a reference) are the most
1008	difficult objects to encode: JSON::XS will encode undefined scalars as	1091	difficult objects to encode: JSON::XS will encode undefined scalars as
…		…
1036		1119
1037	You can not currently force the type in other, less obscure, ways. Tell me	1120	You can not currently force the type in other, less obscure, ways. Tell me
1038	if you need this capability (but don't forget to explain why it's needed	1121	if you need this capability (but don't forget to explain why it's needed
1039	:).	1122	:).
1040		1123
		1124	Note that numerical precision has the same meaning as under Perl (so
		1125	binary to decimal conversion follows the same rules as in Perl, which
		1126	can differ to other languages). Also, your perl interpreter might expose
		1127	extensions to the floating point numbers of your platform, such as
		1128	infinities or NaN's - these cannot be represented in JSON, and it is an
		1129	error to pass those in.
		1130
1041	=back	1131	=back
		1132
		1133	=head2 OBJECT SERIALISATION
		1134
		1135	As JSON cannot directly represent Perl objects, you have to choose between
		1136	a pure JSON representation (without the ability to deserialise the object
		1137	automatically again), and a nonstandard extension to the JSON syntax,
		1138	tagged values.
		1139
		1140	=head3 SERIALISATION
		1141
		1142	What happens when C<JSON::XS> encounters a Perl object depends on the
		1143	C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are
		1144	used in this order:
		1145
		1146	=over 4
		1147
		1148	=item 1. C<allow_tags> is enabled and the object has a C<FREEZE> method.
		1149
		1150	In this case, C<JSON::XS> uses the L<Types::Serialiser> object
		1151	serialisation protocol to create a tagged JSON value, using a nonstandard
		1152	extension to the JSON syntax.
		1153
		1154	This works by invoking the C<FREEZE> method on the object, with the first
		1155	argument being the object to serialise, and the second argument being the
		1156	constant string C<JSON> to distinguish it from other serialisers.
		1157
		1158	The C<FREEZE> method can return any number of values (i.e. zero or
		1159	more). These values and the paclkage/classname of the object will then be
		1160	encoded as a tagged JSON value in the following format:
		1161
		1162	("classname")[FREEZE return values...]
		1163
		1164	e.g.:
		1165
		1166	("URI")["http://www.google.com/"]
		1167	("MyDate")[2013,10,29]
		1168	("ImageData::JPEG")["Z3...VlCg=="]
		1169
		1170	For example, the hypothetical C<My::Object> C<FREEZE> method might use the
		1171	objects C<type> and C<id> members to encode the object:
		1172
		1173	sub My::Object::FREEZE {
		1174	my ($self, $serialiser) = @_;
		1175
		1176	($self->{type}, $self->{id})
		1177	}
		1178
		1179	=item 2. C<convert_blessed> is enabled and the object has a C<TO_JSON> method.
		1180
		1181	In this case, the C<TO_JSON> method of the object is invoked in scalar
		1182	context. It must return a single scalar that can be directly encoded into
		1183	JSON. This scalar replaces the object in the JSON text.
		1184
		1185	For example, the following C<TO_JSON> method will convert all L<URI>
		1186	objects to JSON strings when serialised. The fatc that these values
		1187	originally were L<URI> objects is lost.
		1188
		1189	sub URI::TO_JSON {
		1190	my ($uri) = @_;
		1191	$uri->as_string
		1192	}
		1193
		1194	=item 3. C<allow_blessed> is enabled.
		1195
		1196	The object will be serialised as a JSON null value.
		1197
		1198	=item 4. none of the above
		1199
		1200	If none of the settings are enabled or the respective methods are missing,
		1201	C<JSON::XS> throws an exception.
		1202
		1203	=back
		1204
		1205	=head3 DESERIALISATION
		1206
		1207	For deserialisation there are only two cases to consider: either
		1208	nonstandard tagging was used, in which case C<allow_tags> decides,
		1209	or objects cannot be automatically be deserialised, in which
		1210	case you can use postprocessing or the C<filter_json_object> or
		1211	C<filter_json_single_key_object> callbacks to get some real objects our of
		1212	your JSON.
		1213
		1214	This section only considers the tagged value case: I a tagged JSON object
		1215	is encountered during decoding and C<allow_tags> is disabled, a parse
		1216	error will result (as if tagged values were not part of the grammar).
		1217
		1218	If C<allow_tags> is enabled, C<JSON::XS> will look up the C<THAW> method
		1219	of the package/classname used during serialisation (it will not attempt
		1220	to load the package as a Perl module). If there is no such method, the
		1221	decoding will fail with an error.
		1222
		1223	Otherwise, the C<THAW> method is invoked with the classname as first
		1224	argument, the constant string C<JSON> as second argument, and all the
		1225	values from the JSON array (the values originally returned by the
		1226	C<FREEZE> method) as remaining arguments.
		1227
		1228	The method must then return the object. While technically you can return
		1229	any Perl scalar, you might have to enable the C<enable_nonref> setting to
		1230	make that work in all cases, so better return an actual blessed reference.
		1231
		1232	As an example, let's implement a C<THAW> function that regenerates the
		1233	C<My::Object> from the C<FREEZE> example earlier:
		1234
		1235	sub My::Object::THAW {
		1236	my ($class, $serialiser, $type, $id) = @_;
		1237
		1238	$class->new (type => $type, id => $id)
		1239	}
1042		1240
1043		1241
1044	=head1 ENCODING/CODESET FLAG NOTES	1242	=head1 ENCODING/CODESET FLAG NOTES
1045		1243
1046	The interested reader might have seen a number of flags that signify	1244	The interested reader might have seen a number of flags that signify
…		…
1071	=item C<utf8> flag disabled	1269	=item C<utf8> flag disabled
1072		1270
1073	When C<utf8> is disabled (the default), then C<encode>/C<decode> generate	1271	When C<utf8> is disabled (the default), then C<encode>/C<decode> generate
1074	and expect Unicode strings, that is, characters with high ordinal Unicode	1272	and expect Unicode strings, that is, characters with high ordinal Unicode
1075	values (> 255) will be encoded as such characters, and likewise such	1273	values (> 255) will be encoded as such characters, and likewise such
1076	characters are decoded as-is, no canges to them will be done, except	1274	characters are decoded as-is, no changes to them will be done, except
1077	"(re-)interpreting" them as Unicode codepoints or Unicode characters,	1275	"(re-)interpreting" them as Unicode codepoints or Unicode characters,
1078	respectively (to Perl, these are the same thing in strings unless you do	1276	respectively (to Perl, these are the same thing in strings unless you do
1079	funny/weird/dumb stuff).	1277	funny/weird/dumb stuff).
1080		1278
1081	This is useful when you want to do the encoding yourself (e.g. when you	1279	This is useful when you want to do the encoding yourself (e.g. when you
…		…
1137	proper subset of most 8-bit and multibyte encodings in use in the world.	1335	proper subset of most 8-bit and multibyte encodings in use in the world.
1138		1336
1139	=back	1337	=back
1140		1338
1141		1339
1142	=head1 COMPARISON	1340	=head2 JSON and ECMAscript
1143		1341
1144	As already mentioned, this module was created because none of the existing	1342	JSON syntax is based on how literals are represented in javascript (the
1145	JSON modules could be made to work correctly. First I will describe the	1343	not-standardised predecessor of ECMAscript) which is presumably why it is
1146	problems (or pleasures) I encountered with various existing JSON modules,	1344	called "JavaScript Object Notation".
1147	followed by some benchmark values. JSON::XS was designed not to suffer
1148	from any of these problems or limitations.
1149		1345
1150	=over 4	1346	However, JSON is not a subset (and also not a superset of course) of
		1347	ECMAscript (the standard) or javascript (whatever browsers actually
		1348	implement).
1151		1349
1152	=item JSON 2.xx	1350	If you want to use javascript's C<eval> function to "parse" JSON, you
		1351	might run into parse errors for valid JSON texts, or the resulting data
		1352	structure might not be queryable:
1153		1353
1154	A marvellous piece of engineering, this module either uses JSON::XS	1354	One of the problems is that U+2028 and U+2029 are valid characters inside
1155	directly when available (so will be 100% compatible with it, including	1355	JSON strings, but are not allowed in ECMAscript string literals, so the
1156	speed), or it uses JSON::PP, which is basically JSON::XS translated to	1356	following Perl fragment will not output something that can be guaranteed
1157	Pure Perl, which should be 100% compatible with JSON::XS, just a bit	1357	to be parsable by javascript's C<eval>:
1158	slower.
1159		1358
1160	You cannot really lose by using this module, especially as it tries very	1359	use JSON::XS;
1161	hard to work even with ancient Perl versions, while JSON::XS does not.
1162		1360
1163	=item JSON 1.07	1361	print encode_json [chr 0x2028];
1164		1362
1165	Slow (but very portable, as it is written in pure Perl).	1363	The right fix for this is to use a proper JSON parser in your javascript
		1364	programs, and not rely on C<eval> (see for example Douglas Crockford's
		1365	F<json2.js> parser).
1166		1366
1167	Undocumented/buggy Unicode handling (how JSON handles Unicode values is	1367	If this is not an option, you can, as a stop-gap measure, simply encode to
1168	undocumented. One can get far by feeding it Unicode strings and doing	1368	ASCII-only JSON:
1169	en-/decoding oneself, but Unicode escapes are not working properly).
1170		1369
1171	No round-tripping (strings get clobbered if they look like numbers, e.g.	1370	use JSON::XS;
1172	the string C<2.0> will encode to C<2.0> instead of C<"2.0">, and that will
1173	decode into the number 2.
1174		1371
1175	=item JSON::PC 0.01	1372	print JSON::XS->new->ascii->encode ([chr 0x2028]);
1176		1373
1177	Very fast.	1374	Note that this will enlarge the resulting JSON text quite a bit if you
		1375	have many non-ASCII characters. You might be tempted to run some regexes
		1376	to only escape U+2028 and U+2029, e.g.:
1178		1377
1179	Undocumented/buggy Unicode handling.	1378	# DO NOT USE THIS!
		1379	my $json = JSON::XS->new->utf8->encode ([chr 0x2028]);
		1380	$json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028
		1381	$json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029
		1382	print $json;
1180		1383
1181	No round-tripping.	1384	Note that I<this is a bad idea>: the above only works for U+2028 and
		1385	U+2029 and thus only for fully ECMAscript-compliant parsers. Many existing
		1386	javascript implementations, however, have issues with other characters as
		1387	well - using C<eval> naively simply I<will> cause problems.
1182		1388
1183	Has problems handling many Perl values (e.g. regex results and other magic	1389	Another problem is that some javascript implementations reserve
1184	values will make it croak).	1390	some property names for their own purposes (which probably makes
		1391	them non-ECMAscript-compliant). For example, Iceweasel reserves the
		1392	C<__proto__> property name for its own purposes.
1185		1393
1186	Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}>	1394	If that is a problem, you could parse try to filter the resulting JSON
1187	which is not a valid JSON text.	1395	output for these property strings, e.g.:
1188		1396
1189	Unmaintained (maintainer unresponsive for many months, bugs are not	1397	$json =~ s/"__proto__"\s*:/"__proto__renamed":/g;
1190	getting fixed).
1191		1398
1192	=item JSON::Syck 0.21	1399	This works because C<__proto__> is not valid outside of strings, so every
		1400	occurrence of C<"__proto__"\s*:> must be a string used as property name.
1193		1401
1194	Very buggy (often crashes).	1402	If you know of other incompatibilities, please let me know.
1195
1196	Very inflexible (no human-readable format supported, format pretty much
1197	undocumented. I need at least a format for easy reading by humans and a
1198	single-line compact format for use in a protocol, and preferably a way to
1199	generate ASCII-only JSON texts).
1200
1201	Completely broken (and confusingly documented) Unicode handling (Unicode
1202	escapes are not working properly, you need to set ImplicitUnicode to
1203	I<different> values on en- and decoding to get symmetric behaviour).
1204
1205	No round-tripping (simple cases work, but this depends on whether the scalar
1206	value was used in a numeric context or not).
1207
1208	Dumping hashes may skip hash values depending on iterator state.
1209
1210	Unmaintained (maintainer unresponsive for many months, bugs are not
1211	getting fixed).
1212
1213	Does not check input for validity (i.e. will accept non-JSON input and
1214	return "something" instead of raising an exception. This is a security
1215	issue: imagine two banks transferring money between each other using
1216	JSON. One bank might parse a given non-JSON request and deduct money,
1217	while the other might reject the transaction with a syntax error. While a
1218	good protocol will at least recover, that is extra unnecessary work and
1219	the transaction will still not succeed).
1220
1221	=item JSON::DWIW 0.04
1222
1223	Very fast. Very natural. Very nice.
1224
1225	Undocumented Unicode handling (but the best of the pack. Unicode escapes
1226	still don't get parsed properly).
1227
1228	Very inflexible.
1229
1230	No round-tripping.
1231
1232	Does not generate valid JSON texts (key strings are often unquoted, empty keys
1233	result in nothing being output)
1234
1235	Does not check input for validity.
1236
1237	=back
1238		1403
1239		1404
1240	=head2 JSON and YAML	1405	=head2 JSON and YAML
1241		1406
1242	You often hear that JSON is a subset of YAML. This is, however, a mass	1407	You often hear that JSON is a subset of YAML. This is, however, a mass
…		…
1252	my $yaml = $to_yaml->encode ($ref) . "\n";	1417	my $yaml = $to_yaml->encode ($ref) . "\n";
1253		1418
1254	This will I<usually> generate JSON texts that also parse as valid	1419	This will I<usually> generate JSON texts that also parse as valid
1255	YAML. Please note that YAML has hardcoded limits on (simple) object key	1420	YAML. Please note that YAML has hardcoded limits on (simple) object key
1256	lengths that JSON doesn't have and also has different and incompatible	1421	lengths that JSON doesn't have and also has different and incompatible
1257	unicode handling, so you should make sure that your hash keys are	1422	unicode character escape syntax, so you should make sure that your hash
1258	noticeably shorter than the 1024 "stream characters" YAML allows and that	1423	keys are noticeably shorter than the 1024 "stream characters" YAML allows
1259	you do not have characters with codepoint values outside the Unicode BMP	1424	and that you do not have characters with codepoint values outside the
1260	(basic multilingual page). YAML also does not allow C<\/> sequences in	1425	Unicode BMP (basic multilingual page). YAML also does not allow C<\/>
1261	strings (which JSON::XS does not I<currently> generate, but other JSON	1426	sequences in strings (which JSON::XS does not I<currently> generate, but
1262	generators might).	1427	other JSON generators might).
1263		1428
1264	There might be other incompatibilities that I am not aware of (or the YAML	1429	There might be other incompatibilities that I am not aware of (or the YAML
1265	specification has been changed yet again - it does so quite often). In	1430	specification has been changed yet again - it does so quite often). In
1266	general you should not try to generate YAML with a JSON generator or vice	1431	general you should not try to generate YAML with a JSON generator or vice
1267	versa, or try to parse JSON with a YAML parser or vice versa: chances are	1432	versa, or try to parse JSON with a YAML parser or vice versa: chances are
…		…
1286	that difficult or long) and finally make YAML compatible to it, and	1451	that difficult or long) and finally make YAML compatible to it, and
1287	educating users about the changes, instead of spreading lies about the	1452	educating users about the changes, instead of spreading lies about the
1288	real compatibility for many I<years> and trying to silence people who	1453	real compatibility for many I<years> and trying to silence people who
1289	point out that it isn't true.	1454	point out that it isn't true.
1290		1455
		1456	Addendum/2009: the YAML 1.2 spec is still incompatible with JSON, even
		1457	though the incompatibilities have been documented (and are known to Brian)
		1458	for many years and the spec makes explicit claims that YAML is a superset
		1459	of JSON. It would be so easy to fix, but apparently, bullying people and
		1460	corrupting userdata is so much easier.
		1461
1291	=back	1462	=back
1292		1463
1293		1464
1294	=head2 SPEED	1465	=head2 SPEED
1295		1466
…		…
1300		1471
1301	First comes a comparison between various modules using	1472	First comes a comparison between various modules using
1302	a very short single-line JSON string (also available at	1473	a very short single-line JSON string (also available at
1303	L<http://dist.schmorp.de/misc/json/short.json>).	1474	L<http://dist.schmorp.de/misc/json/short.json>).
1304		1475
1305	{"method": "handleMessage", "params": ["user1", "we were just talking"], \	1476	{"method": "handleMessage", "params": ["user1",
1306	"id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}	1477	"we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
		1478	1, 0]}
1307		1479
1308	It shows the number of encodes/decodes per second (JSON::XS uses	1480	It shows the number of encodes/decodes per second (JSON::XS uses
1309	the functional interface, while JSON::XS/2 uses the OO interface	1481	the functional interface, while JSON::XS/2 uses the OO interface
1310	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables	1482	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
1311	shrink). Higher is better:	1483	shrink. JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ
		1484	uses the from_json method). Higher is better:
1312		1485
1313	module \| encode \| decode \|	1486	module \| encode \| decode \|
1314	-----------\|------------\|------------\|	1487	--------------\|------------\|------------\|
1315	JSON 1.x \| 4990.842 \| 4088.813 \|	1488	JSON::DWIW/DS \| 86302.551 \| 102300.098 \|
1316	JSON::DWIW \| 51653.990 \| 71575.154 \|	1489	JSON::DWIW/FJ \| 86302.551 \| 75983.768 \|
1317	JSON::PC \| 65948.176 \| 74631.744 \|	1490	JSON::PP \| 15827.562 \| 6638.658 \|
1318	JSON::PP \| 8931.652 \| 3817.168 \|	1491	JSON::Syck \| 63358.066 \| 47662.545 \|
1319	JSON::Syck \| 24877.248 \| 27776.848 \|	1492	JSON::XS \| 511500.488 \| 511500.488 \|
1320	JSON::XS \| 388361.481 \| 227951.304 \|	1493	JSON::XS/2 \| 291271.111 \| 388361.481 \|
1321	JSON::XS/2 \| 227951.304 \| 218453.333 \|	1494	JSON::XS/3 \| 361577.931 \| 361577.931 \|
1322	JSON::XS/3 \| 338250.323 \| 218453.333 \|	1495	Storable \| 66788.280 \| 265462.278 \|
1323	Storable \| 16500.016 \| 135300.129 \|
1324	-----------+------------+------------+	1496	--------------+------------+------------+
1325		1497
1326	That is, JSON::XS is about five times faster than JSON::DWIW on encoding,	1498	That is, JSON::XS is almost six times faster than JSON::DWIW on encoding,
1327	about three times faster on decoding, and over forty times faster	1499	about five times faster on decoding, and over thirty to seventy times
1328	than JSON, even with pretty-printing and key sorting. It also compares	1500	faster than JSON's pure perl implementation. It also compares favourably
1329	favourably to Storable for small amounts of data.	1501	to Storable for small amounts of data.
1330		1502
1331	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	1503	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
1332	search API (L<http://dist.schmorp.de/misc/json/long.json>).	1504	search API (L<http://dist.schmorp.de/misc/json/long.json>).
1333		1505
1334	module \| encode \| decode \|	1506	module \| encode \| decode \|
1335	-----------\|------------\|------------\|	1507	--------------\|------------\|------------\|
1336	JSON 1.x \| 55.260 \| 34.971 \|	1508	JSON::DWIW/DS \| 1647.927 \| 2673.916 \|
1337	JSON::DWIW \| 825.228 \| 1082.513 \|	1509	JSON::DWIW/FJ \| 1630.249 \| 2596.128 \|
1338	JSON::PC \| 3571.444 \| 2394.829 \|
1339	JSON::PP \| 210.987 \| 32.574 \|	1510	JSON::PP \| 400.640 \| 62.311 \|
1340	JSON::Syck \| 552.551 \| 787.544 \|	1511	JSON::Syck \| 1481.040 \| 1524.869 \|
1341	JSON::XS \| 5780.463 \| 4854.519 \|	1512	JSON::XS \| 20661.596 \| 9541.183 \|
1342	JSON::XS/2 \| 3869.998 \| 4798.975 \|	1513	JSON::XS/2 \| 10683.403 \| 9416.938 \|
1343	JSON::XS/3 \| 5862.880 \| 4798.975 \|	1514	JSON::XS/3 \| 20661.596 \| 9400.054 \|
1344	Storable \| 4445.002 \| 5235.027 \|	1515	Storable \| 19765.806 \| 10000.725 \|
1345	-----------+------------+------------+	1516	--------------+------------+------------+
1346		1517
1347	Again, JSON::XS leads by far (except for Storable which non-surprisingly	1518	Again, JSON::XS leads by far (except for Storable which non-surprisingly
1348	decodes faster).	1519	decodes a bit faster).
1349		1520
1350	On large strings containing lots of high Unicode characters, some modules	1521	On large strings containing lots of high Unicode characters, some modules
1351	(such as JSON::PC) seem to decode faster than JSON::XS, but the result	1522	(such as JSON::PC) seem to decode faster than JSON::XS, but the result
1352	will be broken due to missing (or wrong) Unicode handling. Others refuse	1523	will be broken due to missing (or wrong) Unicode handling. Others refuse
1353	to decode or encode properly, so it was impossible to prepare a fair	1524	to decode or encode properly, so it was impossible to prepare a fair
…		…
1389	information you might want to make sure that exceptions thrown by JSON::XS	1560	information you might want to make sure that exceptions thrown by JSON::XS
1390	will not end up in front of untrusted eyes.	1561	will not end up in front of untrusted eyes.
1391		1562
1392	If you are using JSON::XS to return packets to consumption	1563	If you are using JSON::XS to return packets to consumption
1393	by JavaScript scripts in a browser you should have a look at	1564	by JavaScript scripts in a browser you should have a look at
1394	L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether	1565	L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to
1395	you are vulnerable to some common attack vectors (which really are browser	1566	see whether you are vulnerable to some common attack vectors (which really
1396	design bugs, but it is still you who will have to deal with it, as major	1567	are browser design bugs, but it is still you who will have to deal with
1397	browser developers care only for features, not about getting security	1568	it, as major browser developers care only for features, not about getting
1398	right).	1569	security right).
		1570
		1571
		1572	=head1 "OLD" VS. "NEW" JSON (RFC 4627 VS. RFC 7159)
		1573
		1574	TL;DR: Due to security concerns, JSON::XS will not allow scalar data in
		1575	JSON texts by default - you need to create your own JSON::XS object and
		1576	enable C<allow_nonref>:
		1577
		1578
		1579	my $json = JSON::XS->new->allow_nonref;
		1580
		1581	$text = $json->encode ($data);
		1582	$data = $json->decode ($text);
		1583
		1584	The long version: JSON being an important and supposedly stable format,
		1585	the IETF standardised it as RFC 4627 in 2006. Unfortunately, the inventor
		1586	of JSON, Dougles Crockford, unilaterally changed the definition of JSON in
		1587	javascript. Rather than create a fork, the IETF decided to standardise the
		1588	new syntax (apparently, so Iw as told, without finding it very amusing).
		1589
		1590	The biggest difference between thed original JSON and the new JSON is that
		1591	the new JSON supports scalars (anything other than arrays and objects) at
		1592	the toplevel of a JSON text. While this is strictly backwards compatible
		1593	to older versions, it breaks a number of protocols that relied on sending
		1594	JSON back-to-back, and is a minor security concern.
		1595
		1596	For example, imagine you have two banks communicating, and on one side,
		1597	trhe JSON coder gets upgraded. Two messages, such as C<10> and C<1000>
		1598	might then be confused to mean C<101000>, something that couldn't happen
		1599	in the original JSON, because niether of these messages would be valid
		1600	JSON.
		1601
		1602	If one side accepts these messages, then an upgrade in the coder on either
		1603	side could result in this becoming exploitable.
		1604
		1605	This module has always allowed these messages as an optional extension, by
		1606	default disabled. The security concerns are the reason why the default is
		1607	still disabled, but future versions might/will likely upgrade to the newer
		1608	RFC as default format, so you are advised to check your implementation
		1609	and/or override the default with C<< ->allow_nonref (0) >> to ensure that
		1610	future versions are safe.
		1611
		1612
		1613	=head1 INTEROPERABILITY WITH OTHER MODULES
		1614
		1615	C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean
		1616	constants. That means that the JSON true and false values will be
		1617	comaptible to true and false values of other modules that do the same,
		1618	such as L<JSON::PP> and L<CBOR::XS>.
		1619
		1620
		1621	=head1 INTEROPERABILITY WITH OTHER JSON DECODERS
		1622
		1623	As long as you only serialise data that can be directly expressed in JSON,
		1624	C<JSON::XS> is incapable of generating invalid JSON output (modulo bugs,
		1625	but C<JSON::XS> has found more bugs in the official JSON testsuite (1)
		1626	than the official JSON testsuite has found in C<JSON::XS> (0)).
		1627
		1628	When you have trouble decoding JSON generated by this module using other
		1629	decoders, then it is very likely that you have an encoding mismatch or the
		1630	other decoder is broken.
		1631
		1632	When decoding, C<JSON::XS> is strict by default and will likely catch all
		1633	errors. There are currently two settings that change this: C<relaxed>
		1634	makes C<JSON::XS> accept (but not generate) some non-standard extensions,
		1635	and C<allow_tags> will allow you to encode and decode Perl objects, at the
		1636	cost of not outputting valid JSON anymore.
		1637
		1638	=head2 TAGGED VALUE SYNTAX AND STANDARD JSON EN/DECODERS
		1639
		1640	When you use C<allow_tags> to use the extended (and also nonstandard and
		1641	invalid) JSON syntax for serialised objects, and you still want to decode
		1642	the generated When you want to serialise objects, you can run a regex
		1643	to replace the tagged syntax by standard JSON arrays (it only works for
		1644	"normal" package names without comma, newlines or single colons). First,
		1645	the readable Perl version:
		1646
		1647	# if your FREEZE methods return no values, you need this replace first:
		1648	$json =~ s/$ \s* (" (?: [^\\":,]+\|\\.\|::)* ") \s* $ \s* \[\s*\]/[$1]/gx;
		1649
		1650	# this works for non-empty constructor arg lists:
		1651	$json =~ s/$ \s* (" (?: [^\\":,]+\|\\.\|::)* ") \s* $ \s* \[/[$1,/gx;
		1652
		1653	And here is a less readable version that is easy to adapt to other
		1654	languages:
		1655
		1656	$json =~ s/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/[$1,/g;
		1657
		1658	Here is an ECMAScript version (same regex):
		1659
		1660	json = json.replace (/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/g, "[$1,");
		1661
		1662	Since this syntax converts to standard JSON arrays, it might be hard to
		1663	distinguish serialised objects from normal arrays. You can prepend a
		1664	"magic number" as first array element to reduce chances of a collision:
		1665
		1666	$json =~ s/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/["XU1peReLzT4ggEllLanBYq4G9VzliwKF",$1,/g;
		1667
		1668	And after decoding the JSON text, you could walk the data
		1669	structure looking for arrays with a first element of
		1670	C<XU1peReLzT4ggEllLanBYq4G9VzliwKF>.
		1671
		1672	The same approach can be used to create the tagged format with another
		1673	encoder. First, you create an array with the magic string as first member,
		1674	the classname as second, and constructor arguments last, encode it as part
		1675	of your JSON structure, and then:
		1676
		1677	$json =~ s/\[\s"XU1peReLzT4ggEllLanBYq4G9VzliwKF"\s,\s("([^\\":,]+\|\\.\|::)")\s*,/($1)[/g;
		1678
		1679	Again, this has some limitations - the magic string must not be encoded
		1680	with character escapes, and the constructor arguments must be non-empty.
		1681
		1682
		1683	=head1 RFC7159
		1684
		1685	Since this module was written, Google has written a new JSON RFC, RFC 7159
		1686	(and RFC7158). Unfortunately, this RFC breaks compatibility with both the
		1687	original JSON specification on www.json.org and RFC4627.
		1688
		1689	As far as I can see, you can get partial compatibility when parsing by
		1690	using C<< ->allow_nonref >>. However, consider the security implications
		1691	of doing so.
		1692
		1693	I haven't decided yet when to break compatibility with RFC4627 by default
		1694	(and potentially leave applications insecure) and change the default to
		1695	follow RFC7159, but application authors are well advised to call C<<
		1696	->allow_nonref(0) >> even if this is the current default, if they cannot
		1697	handle non-reference values, in preparation for the day when the default
		1698	will change.
1399		1699
1400		1700
1401	=head1 THREADS	1701	=head1 THREADS
1402		1702
1403	This module is I<not> guaranteed to be thread safe and there are no	1703	This module is I<not> guaranteed to be thread safe and there are no
…		…
1406	process simulations - use fork, it's I<much> faster, cheaper, better).	1706	process simulations - use fork, it's I<much> faster, cheaper, better).
1407		1707
1408	(It might actually work, but you have been warned).	1708	(It might actually work, but you have been warned).
1409		1709
1410		1710
		1711	=head1 THE PERILS OF SETLOCALE
		1712
		1713	Sometimes people avoid the Perl locale support and directly call the
		1714	system's setlocale function with C<LC_ALL>.
		1715
		1716	This breaks both perl and modules such as JSON::XS, as stringification of
		1717	numbers no longer works correctly (e.g. C<$x = 0.1; print "$x"+1> might
		1718	print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on
		1719	perl to stringify numbers).
		1720
		1721	The solution is simple: don't call C<setlocale>, or use it for only those
		1722	categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>.
		1723
		1724	If you need C<LC_NUMERIC>, you should enable it only around the code that
		1725	actually needs it (avoiding stringification of numbers), and restore it
		1726	afterwards.
		1727
		1728
1411	=head1 BUGS	1729	=head1 BUGS
1412		1730
1413	While the goal of this module is to be correct, that unfortunately does	1731	While the goal of this module is to be correct, that unfortunately does
1414	not mean it's bug-free, only that I think its design is bug-free. It is	1732	not mean it's bug-free, only that I think its design is bug-free. If you
1415	still relatively early in its development. If you keep reporting bugs they	1733	keep reporting bugs they will be fixed swiftly, though.
1416	will be fixed swiftly, though.
1417		1734
1418	Please refrain from using rt.cpan.org or any other bug reporting	1735	Please refrain from using rt.cpan.org or any other bug reporting
1419	service. I put the contact address into my modules for a reason.	1736	service. I put the contact address into my modules for a reason.
1420		1737
1421	=cut	1738	=cut
1422		1739
1423	our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };	1740	BEGIN {
1424	our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };	1741	*true = \$Types::Serialiser::true;
		1742	*true = \&Types::Serialiser::true;
		1743	*false = \$Types::Serialiser::false;
		1744	*false = \&Types::Serialiser::false;
		1745	*is_bool = \&Types::Serialiser::is_bool;
1425		1746
1426	sub true() { $true }	1747	JSON::XS::Boolean:: = Types::Serialiser::Boolean::;
1427	sub false() { $false }
1428
1429	sub is_bool($) {
1430	UNIVERSAL::isa $_[0], "JSON::XS::Boolean"
1431	# or UNIVERSAL::isa $_[0], "JSON::Literal"
1432	}	1748	}
1433		1749
1434	XSLoader::load "JSON::XS", $VERSION;	1750	XSLoader::load "JSON::XS", $VERSION;
1435
1436	package JSON::XS::Boolean;
1437
1438	use overload
1439	"0+" => sub { ${$_[0]} },
1440	"++" => sub { $_[0] = ${$_[0]} + 1 },
1441	"--" => sub { $_[0] = ${$_[0]} - 1 },
1442	fallback => 1;
1443
1444	1;
1445		1751
1446	=head1 SEE ALSO	1752	=head1 SEE ALSO
1447		1753
1448	The F<json_xs> command line utility for quick experiments.	1754	The F<json_xs> command line utility for quick experiments.
1449		1755
…		…
1452	Marc Lehmann <schmorp@schmorp.de>	1758	Marc Lehmann <schmorp@schmorp.de>
1453	http://home.schmorp.de/	1759	http://home.schmorp.de/
1454		1760
1455	=cut	1761	=cut
1456		1762
		1763	1
		1764

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.94 by root, Tue Mar 25 07:46:15 2008 UTC vs. Revision 1.162 by root, Wed Nov 23 05:57:12 2016 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.94 by root, Tue Mar 25 07:46:15 2008 UTC vs.
Revision 1.162 by root, Wed Nov 23 05:57:12 2016 UTC