| … | |
… | |
| 83 | this module usually compares favourably in terms of speed, too. |
83 | this module usually compares favourably in terms of speed, too. |
| 84 | |
84 | |
| 85 | =item * simple to use |
85 | =item * simple to use |
| 86 | |
86 | |
| 87 | This module has both a simple functional interface as well as an object |
87 | This module has both a simple functional interface as well as an object |
| 88 | oriented interface interface. |
88 | oriented interface. |
| 89 | |
89 | |
| 90 | =item * reasonably versatile output formats |
90 | =item * reasonably versatile output formats |
| 91 | |
91 | |
| 92 | You can choose between the most compact guaranteed-single-line format |
92 | You can choose between the most compact guaranteed-single-line format |
| 93 | possible (nice for simple line-based protocols), a pure-ASCII format |
93 | possible (nice for simple line-based protocols), a pure-ASCII format |
| … | |
… | |
| 741 | |
741 | |
| 742 | If the method is called in scalar context, then it will try to extract |
742 | If the method is called in scalar context, then it will try to extract |
| 743 | exactly I<one> JSON object. If that is successful, it will return this |
743 | exactly I<one> JSON object. If that is successful, it will return this |
| 744 | object, otherwise it will return C<undef>. If there is a parse error, |
744 | object, otherwise it will return C<undef>. If there is a parse error, |
| 745 | this method will croak just as C<decode> would do (one can then use |
745 | this method will croak just as C<decode> would do (one can then use |
| 746 | C<incr_skip> to skip the errornous part). This is the most common way of |
746 | C<incr_skip> to skip the erroneous part). This is the most common way of |
| 747 | using the method. |
747 | using the method. |
| 748 | |
748 | |
| 749 | And finally, in list context, it will try to extract as many objects |
749 | And finally, in list context, it will try to extract as many objects |
| 750 | from the stream as it can find and return them, or the empty list |
750 | from the stream as it can find and return them, or the empty list |
| 751 | otherwise. For this to work, there must be no separators between the JSON |
751 | otherwise. For this to work, there must be no separators between the JSON |
| … | |
… | |
| 780 | C<incr_parse> died, in which case the input buffer and incremental parser |
780 | C<incr_parse> died, in which case the input buffer and incremental parser |
| 781 | state is left unchanged, to skip the text parsed so far and to reset the |
781 | state is left unchanged, to skip the text parsed so far and to reset the |
| 782 | parse state. |
782 | parse state. |
| 783 | |
783 | |
| 784 | The difference to C<incr_reset> is that only text until the parse error |
784 | The difference to C<incr_reset> is that only text until the parse error |
| 785 | occured is removed. |
785 | occurred is removed. |
| 786 | |
786 | |
| 787 | =item $json->incr_reset |
787 | =item $json->incr_reset |
| 788 | |
788 | |
| 789 | This completely resets the incremental parser, that is, after this call, |
789 | This completely resets the incremental parser, that is, after this call, |
| 790 | it will be as if the parser had never parsed anything. |
790 | it will be as if the parser had never parsed anything. |
| … | |
… | |
| 988 | If the number consists of digits only, JSON::XS will try to represent |
988 | If the number consists of digits only, JSON::XS will try to represent |
| 989 | it as an integer value. If that fails, it will try to represent it as |
989 | it as an integer value. If that fails, it will try to represent it as |
| 990 | a numeric (floating point) value if that is possible without loss of |
990 | a numeric (floating point) value if that is possible without loss of |
| 991 | precision. Otherwise it will preserve the number as a string value (in |
991 | precision. Otherwise it will preserve the number as a string value (in |
| 992 | which case you lose roundtripping ability, as the JSON number will be |
992 | which case you lose roundtripping ability, as the JSON number will be |
| 993 | re-encoded toa JSON string). |
993 | re-encoded to a JSON string). |
| 994 | |
994 | |
| 995 | Numbers containing a fractional or exponential part will always be |
995 | Numbers containing a fractional or exponential part will always be |
| 996 | represented as numeric (floating point) values, possibly at a loss of |
996 | represented as numeric (floating point) values, possibly at a loss of |
| 997 | precision (in which case you might lose perfect roundtripping ability, but |
997 | precision (in which case you might lose perfect roundtripping ability, but |
| 998 | the JSON number will still be re-encoded as a JSON number). |
998 | the JSON number will still be re-encoded as a JSON number). |
| 999 | |
999 | |
| 1000 | Note that precision is not accuracy - binary floating point values cannot |
1000 | Note that precision is not accuracy - binary floating point values cannot |
| 1001 | represent most decimal fractions exactly, and when converting from and to |
1001 | represent most decimal fractions exactly, and when converting from and to |
| 1002 | floating point, JSON::XS only guarantees precision up to but not including |
1002 | floating point, JSON::XS only guarantees precision up to but not including |
| 1003 | the leats significant bit. |
1003 | the least significant bit. |
| 1004 | |
1004 | |
| 1005 | =item true, false |
1005 | =item true, false |
| 1006 | |
1006 | |
| 1007 | These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
1007 | These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
| 1008 | respectively. They are overloaded to act almost exactly like the numbers |
1008 | respectively. They are overloaded to act almost exactly like the numbers |
| … | |
… | |
| 1138 | =item C<utf8> flag disabled |
1138 | =item C<utf8> flag disabled |
| 1139 | |
1139 | |
| 1140 | When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
1140 | When C<utf8> is disabled (the default), then C<encode>/C<decode> generate |
| 1141 | and expect Unicode strings, that is, characters with high ordinal Unicode |
1141 | and expect Unicode strings, that is, characters with high ordinal Unicode |
| 1142 | values (> 255) will be encoded as such characters, and likewise such |
1142 | values (> 255) will be encoded as such characters, and likewise such |
| 1143 | characters are decoded as-is, no canges to them will be done, except |
1143 | characters are decoded as-is, no changes to them will be done, except |
| 1144 | "(re-)interpreting" them as Unicode codepoints or Unicode characters, |
1144 | "(re-)interpreting" them as Unicode codepoints or Unicode characters, |
| 1145 | respectively (to Perl, these are the same thing in strings unless you do |
1145 | respectively (to Perl, these are the same thing in strings unless you do |
| 1146 | funny/weird/dumb stuff). |
1146 | funny/weird/dumb stuff). |
| 1147 | |
1147 | |
| 1148 | This is useful when you want to do the encoding yourself (e.g. when you |
1148 | This is useful when you want to do the encoding yourself (e.g. when you |
| … | |
… | |
| 1264 | output for these property strings, e.g.: |
1264 | output for these property strings, e.g.: |
| 1265 | |
1265 | |
| 1266 | $json =~ s/"__proto__"\s*:/"__proto__renamed":/g; |
1266 | $json =~ s/"__proto__"\s*:/"__proto__renamed":/g; |
| 1267 | |
1267 | |
| 1268 | This works because C<__proto__> is not valid outside of strings, so every |
1268 | This works because C<__proto__> is not valid outside of strings, so every |
| 1269 | occurence of C<"__proto__"\s*:> must be a string used as property name. |
1269 | occurrence of C<"__proto__"\s*:> must be a string used as property name. |
| 1270 | |
1270 | |
| 1271 | If you know of other incompatibilities, please let me know. |
1271 | If you know of other incompatibilities, please let me know. |
| 1272 | |
1272 | |
| 1273 | |
1273 | |
| 1274 | =head2 JSON and YAML |
1274 | =head2 JSON and YAML |
| … | |
… | |
| 1452 | |
1452 | |
| 1453 | Sometimes people avoid the Perl locale support and directly call the |
1453 | Sometimes people avoid the Perl locale support and directly call the |
| 1454 | system's setlocale function with C<LC_ALL>. |
1454 | system's setlocale function with C<LC_ALL>. |
| 1455 | |
1455 | |
| 1456 | This breaks both perl and modules such as JSON::XS, as stringification of |
1456 | This breaks both perl and modules such as JSON::XS, as stringification of |
| 1457 | numbers no longer works correcly (e.g. C<$x = 0.1; print "$x"+1> might |
1457 | numbers no longer works correctly (e.g. C<$x = 0.1; print "$x"+1> might |
| 1458 | print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on |
1458 | print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on |
| 1459 | perl to stringify numbers). |
1459 | perl to stringify numbers). |
| 1460 | |
1460 | |
| 1461 | The solution is simple: don't call C<setlocale>, or use it for only those |
1461 | The solution is simple: don't call C<setlocale>, or use it for only those |
| 1462 | categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>. |
1462 | categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>. |
