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

Comparing JSON-XS/XS.pm (file contents):
Revision 1.50 by root, Mon Jul 2 00:29:38 2007 UTC vs.
Revision 1.65 by root, Sat Oct 13 01:55:31 2007 UTC

…		…
		1	=encoding utf-8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	JSON::XS - JSON serialising/deserialising, done correctly and fast	5	JSON::XS - JSON serialising/deserialising, done correctly and fast
		6
		7	JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ
		8	(http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html)
4		9
5	=head1 SYNOPSIS	10	=head1 SYNOPSIS
6		11
7	use JSON::XS;	12	use JSON::XS;
8		13
81		86
82	package JSON::XS;	87	package JSON::XS;
83		88
84	use strict;	89	use strict;
85		90
86	our $VERSION = '1.4';	91	our $VERSION = '1.51';
87	our @ISA = qw(Exporter);	92	our @ISA = qw(Exporter);
88		93
89	our @EXPORT = qw(to_json from_json);	94	our @EXPORT = qw(to_json from_json);
90		95
91	use Exporter;	96	use Exporter;
…		…
98		103
99	=over 4	104	=over 4
100		105
101	=item $json_text = to_json $perl_scalar	106	=item $json_text = to_json $perl_scalar
102		107
103	Converts the given Perl data structure (a simple scalar or a reference to	108	Converts the given Perl data structure to a UTF-8 encoded, binary string
104	a hash or array) to a UTF-8 encoded, binary string (that is, the string contains	109	(that is, the string contains octets only). Croaks on error.
105	octets only). Croaks on error.
106		110
107	This function call is functionally identical to:	111	This function call is functionally identical to:
108		112
109	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)	113	$json_text = JSON::XS->new->utf8->encode ($perl_scalar)
110		114
111	except being faster.	115	except being faster.
112		116
113	=item $perl_scalar = from_json $json_text	117	=item $perl_scalar = from_json $json_text
114		118
115	The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to	119	The opposite of C<to_json>: expects an UTF-8 (binary) string and tries
116	parse that as an UTF-8 encoded JSON text, returning the resulting simple	120	to parse that as an UTF-8 encoded JSON text, returning the resulting
117	scalar or reference. Croaks on error.	121	reference. Croaks on error.
118		122
119	This function call is functionally identical to:	123	This function call is functionally identical to:
120		124
121	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)	125	$perl_scalar = JSON::XS->new->utf8->decode ($json_text)
122		126
…		…
130		134
131	See MAPPING, below, for more information on how JSON values are mapped to	135	See MAPPING, below, for more information on how JSON values are mapped to
132	Perl.	136	Perl.
133		137
134	=back	138	=back
		139
		140
		141	=head1 A FEW NOTES ON UNICODE AND PERL
		142
		143	Since this often leads to confusion, here are a few very clear words on
		144	how Unicode works in Perl, modulo bugs.
		145
		146	=over 4
		147
		148	=item 1. Perl strings can store characters with ordinal values > 255.
		149
		150	This enables you to store unicode characters as single characters in a
		151	Perl string - very natural.
		152
		153	=item 2. Perl does I<not> associate an encoding with your strings.
		154
		155	Unless you force it to, e.g. when matching it against a regex, or printing
		156	the scalar to a file, in which case Perl either interprets your string as
		157	locale-encoded text, octets/binary, or as Unicode, depending on various
		158	settings. In no case is an encoding stored together with your data, it is
		159	I<use> that decides encoding, not any magical metadata.
		160
		161	=item 3. The internal utf-8 flag has no meaning with regards to the
		162	encoding of your string.
		163
		164	Just ignore that flag unless you debug a Perl bug, a module written in
		165	XS or want to dive into the internals of perl. Otherwise it will only
		166	confuse you, as, despite the name, it says nothing about how your string
		167	is encoded. You can have unicode strings with that flag set, with that
		168	flag clear, and you can have binary data with that flag set and that flag
		169	clear. Other possibilities exist, too.
		170
		171	If you didn't know about that flag, just the better, pretend it doesn't
		172	exist.
		173
		174	=item 4. A "Unicode String" is simply a string where each character can be
		175	validly interpreted as a Unicode codepoint.
		176
		177	If you have UTF-8 encoded data, it is no longer a Unicode string, but a
		178	Unicode string encoded in UTF-8, giving you a binary string.
		179
		180	=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string.
		181
		182	Its a fact. Learn to live with it.
		183
		184	=back
		185
		186	I hope this helps :)
