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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC vs.
Revision 1.172 by root, Thu Nov 15 23:07:55 2018 UTC

…		…
35		35
36	This module converts Perl data structures to JSON and vice versa. Its	36	This module converts Perl data structures to JSON and vice versa. Its
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
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
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
45	gives you a portable JSON API that can be fast when you need and doesn't
46	require a C compiler when that is a problem.
47
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
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
52	reports for other reasons.
53
54	See MAPPING, below, on how JSON::XS maps perl values to JSON values and	40	See MAPPING, below, on how JSON::XS maps perl values to JSON values and
55	vice versa.	41	vice versa.
56		42
57	=head2 FEATURES	43	=head2 FEATURES
58		44
59	=over 4	45	=over
60		46
61	=item * correct Unicode handling	47	=item * correct Unicode handling
62		48
63	This module knows how to handle Unicode, documents how and when it does	49	This module knows how to handle Unicode, documents how and when it does
64	so, and even documents what "correct" means.	50	so, and even documents what "correct" means.
…		…
101		87
102	package JSON::XS;	88	package JSON::XS;
103		89
104	use common::sense;	90	use common::sense;
105		91
106	our $VERSION = 2.34;	92	our $VERSION = '4.0_00';
107	our @ISA = qw(Exporter);	93	our @ISA = qw(Exporter);
108		94
109	our @EXPORT = qw(encode_json decode_json);	95	our @EXPORT = qw(encode_json decode_json);
110		96
111	use Exporter;	97	use Exporter;
…		…
116	=head1 FUNCTIONAL INTERFACE	102	=head1 FUNCTIONAL INTERFACE
117		103
118	The following convenience methods are provided by this module. They are	104	The following convenience methods are provided by this module. They are
119	exported by default:	105	exported by default:
120		106
121	=over 4	107	=over
122		108
123	=item $json_text = encode_json $perl_scalar	109	=item $json_text = encode_json $perl_scalar
124		110
125	Converts the given Perl data structure to a UTF-8 encoded, binary string	111	Converts the given Perl data structure to a UTF-8 encoded, binary string
126	(that is, the string contains octets only). Croaks on error.	112	(that is, the string contains octets only). Croaks on error.
…		…
131		117
132	Except being faster.	118	Except being faster.
133		119
134	=item $perl_scalar = decode_json $json_text	120	=item $perl_scalar = decode_json $json_text
135		121
136	The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries	122	The opposite of C<encode_json>: expects a UTF-8 (binary) string and tries
137	to parse that as an UTF-8 encoded JSON text, returning the resulting	123	to parse that as a UTF-8 encoded JSON text, returning the resulting
138	reference. Croaks on error.	124	reference. Croaks on error.
139		125
140	This function call is functionally identical to:	126	This function call is functionally identical to:
141		127
142	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	128	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
…		…
149	=head1 A FEW NOTES ON UNICODE AND PERL	135	=head1 A FEW NOTES ON UNICODE AND PERL
150		136
151	Since this often leads to confusion, here are a few very clear words on	137	Since this often leads to confusion, here are a few very clear words on
152	how Unicode works in Perl, modulo bugs.	138	how Unicode works in Perl, modulo bugs.
153		139
154	=over 4	140	=over
155		141
156	=item 1. Perl strings can store characters with ordinal values > 255.	142	=item 1. Perl strings can store characters with ordinal values > 255.
157		143
158	This enables you to store Unicode characters as single characters in a	144	This enables you to store Unicode characters as single characters in a
159	Perl string - very natural.	145	Perl string - very natural.
…		…
197	=head1 OBJECT-ORIENTED INTERFACE	183	=head1 OBJECT-ORIENTED INTERFACE
198		184
199	The object oriented interface lets you configure your own encoding or	185	The object oriented interface lets you configure your own encoding or
200	decoding style, within the limits of supported formats.	186	decoding style, within the limits of supported formats.
201		187
202	=over 4	188	=over
203		189
204	=item $json = new JSON::XS	190	=item $json = new JSON::XS
205		191
206	Creates a new JSON::XS object that can be used to de/encode JSON	192	Creates a new JSON::XS object that can be used to de/encode JSON
207	strings. All boolean flags described below are by default I<disabled>.	193	strings. All boolean flags described below are by default I<disabled>
		194	(with the exception of C<allow_nonref>, which defaults to I<enabled> since
		195	version C<4.0>).
208		196
209	The mutators for flags all return the JSON object again and thus calls can	197	The mutators for flags all return the JSON object again and thus calls can
210	be chained:	198	be chained:
211		199
212	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})	200	my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
…		…
270		258
271	=item $enabled = $json->get_utf8	259	=item $enabled = $json->get_utf8
272		260
273	If C<$enable> is true (or missing), then the C<encode> method will encode	261	If C<$enable> is true (or missing), then the C<encode> method will encode
274	the JSON result into UTF-8, as required by many protocols, while the	262	the JSON result into UTF-8, as required by many protocols, while the
275	C<decode> method expects to be handled an UTF-8-encoded string. Please	263	C<decode> method expects to be handed a UTF-8-encoded string. Please
276	note that UTF-8-encoded strings do not contain any characters outside the	264	note that UTF-8-encoded strings do not contain any characters outside the
277	range C<0..255>, they are thus useful for bytewise/binary I/O. In future	265	range C<0..255>, they are thus useful for bytewise/binary I/O. In future
278	versions, enabling this option might enable autodetection of the UTF-16	266	versions, enabling this option might enable autodetection of the UTF-16
279	and UTF-32 encoding families, as described in RFC4627.	267	and UTF-32 encoding families, as described in RFC4627.
280		268
…		…
365		353
366	=item $enabled = $json->get_relaxed	354	=item $enabled = $json->get_relaxed
367		355
368	If C<$enable> is true (or missing), then C<decode> will accept some	356	If C<$enable> is true (or missing), then C<decode> will accept some
369	extensions to normal JSON syntax (see below). C<encode> will not be	357	extensions to normal JSON syntax (see below). C<encode> will not be
370	affected in anyway. I<Be aware that this option makes you accept invalid	358	affected in any way. I<Be aware that this option makes you accept invalid
371	JSON texts as if they were valid!>. I suggest only to use this option to	359	JSON texts as if they were valid!>. I suggest only to use this option to
372	parse application-specific files written by humans (configuration files,	360	parse application-specific files written by humans (configuration files,
373	resource files etc.)	361	resource files etc.)
374		362
375	If C<$enable> is false (the default), then C<decode> will only accept	363	If C<$enable> is false (the default), then C<decode> will only accept
376	valid JSON texts.	364	valid JSON texts.
377		365
378	Currently accepted extensions are:	366	Currently accepted extensions are:
379		367
380	=over 4	368	=over
381		369
382	=item * list items can have an end-comma	370	=item * list items can have an end-comma
383		371
384	JSON I<separates> array elements and key-value pairs with commas. This	372	JSON I<separates> array elements and key-value pairs with commas. This
385	can be annoying if you write JSON texts manually and want to be able to	373	can be annoying if you write JSON texts manually and want to be able to
…		…
404	[	392	[
405	1, # this comment not allowed in JSON	393	1, # this comment not allowed in JSON
406	# neither this one...	394	# neither this one...
407	]	395	]
408		396
		397	=item * literal ASCII TAB characters in strings
		398
		399	Literal ASCII TAB characters are now allowed in strings (and treated as
		400	C<\t>).
		401
		402	[
		403	"Hello\tWorld",
		404	"Hello<TAB>World", # literal <TAB> would not normally be allowed
		405	]
		406
409	=back	407	=back
410		408
411	=item $json = $json->canonical ([$enable])	409	=item $json = $json->canonical ([$enable])
412		410
413	=item $enabled = $json->get_canonical	411	=item $enabled = $json->get_canonical
…		…
431		429
432	=item $json = $json->allow_nonref ([$enable])	430	=item $json = $json->allow_nonref ([$enable])
433		431
434	=item $enabled = $json->get_allow_nonref	432	=item $enabled = $json->get_allow_nonref
435		433
		434	Unlike other boolean options, this opotion is enabled by default beginning
		435	with version C<4.0>. See L<SECURITY CONSIDERATIONS> for the gory details.
		436
436	If C<$enable> is true (or missing), then the C<encode> method can convert a	437	If C<$enable> is true (or missing), then the C<encode> method can convert a
437	non-reference into its corresponding string, number or null JSON value,	438	non-reference into its corresponding string, number or null JSON value,
438	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON	439	which is an extension to RFC4627. Likewise, C<decode> will accept those JSON
439	values instead of croaking.	440	values instead of croaking.
440		441
441	If C<$enable> is false, then the C<encode> method will croak if it isn't	442	If C<$enable> is false, then the C<encode> method will croak if it isn't
442	passed an arrayref or hashref, as JSON texts must either be an object	443	passed an arrayref or hashref, as JSON texts must either be an object
443	or array. Likewise, C<decode> will croak if given something that is not a	444	or array. Likewise, C<decode> will croak if given something that is not a
444	JSON object or array.	445	JSON object or array.
445		446
446	Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>,	447	Example, encode a Perl scalar as JSON value without enabled C<allow_nonref>,
447	resulting in an invalid JSON text:	448	resulting in an error:
448		449
449	JSON::XS->new->allow_nonref->encode ("Hello, World!")	450	JSON::XS->new->allow_nonref (0)->encode ("Hello, World!")
450	=> "Hello, World!"	451	=> hash- or arrayref expected...
451		452
452	=item $json = $json->allow_unknown ([$enable])	453	=item $json = $json->allow_unknown ([$enable])
453		454
454	=item $enabled = $json->get_allow_unknown	455	=item $enabled = $json->get_allow_unknown
455		456
…		…
467		468
468	=item $json = $json->allow_blessed ([$enable])	469	=item $json = $json->allow_blessed ([$enable])
469		470
470	=item $enabled = $json->get_allow_blessed	471	=item $enabled = $json->get_allow_blessed
471		472
		473	See L<OBJECT SERIALISATION> for details.
		474
