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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.113 by root, Thu Nov 20 03:59:53 2008 UTC vs.
Revision 1.169 by root, Thu Nov 15 20:49:12 2018 UTC

…		…
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	overridden) with no overhead due to emulation (by inheriting 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
…		…
64	so, and even documents what "correct" means.	64	so, and even documents what "correct" means.
65		65
66	=item * round-trip integrity	66	=item * round-trip integrity
67		67
68	When you serialise a perl data structure using only data types supported	68	When you serialise a perl data structure using only data types supported
69	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
70	(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
71	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
72	section below to learn about those.	72	MAPPING section below to learn about those.
73		73
74	=item * strict checking of JSON correctness	74	=item * strict checking of JSON correctness
75		75
76	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,
77	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
…		…
83	this module usually compares favourably in terms of speed, too.	83	this module usually compares favourably in terms of speed, too.
84		84
85	=item * simple to use	85	=item * simple to use
86		86
87	This module has both a simple functional interface as well as an object	87	This module has both a simple functional interface as well as an object
88	oriented interface interface.	88	oriented interface.
89		89
90	=item * reasonably versatile output formats	90	=item * reasonably versatile output formats
91		91
92	You can choose between the most compact guaranteed-single-line format	92	You can choose between the most compact guaranteed-single-line format
93	possible (nice for simple line-based protocols), a pure-ASCII format	93	possible (nice for simple line-based protocols), a pure-ASCII format
…		…
99		99
100	=cut	100	=cut
101		101
102	package JSON::XS;	102	package JSON::XS;
103		103
104	no warnings;	104	use common::sense;
105	use strict;
106		105
107	our $VERSION = '2.231';	106	our $VERSION = 3.04;
108	our @ISA = qw(Exporter);	107	our @ISA = qw(Exporter);
109		108
110	our @EXPORT = qw(encode_json decode_json to_json from_json);	109	our @EXPORT = qw(encode_json decode_json);
111
112	sub to_json($) {
113	require Carp;
114	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");
115	}
116
117	sub from_json($) {
118	require Carp;
119	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");
120	}
121		110
122	use Exporter;	111	use Exporter;
123	use XSLoader;	112	use XSLoader;
124		113
		114	use Types::Serialiser ();
		115
125	=head1 FUNCTIONAL INTERFACE	116	=head1 FUNCTIONAL INTERFACE
126		117
127	The following convenience methods are provided by this module. They are	118	The following convenience methods are provided by this module. They are
128	exported by default:	119	exported by default:
129		120
…		…
140		131
141	Except being faster.	132	Except being faster.
142		133
143	=item $perl_scalar = decode_json $json_text	134	=item $perl_scalar = decode_json $json_text
144		135
145	The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries	136	The opposite of C<encode_json>: expects a UTF-8 (binary) string and tries
146	to parse that as an UTF-8 encoded JSON text, returning the resulting	137	to parse that as a UTF-8 encoded JSON text, returning the resulting
147	reference. Croaks on error.	138	reference. Croaks on error.
148		139
149	This function call is functionally identical to:	140	This function call is functionally identical to:
150		141
151	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	142	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
152		143
153	Except being faster.	144	Except being faster.
154
155	=item $is_boolean = JSON::XS::is_bool $scalar
156
157	Returns true if the passed scalar represents either JSON::XS::true or
158	JSON::XS::false, two constants that act like C<1> and C<0>, respectively
159	and are used to represent JSON C<true> and C<false> values in Perl.
160
161	See MAPPING, below, for more information on how JSON values are mapped to
162	Perl.
163		145
164	=back	146	=back
165		147
166		148
167	=head1 A FEW NOTES ON UNICODE AND PERL	149	=head1 A FEW NOTES ON UNICODE AND PERL
…		…
220	=over 4	202	=over 4
221		203
222	=item $json = new JSON::XS	204	=item $json = new JSON::XS
223		205
224	Creates a new JSON::XS object that can be used to de/encode JSON	206	Creates a new JSON::XS object that can be used to de/encode JSON
225	strings. All boolean flags described below are by default I<disabled>.	207	strings. All boolean flags described below are by default I<disabled>
		208	(with the exception of C<allow_nonref>, which defaults to I<enabled> since
		209	version C<4.0>).
226		210
227	The mutators for flags all return the JSON object again and thus calls can	211	The mutators for flags all return the JSON object again and thus calls can
228	be chained:	212	be chained:
229		213
230	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})	214	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
…		…
288		272
289	=item $enabled = $json->get_utf8	273	=item $enabled = $json->get_utf8
290		274
291	If C<$enable> is true (or missing), then the C<encode> method will encode	275	If C<$enable> is true (or missing), then the C<encode> method will encode
292	the JSON result into UTF-8, as required by many protocols, while the	276	the JSON result into UTF-8, as required by many protocols, while the
293	C<decode> method expects to be handled an UTF-8-encoded string. Please	277	C<decode> method expects to be handed a UTF-8-encoded string. Please
294	note that UTF-8-encoded strings do not contain any characters outside the	278	note that UTF-8-encoded strings do not contain any characters outside the
295	range C<0..255>, they are thus useful for bytewise/binary I/O. In future	279	range C<0..255>, they are thus useful for bytewise/binary I/O. In future
296	versions, enabling this option might enable autodetection of the UTF-16	280	versions, enabling this option might enable autodetection of the UTF-16
297	and UTF-32 encoding families, as described in RFC4627.	281	and UTF-32 encoding families, as described in RFC4627.
298		282
…		…
383		367
384	=item $enabled = $json->get_relaxed	368	=item $enabled = $json->get_relaxed
385		369
386	If C<$enable> is true (or missing), then C<decode> will accept some	370	If C<$enable> is true (or missing), then C<decode> will accept some
387	extensions to normal JSON syntax (see below). C<encode> will not be	371	extensions to normal JSON syntax (see below). C<encode> will not be
388	affected in anyway. I<Be aware that this option makes you accept invalid	372	affected in any way. I<Be aware that this option makes you accept invalid
389	JSON texts as if they were valid!>. I suggest only to use this option to	373	JSON texts as if they were valid!>. I suggest only to use this option to
390	parse application-specific files written by humans (configuration files,	374	parse application-specific files written by humans (configuration files,
391	resource files etc.)	375	resource files etc.)
392		376
393	If C<$enable> is false (the default), then C<decode> will only accept	377	If C<$enable> is false (the default), then C<decode> will only accept
…		…
422	[	406	[
423	1, # this comment not allowed in JSON	407	1, # this comment not allowed in JSON
424	# neither this one...	408	# neither this one...
425	]	409	]
426		410
		411	=item * literal ASCII TAB characters in strings
		412
		413	Literal ASCII TAB characters are now allowed in strings (and treated as
		414	C<\t>).
		415
		416	[
		417	"Hello\tWorld",
		418	"Hello<TAB>World", # literal <TAB> would not normally be allowed
		419	]
		420
427	=back	421	=back
428		422
429	=item $json = $json->canonical ([$enable])	423	=item $json = $json->canonical ([$enable])
430		424
431	=item $enabled = $json->get_canonical	425	=item $enabled = $json->get_canonical
…		…
433	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects	427	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
434	by sorting their keys. This is adding a comparatively high overhead.	428	by sorting their keys. This is adding a comparatively high overhead.
435		429
436	If C<$enable> is false, then the C<encode> method will output key-value	430	If C<$enable> is false, then the C<encode> method will output key-value
437	pairs in the order Perl stores them (which will likely change between runs	431	pairs in the order Perl stores them (which will likely change between runs
438	of the same script).	432	of the same script, and can change even within the same run from 5.18
		433	onwards).
439		434
440	This option is useful if you want the same data structure to be encoded as	435	This option is useful if you want the same data structure to be encoded as
441	the same JSON text (given the same overall settings). If it is disabled,	436	the same JSON text (given the same overall settings). If it is disabled,
442	the same hash might be encoded differently even if contains the same data,	437	the same hash might be encoded differently even if contains the same data,
443	as key-value pairs have no inherent ordering in Perl.	438	as key-value pairs have no inherent ordering in Perl.
444		439
445	This setting has no effect when decoding JSON texts.	440	This setting has no effect when decoding JSON texts.
446		441
		442	This setting has currently no effect on tied hashes.
		443
447	=item $json = $json->allow_nonref ([$enable])	444	=item $json = $json->allow_nonref ([$enable])
448		445
449	=item $enabled = $json->get_allow_nonref	446	=item $enabled = $json->get_allow_nonref
		447
		448	Unlike other boolean options, this opotion is enabled by default beginning
		449	with version C<4.0>. See L<SECURITY CONSIDERATIONS> for the gory details.
450		450
451	If C<$enable> is true (or missing), then the C<encode> method can convert a	451	If C<$enable> is true (or missing), then the C<encode> method can convert a
452	non-reference into its corresponding string, number or null JSON value,	452	non-reference into its corresponding string, number or null JSON value,
453	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON	453	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON
454	values instead of croaking.	454	values instead of croaking.
…		…
456	If C<$enable> is false, then the C<encode> method will croak if it isn't	456	If C<$enable> is false, then the C<encode> method will croak if it isn't
457	passed an arrayref or hashref, as JSON texts must either be an object	457	passed an arrayref or hashref, as JSON texts must either be an object
458	or array. Likewise, C<decode> will croak if given something that is not a	458	or array. Likewise, C<decode> will croak if given something that is not a
459	JSON object or array.	459	JSON object or array.
460		460
461	Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>,	461	Example, encode a Perl scalar as JSON value without enabled C<allow_nonref>,
462	resulting in an invalid JSON text:	462	resulting in an error:
463		463
464	JSON::XS->new->allow_nonref->encode ("Hello, World!")	464	JSON::XS->new->allow_nonref (0)->encode ("Hello, World!")
465	=> "Hello, World!"	465	=> hash- or arrayref expected...
466		466
467	=item $json = $json->allow_unknown ([$enable])	467	=item $json = $json->allow_unknown ([$enable])
468		468
469	=item $enabled = $json->get_allow_unknown	469	=item $enabled = $json->get_allow_unknown
470		470
…		…
482		482
483	=item $json = $json->allow_blessed ([$enable])	483	=item $json = $json->allow_blessed ([$enable])
484		484
485	=item $enabled = $json->get_allow_blessed	485	=item $enabled = $json->get_allow_blessed
486		486
		487	See L<OBJECT SERIALISATION> for details.
		488
487	If C<$enable> is true (or missing), then the C<encode> method will not	489	If C<$enable> is true (or missing), then the C<encode> method will not
488	barf when it encounters a blessed reference. Instead, the value of the	490	barf when it encounters a blessed reference that it cannot convert
489	B<convert_blessed> option will decide whether C<null> (C<convert_blessed>	491	otherwise. Instead, a JSON C<null> value is encoded instead of the object.
490	disabled or no C<TO_JSON> method found) or a representation of the
491	object (C<convert_blessed> enabled and C<TO_JSON> method found) is being
492	encoded. Has no effect on C<decode>.
493		492
494	If C<$enable> is false (the default), then C<encode> will throw an	493	If C<$enable> is false (the default), then C<encode> will throw an
495	exception when it encounters a blessed object.	494	exception when it encounters a blessed object that it cannot convert
		495	otherwise.
		496
		497	This setting has no effect on C<decode>.
496		498
497	=item $json = $json->convert_blessed ([$enable])	499	=item $json = $json->convert_blessed ([$enable])
498		500
499	=item $enabled = $json->get_convert_blessed	501	=item $enabled = $json->get_convert_blessed
		502
		503	See L<OBJECT SERIALISATION> for details.
500		504
501	If C<$enable> is true (or missing), then C<encode>, upon encountering a	505	If C<$enable> is true (or missing), then C<encode>, upon encountering a
502	blessed object, will check for the availability of the C<TO_JSON> method	506	blessed object, will check for the availability of the C<TO_JSON> method
503	on the object's class. If found, it will be called in scalar context	507	on the object's class. If found, it will be called in scalar context and
504	and the resulting scalar will be encoded instead of the object. If no	508	the resulting scalar will be encoded instead of the object.
505	C<TO_JSON> method is found, the value of C<allow_blessed> will decide what
506	to do.
507		509
508	The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON>	510	The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON>
509	returns other blessed objects, those will be handled in the same	511	returns other blessed objects, those will be handled in the same
510	way. C<TO_JSON> must take care of not causing an endless recursion cycle	512	way. C<TO_JSON> must take care of not causing an endless recursion cycle
511	(== crash) in this case. The name of C<TO_JSON> was chosen because other	513	(== crash) in this case. The name of C<TO_JSON> was chosen because other
512	methods called by the Perl core (== not by the user of the object) are	514	methods called by the Perl core (== not by the user of the object) are
513	usually in upper case letters and to avoid collisions with any C<to_json>	515	usually in upper case letters and to avoid collisions with any C<to_json>
514	function or method.	516	function or method.
515		517
516	This setting does not yet influence C<decode> in any way, but in the	518	If C<$enable> is false (the default), then C<encode> will not consider
517	future, global hooks might get installed that influence C<decode> and are	519	this type of conversion.
518	enabled by this setting.
519		520
520	If C<$enable> is false, then the C<allow_blessed> setting will decide what	521	This setting has no effect on C<decode>.
521	to do when a blessed object is found.	522
		523	=item $json = $json->allow_tags ([$enable])
		524
		525	=item $enabled = $json->get_allow_tags
		526
		527	See L<OBJECT SERIALISATION> for details.
		528
		529	If C<$enable> is true (or missing), then C<encode>, upon encountering a
		530	blessed object, will check for the availability of the C<FREEZE> method on
		531	the object's class. If found, it will be used to serialise the object into
		532	a nonstandard tagged JSON value (that JSON decoders cannot decode).
		533
		534	It also causes C<decode> to parse such tagged JSON values and deserialise
		535	them via a call to the C<THAW> method.
		536
		537	If C<$enable> is false (the default), then C<encode> will not consider
		538	this type of conversion, and tagged JSON values will cause a parse error
		539	in C<decode>, as if tags were not part of the grammar.
