ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/JSON-XS/XS.pm
(Generate patch)

Comparing JSON-XS/XS.pm (file contents):
Revision 1.55 by root, Mon Jul 23 22:57:40 2007 UTC vs.
Revision 1.61 by root, Wed Sep 12 17:42:36 2007 UTC

… …
81 81
82package JSON::XS; 82package JSON::XS;
83 83
84use strict; 84use strict;
85 85
86our $VERSION = '1.42'; 86our $VERSION = '1.5';
87our @ISA = qw(Exporter); 87our @ISA = qw(Exporter);
88 88
89our @EXPORT = qw(to_json from_json); 89our @EXPORT = qw(to_json from_json);
90 90
91use Exporter; 91use Exporter;
… …
277This setting has no effect when decoding JSON texts. 277This setting has no effect when decoding JSON texts.
278 278
279Example, space_before and indent disabled, space_after enabled: 279Example, space_before and indent disabled, space_after enabled:
280 280
281 {"key": "value"} 281 {"key": "value"}
282
283=item $json = $json->relaxed ([$enable])
284
285If C<$enable> is true (or missing), then C<decode> will accept some
286extensions to normal JSON syntax (see below). C<encode> will not be
287affected in anyway. I<Be aware that this option makes you accept invalid
288JSON texts as if they were valid!>. I suggest only to use this option to
289parse application-specific files written by humans (configuration files,
290resource files etc.)
291
292If C<$enable> is false (the default), then C<decode> will only accept
293valid JSON texts.
294
295Currently accepted extensions are:
296
297=over 4
298
299=item * list items can have an end-comma
300
301JSON I<separates> array elements and key-value pairs with commas. This
302can be annoying if you write JSON texts manually and want to be able to
303quickly append elements, so this extension accepts comma at the end of
304such 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
317Whenever JSON allows whitespace, shell-style comments are additionally
318allowed. They are terminated by the first carriage-return or line-feed
319character, 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
282 327
283=item $json = $json->canonical ([$enable]) 328=item $json = $json->canonical ([$enable])
284 329
285If C<$enable> is true (or missing), then the C<encode> method will output JSON objects 330If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
286by sorting their keys. This is adding a comparatively high overhead. 331by sorting their keys. This is adding a comparatively high overhead.
… …
553are represented by the same codepoints in the Perl string, so no manual 598are represented by the same codepoints in the Perl string, so no manual
554decoding is necessary. 599decoding is necessary.
555 600
556=item number 601=item number
557 602
558A JSON number becomes either an integer or numeric (floating point) 603A JSON number becomes either an integer, numeric (floating point) or
559scalar in perl, depending on its range and any fractional parts. On the 604string scalar in perl, depending on its range and any fractional parts. On
560Perl level, there is no difference between those as Perl handles all the 605the Perl level, there is no difference between those as Perl handles all
561conversion details, but an integer may take slightly less memory and might 606the conversion details, but an integer may take slightly less memory and
562represent more values exactly than (floating point) numbers. 607might represent more values exactly than (floating point) numbers.
608
609If the number consists of digits only, JSON::XS will try to represent
610it as an integer value. If that fails, it will try to represent it as
611a numeric (floating point) value if that is possible without loss of
612precision. Otherwise it will preserve the number as a string value.
613
614Numbers containing a fractional or exponential part will always be
615represented as numeric (floating point) values, possibly at a loss of
616precision.
617
618This might create round-tripping problems as numbers might become strings,
619but as Perl is typeless there is no other way to do it.
563 620
564=item true, false 621=item true, false
565 622
566These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, 623These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,
567respectively. They are overloaded to act almost exactly like the numbers 624respectively. They are overloaded to act almost exactly like the numbers
… …
609 to_json [\0,JSON::XS::true] # yields [false,true] 666 to_json [\0,JSON::XS::true] # yields [false,true]
610 667
611=item JSON::XS::true, JSON::XS::false 668=item JSON::XS::true, JSON::XS::false
612 669
613These special values become JSON true and JSON false values, 670These special values become JSON true and JSON false values,
614respectively. You cna alos use C<\1> and C<\0> directly if you want. 671respectively. You can also use C<\1> and C<\0> directly if you want.
615 672
616=item blessed objects 673=item blessed objects
617 674
618Blessed objects are not allowed. JSON::XS currently tries to encode their 675Blessed objects are not allowed. JSON::XS currently tries to encode their
619underlying representation (hash- or arrayref), but this behaviour might 676underlying representation (hash- or arrayref), but this behaviour might

Diff Legend

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