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.138 by root, Wed Aug 1 19:04:41 2012 UTC vs.
Revision 1.139 by root, Thu May 23 09:31:32 2013 UTC

101 101
102package JSON::XS; 102package JSON::XS;
103 103
104use common::sense; 104use common::sense;
105 105
106our $VERSION = '2.33'; 106our $VERSION = 2.34;
107our @ISA = qw(Exporter); 107our @ISA = qw(Exporter);
108 108
109our @EXPORT = qw(encode_json decode_json to_json from_json); 109our @EXPORT = qw(encode_json decode_json to_json from_json);
110 110
111sub to_json($) { 111sub to_json($) {
432If C<$enable> is true (or missing), then the C<encode> method will output JSON objects 432If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
433by sorting their keys. This is adding a comparatively high overhead. 433by sorting their keys. This is adding a comparatively high overhead.
434 434
435If C<$enable> is false, then the C<encode> method will output key-value 435If C<$enable> is false, then the C<encode> method will output key-value
436pairs in the order Perl stores them (which will likely change between runs 436pairs in the order Perl stores them (which will likely change between runs
437of the same script). 437of the same script, and can change even within the same run from 5.18
438onwards).
438 439
439This option is useful if you want the same data structure to be encoded as 440This option is useful if you want the same data structure to be encoded as
440the same JSON text (given the same overall settings). If it is disabled, 441the same JSON text (given the same overall settings). If it is disabled,
441the same hash might be encoded differently even if contains the same data, 442the same hash might be encoded differently even if contains the same data,
442as key-value pairs have no inherent ordering in Perl. 443as key-value pairs have no inherent ordering in Perl.
1445process simulations - use fork, it's I<much> faster, cheaper, better). 1446process simulations - use fork, it's I<much> faster, cheaper, better).
1446 1447
1447(It might actually work, but you have been warned). 1448(It might actually work, but you have been warned).
1448 1449
1449 1450
1451=head1 THE PERILS OF SETLOCALE
1452
1453Sometimes people avoid the Perl locale support and directly call the
1454system's setlocale function with C<LC_ALL>.
1455
1456This breaks both perl and modules such as JSON::XS, as stringification of
1457numbers no longer works correcly (e.g. C<$x = 0.1; print "$x"+1> might
1458print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on
1459perl to stringify numbers).
1460
1461The solution is simple: don't call C<setlocale>, or use it for only those
1462categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>.
1463
1464If you need C<LC_NUMERIC>, you should enable it only around the code that
1465actually needs it (avoiding stringification of numbers), and restore it
1466afterwards.
1467
1468
1450=head1 BUGS 1469=head1 BUGS
1451 1470
1452While the goal of this module is to be correct, that unfortunately does 1471While the goal of this module is to be correct, that unfortunately does
1453not mean it's bug-free, only that I think its design is bug-free. If you 1472not mean it's bug-free, only that I think its design is bug-free. If you
1454keep reporting bugs they will be fixed swiftly, though. 1473keep reporting bugs they will be fixed swiftly, though.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines