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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.49 by root, Sun Jul 1 14:08:03 2007 UTC vs.
Revision 1.61 by root, Wed Sep 12 17:42:36 2007 UTC

…		…
81		81
82	package JSON::XS;	82	package JSON::XS;
83		83
84	use strict;	84	use strict;
85		85
86	our $VERSION = '1.4';	86	our $VERSION = '1.5';
87	our @ISA = qw(Exporter);	87	our @ISA = qw(Exporter);
88		88
89	our @EXPORT = qw(to_json from_json);	89	our @EXPORT = qw(to_json from_json);
90		90
91	use Exporter;	91	use Exporter;
…		…
278		278
279	Example, space_before and indent disabled, space_after enabled:	279	Example, space_before and indent disabled, space_after enabled:
280		280
281	{"key": "value"}	281	{"key": "value"}
282		282
		283	=item $json = $json->relaxed ([$enable])
		284
		285	If C<$enable> is true (or missing), then C<decode> will accept some
		286	extensions to normal JSON syntax (see below). C<encode> will not be
		287	affected in anyway. I<Be aware that this option makes you accept invalid
		288	JSON texts as if they were valid!>. I suggest only to use this option to
		289	parse application-specific files written by humans (configuration files,
		290	resource files etc.)
		291
		292	If C<$enable> is false (the default), then C<decode> will only accept
		293	valid JSON texts.
		294
		295	Currently accepted extensions are:
		296
		297	=over 4
		298
		299	=item * list items can have an end-comma
		300
		301	JSON I<separates> array elements and key-value pairs with commas. This
		302	can be annoying if you write JSON texts manually and want to be able to
		303	quickly append elements, so this extension accepts comma at the end of
		304	such items not just between them:
		305
		306	[
		307	1,
		308	2, <- this comma not normally allowed
		309	]
		310	{
		311	"k1": "v1",
		312	"k2": "v2", <- this comma not normally allowed
		313	}
		314
		315	=item * shell-style '#'-comments
		316
		317	Whenever JSON allows whitespace, shell-style comments are additionally
		318	allowed. They are terminated by the first carriage-return or line-feed
		319	character, after which more white-space and comments are allowed.
		320
		321	[
		322	1, # this comment not allowed in JSON
		323	# neither this one...
		324	]
		325
		326	=back
		327
283	=item $json = $json->canonical ([$enable])	328	=item $json = $json->canonical ([$enable])
284		329
285	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects	330	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
286	by sorting their keys. This is adding a comparatively high overhead.	331	by sorting their keys. This is adding a comparatively high overhead.
287		332
…		…
347	future, global hooks might get installed that influence C<decode> and are	392	future, global hooks might get installed that influence C<decode> and are
348	enabled by this setting.	393	enabled by this setting.
349		394
350	If C<$enable> is false, then the C<allow_blessed> setting will decide what	395	If C<$enable> is false, then the C<allow_blessed> setting will decide what
351	to do when a blessed object is found.	396	to do when a blessed object is found.
		397
		398	=item $json = $json->filter_json_object ([$coderef->($hashref)])
		399
		400	When C<$coderef> is specified, it will be called from C<decode> each
		401	time it decodes a JSON object. The only argument is a reference to the
		402	newly-created hash. If the code references returns a single scalar (which
		403	need not be a reference), this value (i.e. a copy of that scalar to avoid
		404	aliasing) is inserted into the deserialised data structure. If it returns
		405	an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the
		406	original deserialised hash will be inserted. This setting can slow down
		407	decoding considerably.
		408
		409	When C<$coderef> is omitted or undefined, any existing callback will
		410	be removed and C<decode> will not change the deserialised hash in any
		411	way.
		412
		413	Example, convert all JSON objects into the integer 5:
		414
		415	my $js = JSON::XS->new->filter_json_object (sub { 5 });
		416	# returns [5]
		417	$js->decode ('[{}]')
		418	# throw an exception because allow_nonref is not enabled
		419	# so a lone 5 is not allowed.
		420	$js->decode ('{"a":1, "b":2}');
		421
		422	=item $json = $json->filter_json_single_key_object ($key [=> $coderef->($value)])
		423
		424	Works remotely similar to C<filter_json_object>, but is only called for
		425	JSON objects having a single key named C<$key>.
		426
		427	This C<$coderef> is called before the one specified via
		428	C<filter_json_object>, if any. It gets passed the single value in the JSON
		429	object. If it returns a single value, it will be inserted into the data
		430	structure. If it returns nothing (not even C<undef> but the empty list),
		431	the callback from C<filter_json_object> will be called next, as if no
		432	single-key callback were specified.
		433
		434	If C<$coderef> is omitted or undefined, the corresponding callback will be
		435	disabled. There can only ever be one callback for a given key.
		436
		437	As this callback gets called less often then the C<filter_json_object>
		438	one, decoding speed will not usually suffer as much. Therefore, single-key
		439	objects make excellent targets to serialise Perl objects into, especially
		440	as single-key JSON objects are as close to the type-tagged value concept
		441	as JSON gets (its basically an ID/VALUE tuple). Of course, JSON does not
		442	support this in any way, so you need to make sure your data never looks
		443	like a serialised Perl hash.
		444
		445	Typical names for the single object key are C<__class_whatever__>, or
		446	C<$__dollars_are_rarely_used__$> or C<}ugly_brace_placement>, or even
		447	things like C<__class_md5sum(classname)__>, to reduce the risk of clashing
		448	with real hashes.
		449
		450	Example, decode JSON objects of the form C<< { "__widget__" => <id> } >>
		451	into the corresponding C<< $WIDGET{<id>} >> object:
		452
		453	# return whatever is in $WIDGET{5}:
		454	JSON::XS
		455	->new
		456	->filter_json_single_key_object (__widget__ => sub {
		457	$WIDGET{ $_[0] }
		458	})
		459	->decode ('{"__widget__": 5')
		460
		461	# this can be used with a TO_JSON method in some "widget" class
		462	# for serialisation to json:
		463	sub WidgetBase::TO_JSON {
		464	my ($self) = @_;
		465
		466	unless ($self->{id}) {
		467	$self->{id} = ..get..some..id..;
		468	$WIDGET{$self->{id}} = $self;
		469	}
		470
		471	{ __widget__ => $self->{id} }
		472	}