522		540
523	=item $json = $json->filter_json_object ([$coderef->($hashref)])	541	=item $json = $json->filter_json_object ([$coderef->($hashref)])
524		542
525	When C<$coderef> is specified, it will be called from C<decode> each	543	When C<$coderef> is specified, it will be called from C<decode> each
526	time it decodes a JSON object. The only argument is a reference to the	544	time it decodes a JSON object. The only argument is a reference to
527	newly-created hash. If the code references returns a single scalar (which	545	the newly-created hash. If the code reference returns a single scalar
528	need not be a reference), this value (i.e. a copy of that scalar to avoid	546	(which need not be a reference), this value (or rather a copy of it) is
529	aliasing) is inserted into the deserialised data structure. If it returns	547	inserted into the deserialised data structure. If it returns an empty
530	an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the	548	list (NOTE: I<not> C<undef>, which is a valid scalar), the original
531	original deserialised hash will be inserted. This setting can slow down	549	deserialised hash will be inserted. This setting can slow down decoding
532	decoding considerably.	550	considerably.
533		551
534	When C<$coderef> is omitted or undefined, any existing callback will	552	When C<$coderef> is omitted or undefined, any existing callback will
535	be removed and C<decode> will not change the deserialised hash in any	553	be removed and C<decode> will not change the deserialised hash in any
536	way.	554	way.
537		555
…		…
665		683
666	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.	684	See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
667		685
668	=item $json_text = $json->encode ($perl_scalar)	686	=item $json_text = $json->encode ($perl_scalar)
669		687
670	Converts the given Perl data structure (a simple scalar or a reference	688	Converts the given Perl value or data structure to its JSON
671	to a hash or array) to its JSON representation. Simple scalars will be	689	representation. Croaks on error.
672	converted into JSON string or number sequences, while references to arrays
673	become JSON arrays and references to hashes become JSON objects. Undefined
674	Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true>
675	nor C<false> values will be generated.
676		690
677	=item $perl_scalar = $json->decode ($json_text)	691	=item $perl_scalar = $json->decode ($json_text)
678		692
679	The opposite of C<encode>: expects a JSON text and tries to parse it,	693	The opposite of C<encode>: expects a JSON text and tries to parse it,
680	returning the resulting simple scalar or reference. Croaks on error.	694	returning the resulting simple scalar or reference. Croaks on error.
681
682	JSON numbers and strings become simple Perl scalars. JSON arrays become
683	Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes
684	C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.
685		695
686	=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text)	696	=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text)
687		697
688	This works like the C<decode> method, but instead of raising an exception	698	This works like the C<decode> method, but instead of raising an exception
689	when there is trailing garbage after the first JSON object, it will	699	when there is trailing garbage after the first JSON object, it will
690	silently stop parsing there and return the number of characters consumed	700	silently stop parsing there and return the number of characters consumed
691	so far.	701	so far.
692		702
693	This is useful if your JSON texts are not delimited by an outer protocol	703	This is useful if your JSON texts are not delimited by an outer protocol
694	(which is not the brightest thing to do in the first place) and you need
695	to know where the JSON text ends.	704	and you need to know where the JSON text ends.
696		705
697	JSON::XS->new->decode_prefix ("[1] the tail")	706	JSON::XS->new->decode_prefix ("[1] the tail")
698	=> ([], 3)	707	=> ([1], 3)
699		708
700	=back	709	=back
701		710
702		711
703	=head1 INCREMENTAL PARSING	712	=head1 INCREMENTAL PARSING
…		…
712	calls).	721	calls).
713		722
714	JSON::XS will only attempt to parse the JSON text once it is sure it	723	JSON::XS will only attempt to parse the JSON text once it is sure it
715	has enough text to get a decisive result, using a very simple but	724	has enough text to get a decisive result, using a very simple but
716	truly incremental parser. This means that it sometimes won't stop as	725	truly incremental parser. This means that it sometimes won't stop as
717	early as the full parser, for example, it doesn't detect parenthese	726	early as the full parser, for example, it doesn't detect mismatched
718	mismatches. The only thing it guarantees is that it starts decoding as	727	parentheses. The only thing it guarantees is that it starts decoding as
719	soon as a syntactically valid JSON text has been seen. This means you need	728	soon as a syntactically valid JSON text has been seen. This means you need
720	to set resource limits (e.g. C<max_size>) to ensure the parser will stop	729	to set resource limits (e.g. C<max_size>) to ensure the parser will stop
721	parsing in the presence if syntax errors.	730	parsing in the presence if syntax errors.
722		731
723	The following methods implement this incremental parser.	732	The following methods implement this incremental parser.
…		…
739		748
740	If the method is called in scalar context, then it will try to extract	749	If the method is called in scalar context, then it will try to extract
741	exactly I<one> JSON object. If that is successful, it will return this	750	exactly I<one> JSON object. If that is successful, it will return this
742	object, otherwise it will return C<undef>. If there is a parse error,	751	object, otherwise it will return C<undef>. If there is a parse error,
743	this method will croak just as C<decode> would do (one can then use	752	this method will croak just as C<decode> would do (one can then use
744	C<incr_skip> to skip the errornous part). This is the most common way of	753	C<incr_skip> to skip the erroneous part). This is the most common way of
745	using the method.	754	using the method.
746		755
747	And finally, in list context, it will try to extract as many objects	756	And finally, in list context, it will try to extract as many objects
748	from the stream as it can find and return them, or the empty list	757	from the stream as it can find and return them, or the empty list
749	otherwise. For this to work, there must be no separators between the JSON	758	otherwise. For this to work, there must be no separators (other than
750	objects or arrays, instead they must be concatenated back-to-back. If	759	whitespace) between the JSON objects or arrays, instead they must be
751	an error occurs, an exception will be raised as in the scalar context	760	concatenated back-to-back. If an error occurs, an exception will be
752	case. Note that in this case, any previously-parsed JSON texts will be	761	raised as in the scalar context case. Note that in this case, any
753	lost.	762	previously-parsed JSON texts will be lost.
		763
		764	Example: Parse some JSON arrays/objects in a given string and return
		765	them.
		766
		767	my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
754		768
755	=item $lvalue_string = $json->incr_text	769	=item $lvalue_string = $json->incr_text
756		770
757	This method returns the currently stored JSON fragment as an lvalue, that	771	This method returns the currently stored JSON fragment as an lvalue, that
758	is, you can manipulate it. This I<only> works when a preceding call to	772	is, you can manipulate it. This I<only> works when a preceding call to
…		…
760	all other circumstances you must not call this function (I mean it.	774	all other circumstances you must not call this function (I mean it.
761	although in simple tests it might actually work, it I<will> fail under	775	although in simple tests it might actually work, it I<will> fail under
762	real world conditions). As a special exception, you can also call this	776	real world conditions). As a special exception, you can also call this
763	method before having parsed anything.	777	method before having parsed anything.
764		778
		779	That means you can only use this function to look at or manipulate text
		780	before or after complete JSON objects, not while the parser is in the
		781	middle of parsing a JSON object.
		782
765	This function is useful in two cases: a) finding the trailing text after a	783	This function is useful in two cases: a) finding the trailing text after a
766	JSON object or b) parsing multiple JSON objects separated by non-JSON text	784	JSON object or b) parsing multiple JSON objects separated by non-JSON text
767	(such as commas).	785	(such as commas).
768		786
769	=item $json->incr_skip	787	=item $json->incr_skip
770		788
771	This will reset the state of the incremental parser and will remove the	789	This will reset the state of the incremental parser and will remove
772	parsed text from the input buffer. This is useful after C<incr_parse>	790	the parsed text from the input buffer so far. This is useful after
773	died, in which case the input buffer and incremental parser state is left	791	C<incr_parse> died, in which case the input buffer and incremental parser
774	unchanged, to skip the text parsed so far and to reset the parse state.	792	state is left unchanged, to skip the text parsed so far and to reset the
		793	parse state.
		794
		795	The difference to C<incr_reset> is that only text until the parse error
		796	occurred is removed.
