[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.67 by root, Mon Oct 15 01:22:34 2007 UTC

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

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.67 by root, Mon Oct 15 01:22:34 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.67 by root, Mon Oct 15 01:22:34 2007 UTC