352		473
353	=item $json = $json->shrink ([$enable])	474	=item $json = $json->shrink ([$enable])
354		475
355	Perl usually over-allocates memory a bit when allocating space for	476	Perl usually over-allocates memory a bit when allocating space for
356	strings. This flag optionally resizes strings generated by either	477	strings. This flag optionally resizes strings generated by either
…		…
477	are represented by the same codepoints in the Perl string, so no manual	598	are represented by the same codepoints in the Perl string, so no manual
478	decoding is necessary.	599	decoding is necessary.
479		600
480	=item number	601	=item number
481		602
482	A JSON number becomes either an integer or numeric (floating point)	603	A JSON number becomes either an integer, numeric (floating point) or
483	scalar in perl, depending on its range and any fractional parts. On the	604	string scalar in perl, depending on its range and any fractional parts. On
484	Perl level, there is no difference between those as Perl handles all the	605	the Perl level, there is no difference between those as Perl handles all
485	conversion details, but an integer may take slightly less memory and might	606	the conversion details, but an integer may take slightly less memory and
486	represent more values exactly than (floating point) numbers.	607	might represent more values exactly than (floating point) numbers.
		608
		609	If the number consists of digits only, JSON::XS will try to represent
		610	it as an integer value. If that fails, it will try to represent it as
		611	a numeric (floating point) value if that is possible without loss of
		612	precision. Otherwise it will preserve the number as a string value.
		613
		614	Numbers containing a fractional or exponential part will always be
		615	represented as numeric (floating point) values, possibly at a loss of
		616	precision.
		617
		618	This might create round-tripping problems as numbers might become strings,
		619	but as Perl is typeless there is no other way to do it.
487		620
488	=item true, false	621	=item true, false
489		622
490	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,	623	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,
491	respectively. They are overloaded to act almost exactly like the numbers	624	respectively. They are overloaded to act almost exactly like the numbers
…		…
533	to_json [\0,JSON::XS::true] # yields [false,true]	666	to_json [\0,JSON::XS::true] # yields [false,true]
534		667
535	=item JSON::XS::true, JSON::XS::false	668	=item JSON::XS::true, JSON::XS::false
536		669
537	These special values become JSON true and JSON false values,	670	These special values become JSON true and JSON false values,
538	respectively. You cna alos use C<\1> and C<\0> directly if you want.	671	respectively. You can also use C<\1> and C<\0> directly if you want.
539		672
540	=item blessed objects	673	=item blessed objects
541		674
542	Blessed objects are not allowed. JSON::XS currently tries to encode their	675	Blessed objects are not allowed. JSON::XS currently tries to encode their
543	underlying representation (hash- or arrayref), but this behaviour might	676	underlying representation (hash- or arrayref), but this behaviour might

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.49 by root, Sun Jul 1 14:08:03 2007 UTC vs. Revision 1.61 by root, Wed Sep 12 17:42:36 2007 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.49 by root, Sun Jul 1 14:08:03 2007 UTC vs.
Revision 1.61 by root, Wed Sep 12 17:42:36 2007 UTC