775		797
776	=item $json->incr_reset	798	=item $json->incr_reset
777		799
778	This completely resets the incremental parser, that is, after this call,	800	This completely resets the incremental parser, that is, after this call,
779	it will be as if the parser had never parsed anything.	801	it will be as if the parser had never parsed anything.
780		802
781	This is useful if you want ot repeatedly parse JSON objects and want to	803	This is useful if you want to repeatedly parse JSON objects and want to
782	ignore any trailing data, which means you have to reset the parser after	804	ignore any trailing data, which means you have to reset the parser after
783	each successful decode.	805	each successful decode.
784		806
785	=back	807	=back
786		808
787	=head2 LIMITATIONS	809	=head2 LIMITATIONS
788		810
789	All options that affect decoding are supported, except	811	All options that affect decoding are supported, except
790	C<allow_nonref>. The reason for this is that it cannot be made to	812	C<allow_nonref>. The reason for this is that it cannot be made to work
791	work sensibly: JSON objects and arrays are self-delimited, i.e. you can concatenate	813	sensibly: JSON objects and arrays are self-delimited, i.e. you can
792	them back to back and still decode them perfectly. This does not hold true	814	concatenate them back to back and still decode them perfectly. This does
793	for JSON numbers, however.	815	not hold true for JSON numbers, however.
794		816
795	For example, is the string C<1> a single JSON number, or is it simply the	817	For example, is the string C<1> a single JSON number, or is it simply the
796	start of C<12>? Or is C<12> a single JSON number, or the concatenation	818	start of C<12>? Or is C<12> a single JSON number, or the concatenation
797	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS	819	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS
798	takes the conservative route and disallows this case.	820	takes the conservative route and disallows this case.
…		…
977	If the number consists of digits only, JSON::XS will try to represent	999	If the number consists of digits only, JSON::XS will try to represent
978	it as an integer value. If that fails, it will try to represent it as	1000	it as an integer value. If that fails, it will try to represent it as
979	a numeric (floating point) value if that is possible without loss of	1001	a numeric (floating point) value if that is possible without loss of
980	precision. Otherwise it will preserve the number as a string value (in	1002	precision. Otherwise it will preserve the number as a string value (in
981	which case you lose roundtripping ability, as the JSON number will be	1003	which case you lose roundtripping ability, as the JSON number will be
982	re-encoded toa JSON string).	1004	re-encoded to a JSON string).
983		1005
984	Numbers containing a fractional or exponential part will always be	1006	Numbers containing a fractional or exponential part will always be
985	represented as numeric (floating point) values, possibly at a loss of	1007	represented as numeric (floating point) values, possibly at a loss of
986	precision (in which case you might lose perfect roundtripping ability, but	1008	precision (in which case you might lose perfect roundtripping ability, but
987	the JSON number will still be re-encoded as a JSON number).	1009	the JSON number will still be re-encoded as a JSON number).
988		1010
		1011	Note that precision is not accuracy - binary floating point values cannot
		1012	represent most decimal fractions exactly, and when converting from and to
		1013	floating point, JSON::XS only guarantees precision up to but not including
		1014	the least significant bit.
		1015
989	=item true, false	1016	=item true, false
990		1017
991	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,	1018	These JSON atoms become C<Types::Serialiser::true> and
992	respectively. They are overloaded to act almost exactly like the numbers	1019	C<Types::Serialiser::false>, respectively. They are overloaded to act
993	C<1> and C<0>. You can check whether a scalar is a JSON boolean by using	1020	almost exactly like the numbers C<1> and C<0>. You can check whether
994	the C<JSON::XS::is_bool> function.	1021	a scalar is a JSON boolean by using the C<Types::Serialiser::is_bool>
		1022	function (after C<use Types::Serialier>, of course).