135		187
136		188
137	=head1 OBJECT-ORIENTED INTERFACE	189	=head1 OBJECT-ORIENTED INTERFACE
138		190
139	The object oriented interface lets you configure your own encoding or	191	The object oriented interface lets you configure your own encoding or
…		…
278		330
279	Example, space_before and indent disabled, space_after enabled:	331	Example, space_before and indent disabled, space_after enabled:
280		332
281	{"key": "value"}	333	{"key": "value"}
282		334
		335	=item $json = $json->relaxed ([$enable])
		336
		337	If C<$enable> is true (or missing), then C<decode> will accept some
		338	extensions to normal JSON syntax (see below). C<encode> will not be
		339	affected in anyway. I<Be aware that this option makes you accept invalid
		340	JSON texts as if they were valid!>. I suggest only to use this option to
		341	parse application-specific files written by humans (configuration files,
		342	resource files etc.)
		343
		344	If C<$enable> is false (the default), then C<decode> will only accept
		345	valid JSON texts.
		346
		347	Currently accepted extensions are:
		348
		349	=over 4
		350
		351	=item * list items can have an end-comma
		352
		353	JSON I<separates> array elements and key-value pairs with commas. This
		354	can be annoying if you write JSON texts manually and want to be able to
		355	quickly append elements, so this extension accepts comma at the end of
		356	such items not just between them:
		357
		358	[
		359	1,
		360	2, <- this comma not normally allowed
		361	]
		362	{
		363	"k1": "v1",
		364	"k2": "v2", <- this comma not normally allowed
		365	}
		366
		367	=item * shell-style '#'-comments
		368
		369	Whenever JSON allows whitespace, shell-style comments are additionally
		370	allowed. They are terminated by the first carriage-return or line-feed
		371	character, after which more white-space and comments are allowed.
		372
		373	[
		374	1, # this comment not allowed in JSON
		375	# neither this one...
		376	]
		377
		378	=back
		379
283	=item $json = $json->canonical ([$enable])	380	=item $json = $json->canonical ([$enable])
284		381
285	If C<$enable> is true (or missing), then the C<encode> method will output JSON objects	382	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.	383	by sorting their keys. This is adding a comparatively high overhead.
287		384
…		…
347	future, global hooks might get installed that influence C<decode> and are	444	future, global hooks might get installed that influence C<decode> and are
348	enabled by this setting.	445	enabled by this setting.
349		446
350	If C<$enable> is false, then the C<allow_blessed> setting will decide what	447	If C<$enable> is false, then the C<allow_blessed> setting will decide what
351	to do when a blessed object is found.	448	to do when a blessed object is found.
		449
		450	=item $json = $json->filter_json_object ([$coderef->($hashref)])
		451
		452	When C<$coderef> is specified, it will be called from C<decode> each
		453	time it decodes a JSON object. The only argument is a reference to the
		454	newly-created hash. If the code references returns a single scalar (which
		455	need not be a reference), this value (i.e. a copy of that scalar to avoid
		456	aliasing) is inserted into the deserialised data structure. If it returns
		457	an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the
		458	original deserialised hash will be inserted. This setting can slow down
		459	decoding considerably.
		460
		461	When C<$coderef> is omitted or undefined, any existing callback will
		462	be removed and C<decode> will not change the deserialised hash in any
		463	way.
		464
		465	Example, convert all JSON objects into the integer 5:
		466
		467	my $js = JSON::XS->new->filter_json_object (sub { 5 });
		468	# returns [5]
		469	$js->decode ('[{}]')
		470	# throw an exception because allow_nonref is not enabled
		471	# so a lone 5 is not allowed.
		472	$js->decode ('{"a":1, "b":2}');
		473
		474	=item $json = $json->filter_json_single_key_object ($key [=> $coderef->($value)])
		475
		476	Works remotely similar to C<filter_json_object>, but is only called for
		477	JSON objects having a single key named C<$key>.
		478
		479	This C<$coderef> is called before the one specified via
		480	C<filter_json_object>, if any. It gets passed the single value in the JSON
		481	object. If it returns a single value, it will be inserted into the data
		482	structure. If it returns nothing (not even C<undef> but the empty list),
		483	the callback from C<filter_json_object> will be called next, as if no
		484	single-key callback were specified.
		485
		486	If C<$coderef> is omitted or undefined, the corresponding callback will be
		487	disabled. There can only ever be one callback for a given key.
		488
		489	As this callback gets called less often then the C<filter_json_object>
		490	one, decoding speed will not usually suffer as much. Therefore, single-key
		491	objects make excellent targets to serialise Perl objects into, especially
		492	as single-key JSON objects are as close to the type-tagged value concept
		493	as JSON gets (its basically an ID/VALUE tuple). Of course, JSON does not
		494	support this in any way, so you need to make sure your data never looks
		495	like a serialised Perl hash.
		496
		497	Typical names for the single object key are C<__class_whatever__>, or
		498	C<$__dollars_are_rarely_used__$> or C<}ugly_brace_placement>, or even
		499	things like C<__class_md5sum(classname)__>, to reduce the risk of clashing
		500	with real hashes.
		501
		502	Example, decode JSON objects of the form C<< { "__widget__" => <id> } >>
		503	into the corresponding C<< $WIDGET{<id>} >> object:
		504
		505	# return whatever is in $WIDGET{5}:
		506	JSON::XS
		507	->new
		508	->filter_json_single_key_object (__widget__ => sub {
		509	$WIDGET{ $_[0] }
		510	})
		511	->decode ('{"__widget__": 5')
		512
		513	# this can be used with a TO_JSON method in some "widget" class
		514	# for serialisation to json:
		515	sub WidgetBase::TO_JSON {
		516	my ($self) = @_;
		517
		518	unless ($self->{id}) {
		519	$self->{id} = ..get..some..id..;
		520	$WIDGET{$self->{id}} = $self;
		521	}
		522
		523	{ __widget__ => $self->{id} }
		524	}