472	If C<$enable> is true (or missing), then the C<encode> method will not	475	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	476	barf when it encounters a blessed reference that it cannot convert
474	B<convert_blessed> option will decide whether C<null> (C<convert_blessed>	477	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		478
479	If C<$enable> is false (the default), then C<encode> will throw an	479	If C<$enable> is false (the default), then C<encode> will throw an
480	exception when it encounters a blessed object.	480	exception when it encounters a blessed object that it cannot convert
		481	otherwise.
		482
		483	This setting has no effect on C<decode>.
481		484
482	=item $json = $json->convert_blessed ([$enable])	485	=item $json = $json->convert_blessed ([$enable])
483		486
484	=item $enabled = $json->get_convert_blessed	487	=item $enabled = $json->get_convert_blessed
		488
		489	See L<OBJECT SERIALISATION> for details.
485		490
486	If C<$enable> is true (or missing), then C<encode>, upon encountering a	491	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	492	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	493	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	494	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		495
493	The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON>	496	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	497	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	498	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	499	(== 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	500	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>	501	usually in upper case letters and to avoid collisions with any C<to_json>
499	function or method.	502	function or method.
500		503
501	This setting does not yet influence C<decode> in any way, but in the	504	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	505	this type of conversion.
503	enabled by this setting.
504		506
505	If C<$enable> is false, then the C<allow_blessed> setting will decide what	507	This setting has no effect on C<decode>.
506	to do when a blessed object is found.	508
		509	=item $json = $json->allow_tags ([$enable])
		510
		511	=item $enabled = $json->get_allow_tags
		512
		513	See L<OBJECT SERIALISATION> for details.
		514
		515	If C<$enable> is true (or missing), then C<encode>, upon encountering a
		516	blessed object, will check for the availability of the C<FREEZE> method on
		517	the object's class. If found, it will be used to serialise the object into
		518	a nonstandard tagged JSON value (that JSON decoders cannot decode).
		519
		520	It also causes C<decode> to parse such tagged JSON values and deserialise
		521	them via a call to the C<THAW> method.
		522
		523	If C<$enable> is false (the default), then C<encode> will not consider
		524	this type of conversion, and tagged JSON values will cause a parse error
		525	in C<decode>, as if tags were not part of the grammar.
		526
		527	=item $json->boolean_values ([$false, $true])
		528
		529	=item ($false, $true) = $json->get_boolean_values
		530
		531	By default, JSON booleans will be decoded as overloaded
		532	C<$Types::Serialiser::false> and C<$Types::Serialiser::true> objects.
		533
		534	With this method you can specify your own boolean values for decoding -
		535	on decode, JSON C<false> will be decoded as a copy of C<$false>, and JSON
		536	C<true> will be decoded as C<$true> ("copy" here is the same thing as
		537	assigning a value to another variable, i.e. C<$copy = $false>).
		538
		539	Calling this method without any arguments will reset the booleans
		540	to their default values.
		541
		542	C<get_boolean_values> will return both C<$false> and C<$true> values, or
		543	the empty list when they are set to the default.
507		544
508	=item $json = $json->filter_json_object ([$coderef->($hashref)])	545	=item $json = $json->filter_json_object ([$coderef->($hashref)])
509		546
510	When C<$coderef> is specified, it will be called from C<decode> each	547	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	548	time it decodes a JSON object. The only argument is a reference to
512	newly-created hash. If the code references returns a single scalar (which	549	the newly-created hash. If the code reference returns a single scalar
513	need not be a reference), this value (i.e. a copy of that scalar to avoid	550	(which need not be a reference), this value (or rather a copy of it) is
514	aliasing) is inserted into the deserialised data structure. If it returns	551	inserted into the deserialised data structure. If it returns an empty
515	an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the	552	list (NOTE: I<not> C<undef>, which is a valid scalar), the original
516	original deserialised hash will be inserted. This setting can slow down	553	deserialised hash will be inserted. This setting can slow down decoding
517	decoding considerably.	554	considerably.
518		555
519	When C<$coderef> is omitted or undefined, any existing callback will	556	When C<$coderef> is omitted or undefined, any existing callback will
520	be removed and C<decode> will not change the deserialised hash in any	557	be removed and C<decode> will not change the deserialised hash in any
521	way.	558	way.
522		559
…		…
669		706
670	This is useful if your JSON texts are not delimited by an outer protocol	707	This is useful if your JSON texts are not delimited by an outer protocol
671	and you need to know where the JSON text ends.	708	and you need to know where the JSON text ends.
672		709
673	JSON::XS->new->decode_prefix ("[1] the tail")	710	JSON::XS->new->decode_prefix ("[1] the tail")
674	=> ([], 3)	711	=> ([1], 3)
675		712
676	=back	713	=back
677		714
678		715
679	=head1 INCREMENTAL PARSING	716	=head1 INCREMENTAL PARSING
…		…
696	to set resource limits (e.g. C<max_size>) to ensure the parser will stop	733	to set resource limits (e.g. C<max_size>) to ensure the parser will stop
697	parsing in the presence if syntax errors.	734	parsing in the presence if syntax errors.
698		735
699	The following methods implement this incremental parser.	736	The following methods implement this incremental parser.
700		737
701	=over 4	738	=over
702		739
703	=item [void, scalar or list context] = $json->incr_parse ([$string])	740	=item [void, scalar or list context] = $json->incr_parse ([$string])
704		741
705	This is the central parsing function. It can both append new text and	742	This is the central parsing function. It can both append new text and
706	extract objects from the stream accumulated so far (both of these	743	extract objects from the stream accumulated so far (both of these
…		…
720	C<incr_skip> to skip the erroneous part). This is the most common way of	757	C<incr_skip> to skip the erroneous part). This is the most common way of
721	using the method.	758	using the method.
722		759
723	And finally, in list context, it will try to extract as many objects	760	And finally, in list context, it will try to extract as many objects
724	from the stream as it can find and return them, or the empty list	761	from the stream as it can find and return them, or the empty list
725	otherwise. For this to work, there must be no separators between the JSON	762	otherwise. For this to work, there must be no separators (other than
726	objects or arrays, instead they must be concatenated back-to-back. If	763	whitespace) between the JSON objects or arrays, instead they must be
727	an error occurs, an exception will be raised as in the scalar context	764	concatenated back-to-back. If an error occurs, an exception will be
728	case. Note that in this case, any previously-parsed JSON texts will be	765	raised as in the scalar context case. Note that in this case, any
729	lost.	766	previously-parsed JSON texts will be lost.
730		767
731	Example: Parse some JSON arrays/objects in a given string and return	768	Example: Parse some JSON arrays/objects in a given string and return
732	them.	769	them.
733		770
734	my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");	771	my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
…		…
741	all other circumstances you must not call this function (I mean it.	778	all other circumstances you must not call this function (I mean it.
742	although in simple tests it might actually work, it I<will> fail under	779	although in simple tests it might actually work, it I<will> fail under
743	real world conditions). As a special exception, you can also call this	780	real world conditions). As a special exception, you can also call this
744	method before having parsed anything.	781	method before having parsed anything.
745		782
		783	That means you can only use this function to look at or manipulate text
		784	before or after complete JSON objects, not while the parser is in the
		785	middle of parsing a JSON object.
		786
746	This function is useful in two cases: a) finding the trailing text after a	787	This function is useful in two cases: a) finding the trailing text after a
747	JSON object or b) parsing multiple JSON objects separated by non-JSON text	788	JSON object or b) parsing multiple JSON objects separated by non-JSON text
748	(such as commas).	789	(such as commas).
749		790
750	=item $json->incr_skip	791	=item $json->incr_skip
…		…
769		810
770	=back	811	=back
771		812
772	=head2 LIMITATIONS	813	=head2 LIMITATIONS
773		814
774	All options that affect decoding are supported, except	815	The incremental parser is a non-exact parser: it works by gathering as
775	C<allow_nonref>. The reason for this is that it cannot be made to work	816	much text as possible that I<could> be a valid JSON text, followed by
776	sensibly: JSON objects and arrays are self-delimited, i.e. you can	817	trying to decode it.
777	concatenate them back to back and still decode them perfectly. This does
778	not hold true for JSON numbers, however.
779		818
780	For example, is the string C<1> a single JSON number, or is it simply the	819	That means it sometimes needs to read more data than strictly necessary to
781	start of C<12>? Or is C<12> a single JSON number, or the concatenation	820	diagnose an invalid JSON text. For example, after parsing the following
782	of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS	821	fragment, the parser I<could> stop with an error, as this fragment
783	takes the conservative route and disallows this case.	822	I<cannot> be the beginning of a valid JSON text:
		823
		824	[,
		825
		826	In reality, hopwever, the parser might continue to read data until a
		827	length limit is exceeded or it finds a closing bracket.
784		828
785	=head2 EXAMPLES	829	=head2 EXAMPLES
786		830
787	Some examples will make all this clearer. First, a simple example that	831	Some examples will make all this clearer. First, a simple example that
788	works similarly to C<decode_prefix>: We want to decode the JSON object at	832	works similarly to C<decode_prefix>: We want to decode the JSON object at
…		…
932	refers to the abstract Perl language itself.	976	refers to the abstract Perl language itself.
933		977
934		978
935	=head2 JSON -> PERL	979	=head2 JSON -> PERL
936		980
937	=over 4	981	=over
938		982
939	=item object	983	=item object
940		984
941	A JSON object becomes a reference to a hash in Perl. No ordering of object	985	A JSON object becomes a reference to a hash in Perl. No ordering of object
942	keys is preserved (JSON does not preserve object key ordering itself).	986	keys is preserved (JSON does not preserve object key ordering itself).
…		…
986		1030
987	=item null	1031	=item null
988		1032
989	A JSON null atom becomes C<undef> in Perl.	1033	A JSON null atom becomes C<undef> in Perl.
990		1034
		1035	=item shell-style comments (C<< # I<text> >>)
		1036
		1037	As a nonstandard extension to the JSON syntax that is enabled by the
		1038	C<relaxed> setting, shell-style comments are allowed. They can start
		1039	anywhere outside strings and go till the end of the line.
		1040
		1041	=item tagged values (C<< (I<tag>)I<value> >>).
		1042
		1043	Another nonstandard extension to the JSON syntax, enabled with the
		1044	C<allow_tags> setting, are tagged values. In this implementation, the
		1045	I<tag> must be a perl package/class name encoded as a JSON string, and the
		1046	I<value> must be a JSON array encoding optional constructor arguments.
		1047
		1048	See L<OBJECT SERIALISATION>, below, for details.
		1049
991	=back	1050	=back
992		1051
993		1052
994	=head2 PERL -> JSON	1053	=head2 PERL -> JSON
995		1054
996	The mapping from Perl to JSON is slightly more difficult, as Perl is a	1055	The mapping from Perl to JSON is slightly more difficult, as Perl is a
997	truly typeless language, so we can only guess which JSON type is meant by	1056	truly typeless language, so we can only guess which JSON type is meant by
998	a Perl value.	1057	a Perl value.
999		1058
1000	=over 4	1059	=over
1001		1060
1002	=item hash references	1061	=item hash references
1003		1062
1004	Perl hash references become JSON objects. As there is no inherent	1063	Perl hash references become JSON objects. As there is no inherent
1005	ordering in hash keys (or JSON objects), they will usually be encoded	1064	ordering in hash keys (or JSON objects), they will usually be encoded
…		…
1032	and JSON false values, respectively. You can also use C<\1> and C<\0>	1091	and JSON false values, respectively. You can also use C<\1> and C<\0>
1033	directly if you want.	1092	directly if you want.
1034		1093
1035	=item blessed objects	1094	=item blessed objects
1036		1095
1037	Blessed objects are not directly representable in JSON. See the	1096	Blessed objects are not directly representable in JSON, but C<JSON::XS>
1038	C<allow_blessed> and C<convert_blessed> methods on various options on	1097	allows various ways of handling objects. See L<OBJECT SERIALISATION>,
1039	how to deal with this: basically, you can choose between throwing an	1098	below, for details.
1040	exception, encoding the reference as if it weren't blessed, or provide
1041	your own serialiser method.
1042		1099
1043	=item simple scalars	1100	=item simple scalars
1044		1101
1045	Simple Perl scalars (any scalar that is not a reference) are the most	1102	Simple Perl scalars (any scalar that is not a reference) are the most
1046	difficult objects to encode: JSON::XS will encode undefined scalars as	1103	difficult objects to encode: JSON::XS will encode undefined scalars as
…		…
1083	infinities or NaN's - these cannot be represented in JSON, and it is an	1140	infinities or NaN's - these cannot be represented in JSON, and it is an
1084	error to pass those in.	1141	error to pass those in.
1085		1142
1086	=back	1143	=back
1087		1144
		1145	=head2 OBJECT SERIALISATION
		1146
		1147	As JSON cannot directly represent Perl objects, you have to choose between
		1148	a pure JSON representation (without the ability to deserialise the object
		1149	automatically again), and a nonstandard extension to the JSON syntax,
		1150	tagged values.
		1151
		1152	=head3 SERIALISATION
		1153
		1154	What happens when C<JSON::XS> encounters a Perl object depends on the
		1155	C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are
		1156	used in this order:
		1157
		1158	=over
		1159
		1160	=item 1. C<allow_tags> is enabled and the object has a C<FREEZE> method.
		1161
		1162	In this case, C<JSON::XS> uses the L<Types::Serialiser> object
		1163	serialisation protocol to create a tagged JSON value, using a nonstandard
		1164	extension to the JSON syntax.
		1165
		1166	This works by invoking the C<FREEZE> method on the object, with the first
		1167	argument being the object to serialise, and the second argument being the
		1168	constant string C<JSON> to distinguish it from other serialisers.
		1169
		1170	The C<FREEZE> method can return any number of values (i.e. zero or
		1171	more). These values and the paclkage/classname of the object will then be
		1172	encoded as a tagged JSON value in the following format:
		1173
		1174	("classname")[FREEZE return values...]
		1175
		1176	e.g.:
		1177
		1178	("URI")["http://www.google.com/"]
		1179	("MyDate")[2013,10,29]
		1180	("ImageData::JPEG")["Z3...VlCg=="]
		1181
		1182	For example, the hypothetical C<My::Object> C<FREEZE> method might use the
		1183	objects C<type> and C<id> members to encode the object:
		1184
		1185	sub My::Object::FREEZE {
		1186	my ($self, $serialiser) = @_;
		1187
		1188	($self->{type}, $self->{id})
		1189	}
		1190
		1191	=item 2. C<convert_blessed> is enabled and the object has a C<TO_JSON> method.
		1192
		1193	In this case, the C<TO_JSON> method of the object is invoked in scalar
		1194	context. It must return a single scalar that can be directly encoded into
		1195	JSON. This scalar replaces the object in the JSON text.
		1196
		1197	For example, the following C<TO_JSON> method will convert all L<URI>
		1198	objects to JSON strings when serialised. The fatc that these values
		1199	originally were L<URI> objects is lost.
		1200
		1201	sub URI::TO_JSON {
		1202	my ($uri) = @_;
		1203	$uri->as_string
		1204	}
		1205
		1206	=item 3. C<allow_blessed> is enabled.
		1207
		1208	The object will be serialised as a JSON null value.
		1209
		1210	=item 4. none of the above
		1211
		1212	If none of the settings are enabled or the respective methods are missing,
		1213	C<JSON::XS> throws an exception.
		1214
		1215	=back
		1216
		1217	=head3 DESERIALISATION
		1218
		1219	For deserialisation there are only two cases to consider: either
		1220	nonstandard tagging was used, in which case C<allow_tags> decides,
		1221	or objects cannot be automatically be deserialised, in which
		1222	case you can use postprocessing or the C<filter_json_object> or
		1223	C<filter_json_single_key_object> callbacks to get some real objects our of
		1224	your JSON.
		1225
		1226	This section only considers the tagged value case: I a tagged JSON object
		1227	is encountered during decoding and C<allow_tags> is disabled, a parse
		1228	error will result (as if tagged values were not part of the grammar).
		1229
		1230	If C<allow_tags> is enabled, C<JSON::XS> will look up the C<THAW> method
		1231	of the package/classname used during serialisation (it will not attempt
		1232	to load the package as a Perl module). If there is no such method, the
		1233	decoding will fail with an error.
		1234
		1235	Otherwise, the C<THAW> method is invoked with the classname as first
		1236	argument, the constant string C<JSON> as second argument, and all the
		1237	values from the JSON array (the values originally returned by the
		1238	C<FREEZE> method) as remaining arguments.
		1239
		1240	The method must then return the object. While technically you can return
		1241	any Perl scalar, you might have to enable the C<enable_nonref> setting to
		1242	make that work in all cases, so better return an actual blessed reference.
		1243
		1244	As an example, let's implement a C<THAW> function that regenerates the
		1245	C<My::Object> from the C<FREEZE> example earlier:
		1246
		1247	sub My::Object::THAW {
		1248	my ($class, $serialiser, $type, $id) = @_;
		1249
		1250	$class->new (type => $type, id => $id)
		1251	}
		1252
1088		1253
1089	=head1 ENCODING/CODESET FLAG NOTES	1254	=head1 ENCODING/CODESET FLAG NOTES
1090		1255
1091	The interested reader might have seen a number of flags that signify	1256	The interested reader might have seen a number of flags that signify
1092	encodings or codesets - C<utf8>, C<latin1> and C<ascii>. There seems to be	1257	encodings or codesets - C<utf8>, C<latin1> and C<ascii>. There seems to be
…		…
1109	takes those codepoint numbers and I<encodes> them, in our case into	1274	takes those codepoint numbers and I<encodes> them, in our case into
1110	octets. Unicode is (among other things) a codeset, UTF-8 is an encoding,	1275	octets. Unicode is (among other things) a codeset, UTF-8 is an encoding,
1111	and ISO-8859-1 (= latin 1) and ASCII are both codesets I<and> encodings at	1276	and ISO-8859-1 (= latin 1) and ASCII are both codesets I<and> encodings at
1112	the same time, which can be confusing.	1277	the same time, which can be confusing.
1113		1278
1114	=over 4	1279	=over
1115		1280
1116	=item C<utf8> flag disabled	1281	=item C<utf8> flag disabled
1117		1282
1118	When C<utf8> is disabled (the default), then C<encode>/C<decode> generate	1283	When C<utf8> is disabled (the default), then C<encode>/C<decode> generate
1119	and expect Unicode strings, that is, characters with high ordinal Unicode	1284	and expect Unicode strings, that is, characters with high ordinal Unicode
…		…
1136	expect your input strings to be encoded as UTF-8, that is, no "character"	1301	expect your input strings to be encoded as UTF-8, that is, no "character"
1137	of the input string must have any value > 255, as UTF-8 does not allow	1302	of the input string must have any value > 255, as UTF-8 does not allow
1138	that.	1303	that.
1139		1304
1140	The C<utf8> flag therefore switches between two modes: disabled means you	1305	The C<utf8> flag therefore switches between two modes: disabled means you
1141	will get a Unicode string in Perl, enabled means you get an UTF-8 encoded	1306	will get a Unicode string in Perl, enabled means you get a UTF-8 encoded
1142	octet/binary string in Perl.	1307	octet/binary string in Perl.
1143		1308
1144	=item C<latin1> or C<ascii> flags enabled	1309	=item C<latin1> or C<ascii> flags enabled
1145		1310
1146	With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters	1311	With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters
…		…
1278	general you should not try to generate YAML with a JSON generator or vice	1443	general you should not try to generate YAML with a JSON generator or vice
1279	versa, or try to parse JSON with a YAML parser or vice versa: chances are	1444	versa, or try to parse JSON with a YAML parser or vice versa: chances are
1280	high that you will run into severe interoperability problems when you	1445	high that you will run into severe interoperability problems when you
1281	least expect it.	1446	least expect it.
1282		1447
1283	=over 4	1448	=over
1284		1449
1285	=item (*)	1450	=item (*)
1286		1451
1287	I have been pressured multiple times by Brian Ingerson (one of the	1452	I have been pressured multiple times by Brian Ingerson (one of the
1288	authors of the YAML specification) to remove this paragraph, despite him	1453	authors of the YAML specification) to remove this paragraph, despite him
…		…
1414	are browser design bugs, but it is still you who will have to deal with	1579	are browser design bugs, but it is still you who will have to deal with
1415	it, as major browser developers care only for features, not about getting	1580	it, as major browser developers care only for features, not about getting
1416	security right).	1581	security right).
1417		1582
1418		1583
		1584	=head2 "OLD" VS. "NEW" JSON (RFC4627 VS. RFC7159)
		1585
		1586	JSON originally required JSON texts to represent an array or object -
		1587	scalar values were explicitly not allowed. This has changed, and versions
		1588	of JSON::XS beginning with C<4.0> reflect this by allowing scalar values
		1589	by default.
		1590
		1591	One reason why one might not want this is that this removes a fundamental
		1592	property of JSON texts, namely that they are self-delimited and
		1593	self-contained, or in other words, you could take any number of "old"
		1594	JSON texts and paste them together, and the result would be unambiguously
		1595	parseable:
		1596
		1597	[1,3]{"k":5}[][null] # four JSON texts, without doubt
		1598
		1599	By allowing scalars, this property is lost: in the following example, is
		1600	this one JSON text (the number 12) or two JSON texts (the numbers 1 and
		1601	2):
		1602
		1603	12 # could be 12, or 1 and 2
		1604
		1605	Another lost property of "old" JSON is that no lookahead is required to
		1606	know the end of a JSON text, i.e. the JSON text definitely ended at the
		1607	last C<]> or C<}> character, there was no need to read extra characters.
		1608
		1609	For example, a viable network protocol with "old" JSON was to simply
		1610	exchange JSON texts without delimiter. For "new" JSON, you have to use a
		1611	suitable delimiter (such as a newline) after every JSON text or ensure you
		1612	never encode/decode scalar values.
		1613
		1614	Most protocols do work by only transferring arrays or objects, and the
		1615	easiest way to avoid problems with the "new" JSON definition is to
		1616	explicitly disallow scalar values in your encoder and decoder:
		1617
		1618	$json_coder = JSON::XS->new->allow_nonref (0)
		1619
		1620	This is a somewhat unhappy situation, and the blame can fully be put on
		1621	JSON's inmventor, Douglas Crockford, who unilaterally changed the format
		1622	in 2006 without consulting the IETF, forcing the IETF to either fork the
		1623	format or go with it (as I was told, the IETF wasn't amused).
		1624
		1625
		1626	=head1 RELATIONSHIP WITH I-JSON
		1627
		1628	JSON is a somewhat sloppily-defined format - it carries around obvious
		1629	Javascript baggage, such as not really defining number range, probably
		1630	because Javascript only has one type of numbers: IEEE 64 bit floats
		1631	("binary64").
		1632
		1633	For this reaosn, RFC7493 defines "Internet JSON", which is a restricted
		1634	subset of JSON that is supposedly more interoperable on the internet.
		1635
		1636	While C<JSON::XS> does not offer specific support for I-JSON, it of course
		1637	accepts valid I-JSON and by default implements some of the limitations
		1638	of I-JSON, such as parsing numbers as perl numbers, which are usually a
		1639	superset of binary64 numbers.
		1640
		1641	To generate I-JSON, follow these rules:
		1642
		1643	=over
		1644
		1645	=item * always generate UTF-8
		1646
		1647	I-JSON must be encoded in UTF-8, the default for C<encode_json>.
		1648
		1649	=item * numbers should be within IEEE 754 binary64 range
		1650
		1651	Basically all existing perl installations use binary64 to represent
		1652	floating point numbers, so all you need to do is to avoid large integers.
		1653
		1654	=item * objects must not have duplicate keys
		1655
		1656	This is trivially done, as C<JSON::XS> does not allow duplicate keys.
		1657
		1658	=item * do not generate scalar JSON texts, use C<< ->allow_nonref (0) >>
		1659
		1660	I-JSON strongly requests you to only encode arrays and objects into JSON.
		1661
		1662	=item * times should be strings in ISO 8601 format
		1663
		1664	There are a myriad of modules on CPAN dealing with ISO 8601 - search for
		1665	C<ISO8601> on CPAN and use one.
		1666
		1667	=item * encode binary data as base64
		1668
		1669	While it's tempting to just dump binary data as a string (and let
		1670	C<JSON::XS> do the escaping), for I-JSON, it's I<recommended> to encode
		1671	binary data as base64.
		1672
		1673	=back
		1674
		1675	There are some other considerations - read RFC7493 for the details if
		1676	interested.
		1677
		1678