995		1023
996	=item null	1024	=item null
997		1025
998	A JSON null atom becomes C<undef> in Perl.	1026	A JSON null atom becomes C<undef> in Perl.
		1027
		1028	=item shell-style comments (C<< # I<text> >>)
		1029
		1030	As a nonstandard extension to the JSON syntax that is enabled by the
		1031	C<relaxed> setting, shell-style comments are allowed. They can start
		1032	anywhere outside strings and go till the end of the line.
		1033
		1034	=item tagged values (C<< (I<tag>)I<value> >>).
		1035
		1036	Another nonstandard extension to the JSON syntax, enabled with the
		1037	C<allow_tags> setting, are tagged values. In this implementation, the
		1038	I<tag> must be a perl package/class name encoded as a JSON string, and the
		1039	I<value> must be a JSON array encoding optional constructor arguments.
		1040
		1041	See L<OBJECT SERIALISATION>, below, for details.
999		1042
1000	=back	1043	=back
1001		1044
1002		1045
1003	=head2 PERL -> JSON	1046	=head2 PERL -> JSON
…		…
1008		1051
1009	=over 4	1052	=over 4
1010		1053
1011	=item hash references	1054	=item hash references
1012		1055
1013	Perl hash references become JSON objects. As there is no inherent ordering	1056	Perl hash references become JSON objects. As there is no inherent
1014	in hash keys (or JSON objects), they will usually be encoded in a	1057	ordering in hash keys (or JSON objects), they will usually be encoded
1015	pseudo-random order that can change between runs of the same program but	1058	in a pseudo-random order. JSON::XS can optionally sort the hash keys
1016	stays generally the same within a single run of a program. JSON::XS can	1059	(determined by the I<canonical> flag), so the same datastructure will
1017	optionally sort the hash keys (determined by the I<canonical> flag), so	1060	serialise to the same JSON text (given same settings and version of
1018	the same datastructure will serialise to the same JSON text (given same	1061	JSON::XS), but this incurs a runtime overhead and is only rarely useful,
1019	settings and version of JSON::XS), but this incurs a runtime overhead	1062	e.g. when you want to compare some JSON text against another for equality.
1020	and is only rarely useful, e.g. when you want to compare some JSON text
1021	against another for equality.
1022		1063
1023	=item array references	1064	=item array references
1024		1065
1025	Perl array references become JSON arrays.	1066	Perl array references become JSON arrays.
1026		1067
1027	=item other references	1068	=item other references
1028		1069
1029	Other unblessed references are generally not allowed and will cause an	1070	Other unblessed references are generally not allowed and will cause an
1030	exception to be thrown, except for references to the integers C<0> and	1071	exception to be thrown, except for references to the integers C<0> and
1031	C<1>, which get turned into C<false> and C<true> atoms in JSON. You can	1072	C<1>, which get turned into C<false> and C<true> atoms in JSON.
1032	also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
1033		1073
		1074	Since C<JSON::XS> uses the boolean model from L<Types::Serialiser>, you
		1075	can also C<use Types::Serialiser> and then use C<Types::Serialiser::false>
		1076	and C<Types::Serialiser::true> to improve readability.
		1077
		1078	use Types::Serialiser;
1034	encode_json [\0, JSON::XS::true] # yields [false,true]	1079	encode_json [\0, Types::Serialiser::true] # yields [false,true]
1035		1080
1036	=item JSON::XS::true, JSON::XS::false	1081	=item Types::Serialiser::true, Types::Serialiser::false
1037		1082
1038	These special values become JSON true and JSON false values,	1083	These special values from the L<Types::Serialiser> module become JSON true
1039	respectively. You can also use C<\1> and C<\0> directly if you want.	1084	and JSON false values, respectively. You can also use C<\1> and C<\0>
		1085	directly if you want.
1040		1086
1041	=item blessed objects	1087	=item blessed objects
1042		1088
1043	Blessed objects are not directly representable in JSON. See the	1089	Blessed objects are not directly representable in JSON, but C<JSON::XS>
1044	C<allow_blessed> and C<convert_blessed> methods on various options on	1090	allows various ways of handling objects. See L<OBJECT SERIALISATION>,
1045	how to deal with this: basically, you can choose between throwing an	1091	below, for details.
1046	exception, encoding the reference as if it weren't blessed, or provide
1047	your own serialiser method.
1048		1092
1049	=item simple scalars	1093	=item simple scalars
1050		1094
1051	Simple Perl scalars (any scalar that is not a reference) are the most	1095	Simple Perl scalars (any scalar that is not a reference) are the most
1052	difficult objects to encode: JSON::XS will encode undefined scalars as	1096	difficult objects to encode: JSON::XS will encode undefined scalars as
…		…
1080		1124
1081	You can not currently force the type in other, less obscure, ways. Tell me	1125	You can not currently force the type in other, less obscure, ways. Tell me
1082	if you need this capability (but don't forget to explain why it's needed	1126	if you need this capability (but don't forget to explain why it's needed
1083	:).	1127	:).
1084		1128
		1129	Note that numerical precision has the same meaning as under Perl (so
		1130	binary to decimal conversion follows the same rules as in Perl, which
		1131	can differ to other languages). Also, your perl interpreter might expose
		1132	extensions to the floating point numbers of your platform, such as
		1133	infinities or NaN's - these cannot be represented in JSON, and it is an
		1134	error to pass those in.
		1135
1085	=back	1136	=back
		1137
		1138	=head2 OBJECT SERIALISATION
		1139
		1140	As JSON cannot directly represent Perl objects, you have to choose between
		1141	a pure JSON representation (without the ability to deserialise the object
		1142	automatically again), and a nonstandard extension to the JSON syntax,
		1143	tagged values.
		1144
		1145	=head3 SERIALISATION
		1146
		1147	What happens when C<JSON::XS> encounters a Perl object depends on the
		1148	C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are
		1149	used in this order:
		1150
		1151	=over 4
		1152
		1153	=item 1. C<allow_tags> is enabled and the object has a C<FREEZE> method.
		1154
		1155	In this case, C<JSON::XS> uses the L<Types::Serialiser> object
		1156	serialisation protocol to create a tagged JSON value, using a nonstandard
		1157	extension to the JSON syntax.
		1158
		1159	This works by invoking the C<FREEZE> method on the object, with the first
		1160	argument being the object to serialise, and the second argument being the
		1161	constant string C<JSON> to distinguish it from other serialisers.
		1162
		1163	The C<FREEZE> method can return any number of values (i.e. zero or
		1164	more). These values and the paclkage/classname of the object will then be
		1165	encoded as a tagged JSON value in the following format:
		1166
		1167	("classname")[FREEZE return values...]
		1168
		1169	e.g.:
		1170
		1171	("URI")["http://www.google.com/"]
		1172	("MyDate")[2013,10,29]
		1173	("ImageData::JPEG")["Z3...VlCg=="]
		1174
		1175	For example, the hypothetical C<My::Object> C<FREEZE> method might use the
		1176	objects C<type> and C<id> members to encode the object:
		1177
		1178	sub My::Object::FREEZE {
		1179	my ($self, $serialiser) = @_;
		1180
		1181	($self->{type}, $self->{id})
		1182	}
		1183
		1184	=item 2. C<convert_blessed> is enabled and the object has a C<TO_JSON> method.
		1185
		1186	In this case, the C<TO_JSON> method of the object is invoked in scalar
		1187	context. It must return a single scalar that can be directly encoded into
		1188	JSON. This scalar replaces the object in the JSON text.
		1189
		1190	For example, the following C<TO_JSON> method will convert all L<URI>
		1191	objects to JSON strings when serialised. The fatc that these values
		1192	originally were L<URI> objects is lost.
		1193
		1194	sub URI::TO_JSON {
		1195	my ($uri) = @_;
		1196	$uri->as_string
		1197	}
		1198
		1199	=item 3. C<allow_blessed> is enabled.
		1200
		1201	The object will be serialised as a JSON null value.
		1202
		1203	=item 4. none of the above
		1204
		1205	If none of the settings are enabled or the respective methods are missing,
		1206	C<JSON::XS> throws an exception.
		1207
		1208	=back
		1209
		1210	=head3 DESERIALISATION
		1211
		1212	For deserialisation there are only two cases to consider: either
		1213	nonstandard tagging was used, in which case C<allow_tags> decides,
		1214	or objects cannot be automatically be deserialised, in which
		1215	case you can use postprocessing or the C<filter_json_object> or
		1216	C<filter_json_single_key_object> callbacks to get some real objects our of
		1217	your JSON.
		1218
		1219	This section only considers the tagged value case: I a tagged JSON object
		1220	is encountered during decoding and C<allow_tags> is disabled, a parse
		1221	error will result (as if tagged values were not part of the grammar).
		1222
		1223	If C<allow_tags> is enabled, C<JSON::XS> will look up the C<THAW> method
		1224	of the package/classname used during serialisation (it will not attempt
		1225	to load the package as a Perl module). If there is no such method, the
		1226	decoding will fail with an error.
		1227
		1228	Otherwise, the C<THAW> method is invoked with the classname as first
		1229	argument, the constant string C<JSON> as second argument, and all the
		1230	values from the JSON array (the values originally returned by the
		1231	C<FREEZE> method) as remaining arguments.
		1232
		1233	The method must then return the object. While technically you can return
		1234	any Perl scalar, you might have to enable the C<enable_nonref> setting to
		1235	make that work in all cases, so better return an actual blessed reference.
		1236
		1237	As an example, let's implement a C<THAW> function that regenerates the
		1238	C<My::Object> from the C<FREEZE> example earlier:
		1239
		1240	sub My::Object::THAW {
		1241	my ($class, $serialiser, $type, $id) = @_;
		1242
		1243	$class->new (type => $type, id => $id)
		1244	}
1086		1245
1087		1246
1088	=head1 ENCODING/CODESET FLAG NOTES	1247	=head1 ENCODING/CODESET FLAG NOTES
1089		1248
1090	The interested reader might have seen a number of flags that signify	1249	The interested reader might have seen a number of flags that signify
…		…
1115	=item C<utf8> flag disabled	1274	=item C<utf8> flag disabled
1116		1275
1117	When C<utf8> is disabled (the default), then C<encode>/C<decode> generate	1276	When C<utf8> is disabled (the default), then C<encode>/C<decode> generate
1118	and expect Unicode strings, that is, characters with high ordinal Unicode	1277	and expect Unicode strings, that is, characters with high ordinal Unicode
1119	values (> 255) will be encoded as such characters, and likewise such	1278	values (> 255) will be encoded as such characters, and likewise such
1120	characters are decoded as-is, no canges to them will be done, except	1279	characters are decoded as-is, no changes to them will be done, except
1121	"(re-)interpreting" them as Unicode codepoints or Unicode characters,	1280	"(re-)interpreting" them as Unicode codepoints or Unicode characters,
1122	respectively (to Perl, these are the same thing in strings unless you do	1281	respectively (to Perl, these are the same thing in strings unless you do
1123	funny/weird/dumb stuff).	1282	funny/weird/dumb stuff).
1124		1283
1125	This is useful when you want to do the encoding yourself (e.g. when you	1284	This is useful when you want to do the encoding yourself (e.g. when you
…		…
1135	expect your input strings to be encoded as UTF-8, that is, no "character"	1294	expect your input strings to be encoded as UTF-8, that is, no "character"
1136	of the input string must have any value > 255, as UTF-8 does not allow	1295	of the input string must have any value > 255, as UTF-8 does not allow
1137	that.	1296	that.
1138		1297
1139	The C<utf8> flag therefore switches between two modes: disabled means you	1298	The C<utf8> flag therefore switches between two modes: disabled means you
1140	will get a Unicode string in Perl, enabled means you get an UTF-8 encoded	1299	will get a Unicode string in Perl, enabled means you get a UTF-8 encoded
1141	octet/binary string in Perl.	1300	octet/binary string in Perl.
1142		1301
1143	=item C<latin1> or C<ascii> flags enabled	1302	=item C<latin1> or C<ascii> flags enabled
1144		1303
1145	With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters	1304	With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters
…		…
1181	proper subset of most 8-bit and multibyte encodings in use in the world.	1340	proper subset of most 8-bit and multibyte encodings in use in the world.
1182		1341
1183	=back	1342	=back
1184		1343
1185		1344
		1345	=head2 JSON and ECMAscript
		1346
		1347	JSON syntax is based on how literals are represented in javascript (the
		1348	not-standardised predecessor of ECMAscript) which is presumably why it is
		1349	called "JavaScript Object Notation".
		1350
		1351	However, JSON is not a subset (and also not a superset of course) of
		1352	ECMAscript (the standard) or javascript (whatever browsers actually
		1353	implement).
		1354
		1355	If you want to use javascript's C<eval> function to "parse" JSON, you
		1356	might run into parse errors for valid JSON texts, or the resulting data
		1357	structure might not be queryable:
		1358
		1359	One of the problems is that U+2028 and U+2029 are valid characters inside
		1360	JSON strings, but are not allowed in ECMAscript string literals, so the
		1361	following Perl fragment will not output something that can be guaranteed
		1362	to be parsable by javascript's C<eval>:
		1363
		1364	use JSON::XS;
		1365
		1366	print encode_json [chr 0x2028];
		1367
		1368	The right fix for this is to use a proper JSON parser in your javascript
		1369	programs, and not rely on C<eval> (see for example Douglas Crockford's
		1370	F<json2.js> parser).
		1371
		1372	If this is not an option, you can, as a stop-gap measure, simply encode to
		1373	ASCII-only JSON:
		1374
		1375	use JSON::XS;
		1376
		1377	print JSON::XS->new->ascii->encode ([chr 0x2028]);
		1378
		1379	Note that this will enlarge the resulting JSON text quite a bit if you
		1380	have many non-ASCII characters. You might be tempted to run some regexes
		1381	to only escape U+2028 and U+2029, e.g.:
		1382
		1383	# DO NOT USE THIS!
		1384	my $json = JSON::XS->new->utf8->encode ([chr 0x2028]);
		1385	$json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028
		1386	$json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029
		1387	print $json;
		1388
		1389	Note that I<this is a bad idea>: the above only works for U+2028 and
		1390	U+2029 and thus only for fully ECMAscript-compliant parsers. Many existing
		1391	javascript implementations, however, have issues with other characters as
		1392	well - using C<eval> naively simply I<will> cause problems.
		1393
		1394	Another problem is that some javascript implementations reserve
		1395	some property names for their own purposes (which probably makes
		1396	them non-ECMAscript-compliant). For example, Iceweasel reserves the
		1397	C<__proto__> property name for its own purposes.
		1398
		1399	If that is a problem, you could parse try to filter the resulting JSON
		1400	output for these property strings, e.g.:
		1401
		1402	$json =~ s/"__proto__"\s*:/"__proto__renamed":/g;
		1403
		1404	This works because C<__proto__> is not valid outside of strings, so every
		1405	occurrence of C<"__proto__"\s*:> must be a string used as property name.
		1406
		1407	If you know of other incompatibilities, please let me know.
		1408
		1409
1186	=head2 JSON and YAML	1410	=head2 JSON and YAML
1187		1411
1188	You often hear that JSON is a subset of YAML. This is, however, a mass	1412	You often hear that JSON is a subset of YAML. This is, however, a mass
1189	hysteria(*) and very far from the truth (as of the time of this writing),	1413	hysteria(*) and very far from the truth (as of the time of this writing),
1190	so let me state it clearly: I<in general, there is no way to configure	1414	so let me state it clearly: I<in general, there is no way to configure
…		…
1198	my $yaml = $to_yaml->encode ($ref) . "\n";	1422	my $yaml = $to_yaml->encode ($ref) . "\n";
1199		1423
1200	This will I<usually> generate JSON texts that also parse as valid	1424	This will I<usually> generate JSON texts that also parse as valid
1201	YAML. Please note that YAML has hardcoded limits on (simple) object key	1425	YAML. Please note that YAML has hardcoded limits on (simple) object key
1202	lengths that JSON doesn't have and also has different and incompatible	1426	lengths that JSON doesn't have and also has different and incompatible
1203	unicode handling, so you should make sure that your hash keys are	1427	unicode character escape syntax, so you should make sure that your hash
1204	noticeably shorter than the 1024 "stream characters" YAML allows and that	1428	keys are noticeably shorter than the 1024 "stream characters" YAML allows
1205	you do not have characters with codepoint values outside the Unicode BMP	1429	and that you do not have characters with codepoint values outside the
1206	(basic multilingual page). YAML also does not allow C<\/> sequences in	1430	Unicode BMP (basic multilingual page). YAML also does not allow C<\/>
1207	strings (which JSON::XS does not I<currently> generate, but other JSON	1431	sequences in strings (which JSON::XS does not I<currently> generate, but
1208	generators might).	1432	other JSON generators might).
1209		1433
1210	There might be other incompatibilities that I am not aware of (or the YAML	1434	There might be other incompatibilities that I am not aware of (or the YAML
1211	specification has been changed yet again - it does so quite often). In	1435	specification has been changed yet again - it does so quite often). In
1212	general you should not try to generate YAML with a JSON generator or vice	1436	general you should not try to generate YAML with a JSON generator or vice
1213	versa, or try to parse JSON with a YAML parser or vice versa: chances are	1437	versa, or try to parse JSON with a YAML parser or vice versa: chances are
…		…
1232	that difficult or long) and finally make YAML compatible to it, and	1456	that difficult or long) and finally make YAML compatible to it, and
1233	educating users about the changes, instead of spreading lies about the	1457	educating users about the changes, instead of spreading lies about the
1234	real compatibility for many I<years> and trying to silence people who	1458	real compatibility for many I<years> and trying to silence people who
1235	point out that it isn't true.	1459	point out that it isn't true.
1236		1460
		1461	Addendum/2009: the YAML 1.2 spec is still incompatible with JSON, even
		1462	though the incompatibilities have been documented (and are known to Brian)
		1463	for many years and the spec makes explicit claims that YAML is a superset
		1464	of JSON. It would be so easy to fix, but apparently, bullying people and
		1465	corrupting userdata is so much easier.
		1466
1237	=back	1467	=back
1238		1468
1239		1469
1240	=head2 SPEED	1470	=head2 SPEED
1241		1471
…		…
1248	a very short single-line JSON string (also available at	1478	a very short single-line JSON string (also available at
1249	L<http://dist.schmorp.de/misc/json/short.json>).	1479	L<http://dist.schmorp.de/misc/json/short.json>).
1250		1480
1251	{"method": "handleMessage", "params": ["user1",	1481	{"method": "handleMessage", "params": ["user1",
1252	"we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,	1482	"we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
1253	true, false]}	1483	1, 0]}
1254		1484
1255	It shows the number of encodes/decodes per second (JSON::XS uses	1485	It shows the number of encodes/decodes per second (JSON::XS uses
1256	the functional interface, while JSON::XS/2 uses the OO interface	1486	the functional interface, while JSON::XS/2 uses the OO interface
1257	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables	1487	with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
1258	shrink). Higher is better:	1488	shrink. JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ
		1489	uses the from_json method). Higher is better:
1259		1490
1260	module \| encode \| decode \|	1491	module \| encode \| decode \|
1261	-----------\|------------\|------------\|	1492	--------------\|------------\|------------\|
1262	JSON 1.x \| 4990.842 \| 4088.813 \|	1493	JSON::DWIW/DS \| 86302.551 \| 102300.098 \|
1263	JSON::DWIW \| 51653.990 \| 71575.154 \|	1494	JSON::DWIW/FJ \| 86302.551 \| 75983.768 \|
1264	JSON::PC \| 65948.176 \| 74631.744 \|	1495	JSON::PP \| 15827.562 \| 6638.658 \|
1265	JSON::PP \| 8931.652 \| 3817.168 \|	1496	JSON::Syck \| 63358.066 \| 47662.545 \|
1266	JSON::Syck \| 24877.248 \| 27776.848 \|	1497	JSON::XS \| 511500.488 \| 511500.488 \|
1267	JSON::XS \| 388361.481 \| 227951.304 \|	1498	JSON::XS/2 \| 291271.111 \| 388361.481 \|
1268	JSON::XS/2 \| 227951.304 \| 218453.333 \|	1499	JSON::XS/3 \| 361577.931 \| 361577.931 \|
1269	JSON::XS/3 \| 338250.323 \| 218453.333 \|	1500	Storable \| 66788.280 \| 265462.278 \|
1270	Storable \| 16500.016 \| 135300.129 \|
1271	-----------+------------+------------+	1501	--------------+------------+------------+
1272		1502
1273	That is, JSON::XS is about five times faster than JSON::DWIW on encoding,	1503	That is, JSON::XS is almost six times faster than JSON::DWIW on encoding,
1274	about three times faster on decoding, and over forty times faster	1504	about five times faster on decoding, and over thirty to seventy times
1275	than JSON, even with pretty-printing and key sorting. It also compares	1505	faster than JSON's pure perl implementation. It also compares favourably
1276	favourably to Storable for small amounts of data.	1506	to Storable for small amounts of data.
1277		1507
1278	Using a longer test string (roughly 18KB, generated from Yahoo! Locals	1508	Using a longer test string (roughly 18KB, generated from Yahoo! Locals
1279	search API (L<http://dist.schmorp.de/misc/json/long.json>).	1509	search API (L<http://dist.schmorp.de/misc/json/long.json>).
1280		1510
1281	module \| encode \| decode \|	1511	module \| encode \| decode \|
1282	-----------\|------------\|------------\|	1512	--------------\|------------\|------------\|
1283	JSON 1.x \| 55.260 \| 34.971 \|	1513	JSON::DWIW/DS \| 1647.927 \| 2673.916 \|
1284	JSON::DWIW \| 825.228 \| 1082.513 \|	1514	JSON::DWIW/FJ \| 1630.249 \| 2596.128 \|
1285	JSON::PC \| 3571.444 \| 2394.829 \|
1286	JSON::PP \| 210.987 \| 32.574 \|	1515	JSON::PP \| 400.640 \| 62.311 \|
1287	JSON::Syck \| 552.551 \| 787.544 \|	1516	JSON::Syck \| 1481.040 \| 1524.869 \|
1288	JSON::XS \| 5780.463 \| 4854.519 \|	1517	JSON::XS \| 20661.596 \| 9541.183 \|
1289	JSON::XS/2 \| 3869.998 \| 4798.975 \|	1518	JSON::XS/2 \| 10683.403 \| 9416.938 \|
1290	JSON::XS/3 \| 5862.880 \| 4798.975 \|	1519	JSON::XS/3 \| 20661.596 \| 9400.054 \|
1291	Storable \| 4445.002 \| 5235.027 \|	1520	Storable \| 19765.806 \| 10000.725 \|
1292	-----------+------------+------------+	1521	--------------+------------+------------+
1293		1522
1294	Again, JSON::XS leads by far (except for Storable which non-surprisingly	1523	Again, JSON::XS leads by far (except for Storable which non-surprisingly
1295	decodes faster).	1524	decodes a bit faster).
1296		1525
1297	On large strings containing lots of high Unicode characters, some modules	1526	On large strings containing lots of high Unicode characters, some modules
1298	(such as JSON::PC) seem to decode faster than JSON::XS, but the result	1527	(such as JSON::PC) seem to decode faster than JSON::XS, but the result
1299	will be broken due to missing (or wrong) Unicode handling. Others refuse	1528	will be broken due to missing (or wrong) Unicode handling. Others refuse
1300	to decode or encode properly, so it was impossible to prepare a fair	1529	to decode or encode properly, so it was impossible to prepare a fair
…		…
1336	information you might want to make sure that exceptions thrown by JSON::XS	1565	information you might want to make sure that exceptions thrown by JSON::XS
1337	will not end up in front of untrusted eyes.	1566	will not end up in front of untrusted eyes.
1338		1567
1339	If you are using JSON::XS to return packets to consumption	1568	If you are using JSON::XS to return packets to consumption
1340	by JavaScript scripts in a browser you should have a look at	1569	by JavaScript scripts in a browser you should have a look at
1341	L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether	1570	L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to
1342	you are vulnerable to some common attack vectors (which really are browser	1571	see whether you are vulnerable to some common attack vectors (which really
1343	design bugs, but it is still you who will have to deal with it, as major	1572	are browser design bugs, but it is still you who will have to deal with
1344	browser developers care only for features, not about getting security	1573	it, as major browser developers care only for features, not about getting
1345	right).	1574	security right).
1346		1575
1347		1576
		1577	=head2 "OLD" VS. "NEW" JSON (RFC 4627 VS. RFC 7159)
		1578
		1579	JSON originally required JSON texts to represent an array or object -
		1580	scalar values were explicitly not allowed. This has changed, and versions
		1581	of JSON::XS beginning with C<4.0> reflect this by allowing scalar values
		1582	by default.
		1583
		1584	One reason why one might not want this is that this removes a fundamental
		1585	property of JSON texts, namely that they are self-delimited and
		1586	self-contained, or in other words, you could take any number of "old"
		1587	JSON texts and paste them together, and the result would be unambiguously
		1588	parseable:
		1589
		1590	[1,3]{"k":5}[][null] # four JSON texts, without doubt
		1591
		1592	By allowing scalars, this property is lost: in the following example, is
		1593	this one JSON text (the number 12) or two JSON texts (the numbers 1 and
		1594	2):
		1595
		1596	12 # could be 12, or 1 and 2
		1597
		1598	Another lost property of "old" JSON is that no lookahead is required to
		1599	know the end of a JSON text, i.e. the JSON text definitely ended at the
		1600	last C<]> or C<}> character, there was no need to read extra characters.
		1601
		1602	For example, a viable network protocol with "old" JSON was to simply
		1603	exchange JSON texts without delimiter. For "new" JSON, you have to use a
		1604	suitable delimiter (such as a newline) after every JSON text or ensure you
		1605	never encode/decode scalar values.
		1606
		1607	Most protocols do work by only transferring arrays or objects, and the
		1608	easiest way to avoid problems with the "new" JSON definition is to
		1609	explicitly disallow scalar values in your encoder and decoder:
		1610
		1611	$json_coder = JSON::XS->new->allow_nonref (0)
		1612
		1613	This is a somewhat unhappy situation, and the blame can fully be put on
		1614	JSON's inmventor, Douglas Crockford, who unilaterally changed the format
		1615	in 2006 without consulting the IETF, forcing the IETF to either fork the
		1616	format or go with it (as I was told, the IETF wasn't amused).
		1617
		1618
		1619	=head1 INTEROPERABILITY WITH OTHER MODULES
		1620
		1621	C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean
		1622	constants. That means that the JSON true and false values will be
		1623	comaptible to true and false values of other modules that do the same,
		1624	such as L<JSON::PP> and L<CBOR::XS>.
		1625
		1626
		1627	=head1 INTEROPERABILITY WITH OTHER JSON DECODERS
		1628
		1629	As long as you only serialise data that can be directly expressed in JSON,
		1630	C<JSON::XS> is incapable of generating invalid JSON output (modulo bugs,
		1631	but C<JSON::XS> has found more bugs in the official JSON testsuite (1)
		1632	than the official JSON testsuite has found in C<JSON::XS> (0)).
		1633
		1634	When you have trouble decoding JSON generated by this module using other
		1635	decoders, then it is very likely that you have an encoding mismatch or the
		1636	other decoder is broken.
		1637
		1638	When decoding, C<JSON::XS> is strict by default and will likely catch all
		1639	errors. There are currently two settings that change this: C<relaxed>
		1640	makes C<JSON::XS> accept (but not generate) some non-standard extensions,
		1641	and C<allow_tags> will allow you to encode and decode Perl objects, at the
		1642	cost of not outputting valid JSON anymore.
		1643
		1644	=head2 TAGGED VALUE SYNTAX AND STANDARD JSON EN/DECODERS
		1645
		1646	When you use C<allow_tags> to use the extended (and also nonstandard and
		1647	invalid) JSON syntax for serialised objects, and you still want to decode
		1648	the generated When you want to serialise objects, you can run a regex
		1649	to replace the tagged syntax by standard JSON arrays (it only works for
		1650	"normal" package names without comma, newlines or single colons). First,
		1651	the readable Perl version:
		1652
		1653	# if your FREEZE methods return no values, you need this replace first:
		1654	$json =~ s/$ \s* (" (?: [^\\":,]+\|\\.\|::)* ") \s* $ \s* \[\s*\]/[$1]/gx;
		1655
		1656	# this works for non-empty constructor arg lists:
		1657	$json =~ s/$ \s* (" (?: [^\\":,]+\|\\.\|::)* ") \s* $ \s* \[/[$1,/gx;
		1658
		1659	And here is a less readable version that is easy to adapt to other
		1660	languages:
		1661
		1662	$json =~ s/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/[$1,/g;
		1663
		1664	Here is an ECMAScript version (same regex):
		1665
		1666	json = json.replace (/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/g, "[$1,");
		1667
		1668	Since this syntax converts to standard JSON arrays, it might be hard to
		1669	distinguish serialised objects from normal arrays. You can prepend a
		1670	"magic number" as first array element to reduce chances of a collision:
		1671
		1672	$json =~ s/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/["XU1peReLzT4ggEllLanBYq4G9VzliwKF",$1,/g;
		1673
		1674	And after decoding the JSON text, you could walk the data
		1675	structure looking for arrays with a first element of
		1676	C<XU1peReLzT4ggEllLanBYq4G9VzliwKF>.
		1677
		1678	The same approach can be used to create the tagged format with another
		1679	encoder. First, you create an array with the magic string as first member,
		1680	the classname as second, and constructor arguments last, encode it as part
		1681	of your JSON structure, and then:
		1682
		1683	$json =~ s/\[\s"XU1peReLzT4ggEllLanBYq4G9VzliwKF"\s,\s("([^\\":,]+\|\\.\|::)")\s*,/($1)[/g;
		1684
		1685	Again, this has some limitations - the magic string must not be encoded
		1686	with character escapes, and the constructor arguments must be non-empty.
		1687
		1688
		1689	=head1 RFC7159
		1690
		1691	Since this module was written, Google has written a new JSON RFC, RFC 7159
		1692	(and RFC7158). Unfortunately, this RFC breaks compatibility with both the
		1693	original JSON specification on www.json.org and RFC4627.
		1694
		1695	As far as I can see, you can get partial compatibility when parsing by
		1696	using C<< ->allow_nonref >>. However, consider the security implications
		1697	of doing so.
		1698
		1699	I haven't decided yet when to break compatibility with RFC4627 by default
		1700	(and potentially leave applications insecure) and change the default to
		1701	follow RFC7159, but application authors are well advised to call C<<
		1702	->allow_nonref(0) >> even if this is the current default, if they cannot
		1703	handle non-reference values, in preparation for the day when the default
		1704	will change.
		1705
		1706
1348	=head1 THREADS	1707	=head1 (I-)THREADS
1349		1708
1350	This module is I<not> guaranteed to be thread safe and there are no	1709	This module is I<not> guaranteed to be ithread (or MULTIPLICITY-) safe
1351	plans to change this until Perl gets thread support (as opposed to the	1710	and there are no plans to change this. Note that perl's builtin so-called
1352	horribly slow so-called "threads" which are simply slow and bloated	1711	threads/ithreads are officially deprecated and should not be used.
1353	process simulations - use fork, it's I<much> faster, cheaper, better).
1354		1712
1355	(It might actually work, but you have been warned).	1713
		1714	=head1 THE PERILS OF SETLOCALE
		1715
		1716	Sometimes people avoid the Perl locale support and directly call the
		1717	system's setlocale function with C<LC_ALL>.
		1718
		1719	This breaks both perl and modules such as JSON::XS, as stringification of
		1720	numbers no longer works correctly (e.g. C<$x = 0.1; print "$x"+1> might
		1721	print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on
		1722	perl to stringify numbers).
		1723
		1724	The solution is simple: don't call C<setlocale>, or use it for only those
		1725	categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>.
		1726
		1727	If you need C<LC_NUMERIC>, you should enable it only around the code that
		1728	actually needs it (avoiding stringification of numbers), and restore it
		1729	afterwards.
1356		1730
1357		1731
1358	=head1 BUGS	1732	=head1 BUGS
1359		1733
1360	While the goal of this module is to be correct, that unfortunately does	1734	While the goal of this module is to be correct, that unfortunately does
…		…
1364	Please refrain from using rt.cpan.org or any other bug reporting	1738	Please refrain from using rt.cpan.org or any other bug reporting
1365	service. I put the contact address into my modules for a reason.	1739	service. I put the contact address into my modules for a reason.
1366		1740
1367	=cut	1741	=cut
1368		1742
1369	our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };	1743	BEGIN {
1370	our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };	1744	*true = \$Types::Serialiser::true;
		1745	*true = \&Types::Serialiser::true;
		1746	*false = \$Types::Serialiser::false;
		1747	*false = \&Types::Serialiser::false;
		1748	*is_bool = \&Types::Serialiser::is_bool;
1371		1749
1372	sub true() { $true }	1750	JSON::XS::Boolean:: = Types::Serialiser::Boolean::;
1373	sub false() { $false }
1374
1375	sub is_bool($) {
1376	UNIVERSAL::isa $_[0], "JSON::XS::Boolean"
1377	# or UNIVERSAL::isa $_[0], "JSON::Literal"
1378	}	1751	}
1379		1752
1380	XSLoader::load "JSON::XS", $VERSION;	1753	XSLoader::load "JSON::XS", $VERSION;
1381
1382	package JSON::XS::Boolean;
1383
1384	use overload
1385	"0+" => sub { ${$_[0]} },
1386	"++" => sub { $_[0] = ${$_[0]} + 1 },
1387	"--" => sub { $_[0] = ${$_[0]} - 1 },
1388	fallback => 1;
1389
1390	1;
1391		1754
1392	=head1 SEE ALSO	1755	=head1 SEE ALSO
1393		1756
1394	The F<json_xs> command line utility for quick experiments.	1757	The F<json_xs> command line utility for quick experiments.
1395		1758
…		…
1398	Marc Lehmann <schmorp@schmorp.de>	1761	Marc Lehmann <schmorp@schmorp.de>
1399	http://home.schmorp.de/	1762	http://home.schmorp.de/
1400		1763
1401	=cut	1764	=cut
1402		1765
		1766	1
		1767

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.113 by root, Thu Nov 20 03:59:53 2008 UTC vs. Revision 1.169 by root, Thu Nov 15 20:49:12 2018 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.113 by root, Thu Nov 20 03:59:53 2008 UTC vs.
Revision 1.169 by root, Thu Nov 15 20:49:12 2018 UTC