352		525
353	=item $json = $json->shrink ([$enable])	526	=item $json = $json->shrink ([$enable])
354		527
355	Perl usually over-allocates memory a bit when allocating space for	528	Perl usually over-allocates memory a bit when allocating space for
356	strings. This flag optionally resizes strings generated by either	529	strings. This flag optionally resizes strings generated by either
…		…
477	are represented by the same codepoints in the Perl string, so no manual	650	are represented by the same codepoints in the Perl string, so no manual
478	decoding is necessary.	651	decoding is necessary.
479		652
480	=item number	653	=item number
481		654
482	A JSON number becomes either an integer or numeric (floating point)	655	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	656	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	657	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	658	the conversion details, but an integer may take slightly less memory and
486	represent more values exactly than (floating point) numbers.	659	might represent more values exactly than (floating point) numbers.
		660
		661	If the number consists of digits only, JSON::XS will try to represent
		662	it as an integer value. If that fails, it will try to represent it as
		663	a numeric (floating point) value if that is possible without loss of
		664	precision. Otherwise it will preserve the number as a string value.
		665
		666	Numbers containing a fractional or exponential part will always be
		667	represented as numeric (floating point) values, possibly at a loss of
		668	precision.
		669
		670	This might create round-tripping problems as numbers might become strings,
		671	but as Perl is typeless there is no other way to do it.
487		672
488	=item true, false	673	=item true, false
489		674
490	These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,	675	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	676	respectively. They are overloaded to act almost exactly like the numbers
…		…
533	to_json [\0,JSON::XS::true] # yields [false,true]	718	to_json [\0,JSON::XS::true] # yields [false,true]
534		719
535	=item JSON::XS::true, JSON::XS::false	720	=item JSON::XS::true, JSON::XS::false
536		721
537	These special values become JSON true and JSON false values,	722	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.	723	respectively. You can also use C<\1> and C<\0> directly if you want.
539		724
540	=item blessed objects	725	=item blessed objects
541		726
542	Blessed objects are not allowed. JSON::XS currently tries to encode their	727	Blessed objects are not allowed. JSON::XS currently tries to encode their
543	underlying representation (hash- or arrayref), but this behaviour might	728	underlying representation (hash- or arrayref), but this behaviour might
…		…
793	design bugs, but it is still you who will have to deal with it, as major	978	design bugs, but it is still you who will have to deal with it, as major
794	browser developers care only for features, not about doing security	979	browser developers care only for features, not about doing security
795	right).	980	right).
796		981
797		982
		983	=head1 THREADS
		984
		985	This module is I<not> guarenteed to be thread safe and there are no
		986	plans to change this until Perl gets thread support (as opposed to the
		987	horribly slow so-called "threads" which are simply slow and bloated
		988	process simulations - use fork, its I<much> faster, cheaper, better).
		989
		990	(It might actually work, but you ahve ben warned).
		991
		992
798	=head1 BUGS	993	=head1 BUGS
799		994
800	While the goal of this module is to be correct, that unfortunately does	995	While the goal of this module is to be correct, that unfortunately does
801	not mean its bug-free, only that I think its design is bug-free. It is	996	not mean its bug-free, only that I think its design is bug-free. It is
802	still relatively early in its development. If you keep reporting bugs they	997	still relatively early in its development. If you keep reporting bugs they
803	will be fixed swiftly, though.	998	will be fixed swiftly, though.
804		999
		1000	Please refrain from using rt.cpan.org or any other bug reporting
		1001	service. I put the contact address into my modules for a reason.
		1002
805	=cut	1003	=cut
806		1004
807	our $true = do { bless \(my $dummy = "1"), "JSON::XS::Boolean" };	1005	our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };
808	our $false = do { bless \(my $dummy = "0"), "JSON::XS::Boolean" };	1006	our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };
809		1007
810	sub true() { $true }	1008	sub true() { $true }
811	sub false() { $false }	1009	sub false() { $false }
812		1010
813	sub is_bool($) {	1011	sub is_bool($) {

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.50 by root, Mon Jul 2 00:29:38 2007 UTC vs. Revision 1.65 by root, Sat Oct 13 01:55:31 2007 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.50 by root, Mon Jul 2 00:29:38 2007 UTC vs.
Revision 1.65 by root, Sat Oct 13 01:55:31 2007 UTC