1419	=head1 INTEROPERABILITY WITH OTHER MODULES	1679	=head1 INTEROPERABILITY WITH OTHER MODULES
1420		1680
1421	C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean	1681	C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean
1422	constants. That means that the JSON true and false values will be	1682	constants. That means that the JSON true and false values will be
1423	comaptible to true and false values of iother modules that do the same,	1683	comaptible to true and false values of other modules that do the same,
1424	such as L<JSON::PP> and L<CBOR::XS>.	1684	such as L<JSON::PP> and L<CBOR::XS>.
1425		1685
1426		1686
		1687	=head1 INTEROPERABILITY WITH OTHER JSON DECODERS
		1688
		1689	As long as you only serialise data that can be directly expressed in JSON,
		1690	C<JSON::XS> is incapable of generating invalid JSON output (modulo bugs,
		1691	but C<JSON::XS> has found more bugs in the official JSON testsuite (1)
		1692	than the official JSON testsuite has found in C<JSON::XS> (0)).
		1693
		1694	When you have trouble decoding JSON generated by this module using other
		1695	decoders, then it is very likely that you have an encoding mismatch or the
		1696	other decoder is broken.
		1697
		1698	When decoding, C<JSON::XS> is strict by default and will likely catch all
		1699	errors. There are currently two settings that change this: C<relaxed>
		1700	makes C<JSON::XS> accept (but not generate) some non-standard extensions,
		1701	and C<allow_tags> will allow you to encode and decode Perl objects, at the
		1702	cost of not outputting valid JSON anymore.
		1703
		1704	=head2 TAGGED VALUE SYNTAX AND STANDARD JSON EN/DECODERS
		1705
		1706	When you use C<allow_tags> to use the extended (and also nonstandard and
		1707	invalid) JSON syntax for serialised objects, and you still want to decode
		1708	the generated When you want to serialise objects, you can run a regex
		1709	to replace the tagged syntax by standard JSON arrays (it only works for
		1710	"normal" package names without comma, newlines or single colons). First,
		1711	the readable Perl version:
		1712
		1713	# if your FREEZE methods return no values, you need this replace first:
		1714	$json =~ s/$ \s* (" (?: [^\\":,]+\|\\.\|::)* ") \s* $ \s* \[\s*\]/[$1]/gx;
		1715
		1716	# this works for non-empty constructor arg lists:
		1717	$json =~ s/$ \s* (" (?: [^\\":,]+\|\\.\|::)* ") \s* $ \s* \[/[$1,/gx;
		1718
		1719	And here is a less readable version that is easy to adapt to other
		1720	languages:
		1721
		1722	$json =~ s/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/[$1,/g;
		1723
		1724	Here is an ECMAScript version (same regex):
		1725
		1726	json = json.replace (/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/g, "[$1,");
		1727
		1728	Since this syntax converts to standard JSON arrays, it might be hard to
		1729	distinguish serialised objects from normal arrays. You can prepend a
		1730	"magic number" as first array element to reduce chances of a collision:
		1731
		1732	$json =~ s/$\s("([^\\":,]+\|\\.\|::)")\s$\s\[/["XU1peReLzT4ggEllLanBYq4G9VzliwKF",$1,/g;
		1733
		1734	And after decoding the JSON text, you could walk the data
		1735	structure looking for arrays with a first element of
		1736	C<XU1peReLzT4ggEllLanBYq4G9VzliwKF>.
		1737
		1738	The same approach can be used to create the tagged format with another
		1739	encoder. First, you create an array with the magic string as first member,
		1740	the classname as second, and constructor arguments last, encode it as part
		1741	of your JSON structure, and then:
		1742
		1743	$json =~ s/\[\s"XU1peReLzT4ggEllLanBYq4G9VzliwKF"\s,\s("([^\\":,]+\|\\.\|::)")\s*,/($1)[/g;
		1744
		1745	Again, this has some limitations - the magic string must not be encoded
		1746	with character escapes, and the constructor arguments must be non-empty.
		1747
		1748
1427	=head1 THREADS	1749	=head1 (I-)THREADS
1428		1750
1429	This module is I<not> guaranteed to be thread safe and there are no	1751	This module is I<not> guaranteed to be ithread (or MULTIPLICITY-) safe
1430	plans to change this until Perl gets thread support (as opposed to the	1752	and there are no plans to change this. Note that perl's builtin so-called
1431	horribly slow so-called "threads" which are simply slow and bloated	1753	threads/ithreads are officially deprecated and should not be used.
1432	process simulations - use fork, it's I<much> faster, cheaper, better).
1433
1434	(It might actually work, but you have been warned).
1435		1754
1436		1755
1437	=head1 THE PERILS OF SETLOCALE	1756	=head1 THE PERILS OF SETLOCALE
1438		1757
1439	Sometimes people avoid the Perl locale support and directly call the	1758	Sometimes people avoid the Perl locale support and directly call the
…		…
1448	categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>.	1767	categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>.
1449		1768
1450	If you need C<LC_NUMERIC>, you should enable it only around the code that	1769	If you need C<LC_NUMERIC>, you should enable it only around the code that
1451	actually needs it (avoiding stringification of numbers), and restore it	1770	actually needs it (avoiding stringification of numbers), and restore it
1452	afterwards.	1771	afterwards.
		1772
		1773
		1774	=head1 SOME HISTORY
		1775
		1776	At the time this module was created there already were a number of JSON
		1777	modules available on CPAN, so what was the reason to write yet another
		1778	JSON module? While it seems there are many JSON modules, none of them
		1779	correctly handled all corner cases, and in most cases their maintainers
		1780	are unresponsive, gone missing, or not listening to bug reports for other
		1781	reasons.
		1782
		1783	Beginning with version 2.0 of the JSON module, when both JSON and
		1784	JSON::XS are installed, then JSON will fall back on JSON::XS (this can be
		1785	overridden) with no overhead due to emulation (by inheriting constructor
		1786	and methods). If JSON::XS is not available, it will fall back to the
		1787	compatible JSON::PP module as backend, so using JSON instead of JSON::XS
		1788	gives you a portable JSON API that can be fast when you need it and
		1789	doesn't require a C compiler when that is a problem.
		1790
		1791	Somewhere around version 3, this module was forked into
		1792	C<Cpanel::JSON::XS>, because its maintainer had serious trouble
		1793	understanding JSON and insisted on a fork with many bugs "fixed" that
		1794	weren't actually bugs, while spreading FUD about this module without
		1795	actually giving any details on his accusations. You be the judge, but
		1796	in my personal opinion, if you want quality, you will stay away from
		1797	dangerous forks like that.
1453		1798
1454		1799
1455	=head1 BUGS	1800	=head1 BUGS
1456		1801
1457	While the goal of this module is to be correct, that unfortunately does	1802	While the goal of this module is to be correct, that unfortunately does

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC vs. Revision 1.172 by root, Thu Nov 15 23:07:55 2018 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC vs.
Revision 1.172 by root, Thu Nov 15 23:07:55 2018 UTC