… | |
… | |
40 | Beginning with version 2.0 of the JSON module, when both JSON and |
40 | Beginning with version 2.0 of the JSON module, when both JSON and |
41 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
41 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
42 | overridden) with no overhead due to emulation (by inheriting constructor |
42 | overridden) with no overhead due to emulation (by inheriting constructor |
43 | and methods). If JSON::XS is not available, it will fall back to the |
43 | and methods). If JSON::XS is not available, it will fall back to the |
44 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
44 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
45 | gives you a portable JSON API that can be fast when you need and doesn't |
45 | gives you a portable JSON API that can be fast when you need it and |
46 | require a C compiler when that is a problem. |
46 | doesn't require a C compiler when that is a problem. |
47 | |
47 | |
48 | As this is the n-th-something JSON module on CPAN, what was the reason |
48 | As this is the n-th-something JSON module on CPAN, what was the reason |
49 | to write yet another JSON module? While it seems there are many JSON |
49 | to write yet another JSON module? While it seems there are many JSON |
50 | modules, none of them correctly handle all corner cases, and in most cases |
50 | modules, none of them correctly handle all corner cases, and in most cases |
51 | their maintainers are unresponsive, gone missing, or not listening to bug |
51 | their maintainers are unresponsive, gone missing, or not listening to bug |
… | |
… | |
101 | |
101 | |
102 | package JSON::XS; |
102 | package JSON::XS; |
103 | |
103 | |
104 | use common::sense; |
104 | use common::sense; |
105 | |
105 | |
106 | our $VERSION = 3.03; |
106 | our $VERSION = 3.04; |
107 | our @ISA = qw(Exporter); |
107 | our @ISA = qw(Exporter); |
108 | |
108 | |
109 | our @EXPORT = qw(encode_json decode_json); |
109 | our @EXPORT = qw(encode_json decode_json); |
110 | |
110 | |
111 | use Exporter; |
111 | use Exporter; |
… | |
… | |
131 | |
131 | |
132 | Except being faster. |
132 | Except being faster. |
133 | |
133 | |
134 | =item $perl_scalar = decode_json $json_text |
134 | =item $perl_scalar = decode_json $json_text |
135 | |
135 | |
136 | The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries |
136 | The opposite of C<encode_json>: expects a UTF-8 (binary) string and tries |
137 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
137 | to parse that as a UTF-8 encoded JSON text, returning the resulting |
138 | reference. Croaks on error. |
138 | reference. Croaks on error. |
139 | |
139 | |
140 | This function call is functionally identical to: |
140 | This function call is functionally identical to: |
141 | |
141 | |
142 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
142 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
… | |
… | |
270 | |
270 | |
271 | =item $enabled = $json->get_utf8 |
271 | =item $enabled = $json->get_utf8 |
272 | |
272 | |
273 | If C<$enable> is true (or missing), then the C<encode> method will encode |
273 | If C<$enable> is true (or missing), then the C<encode> method will encode |
274 | the JSON result into UTF-8, as required by many protocols, while the |
274 | the JSON result into UTF-8, as required by many protocols, while the |
275 | C<decode> method expects to be handled an UTF-8-encoded string. Please |
275 | C<decode> method expects to be handed a UTF-8-encoded string. Please |
276 | note that UTF-8-encoded strings do not contain any characters outside the |
276 | note that UTF-8-encoded strings do not contain any characters outside the |
277 | range C<0..255>, they are thus useful for bytewise/binary I/O. In future |
277 | range C<0..255>, they are thus useful for bytewise/binary I/O. In future |
278 | versions, enabling this option might enable autodetection of the UTF-16 |
278 | versions, enabling this option might enable autodetection of the UTF-16 |
279 | and UTF-32 encoding families, as described in RFC4627. |
279 | and UTF-32 encoding families, as described in RFC4627. |
280 | |
280 | |
… | |
… | |
365 | |
365 | |
366 | =item $enabled = $json->get_relaxed |
366 | =item $enabled = $json->get_relaxed |
367 | |
367 | |
368 | If C<$enable> is true (or missing), then C<decode> will accept some |
368 | If C<$enable> is true (or missing), then C<decode> will accept some |
369 | extensions to normal JSON syntax (see below). C<encode> will not be |
369 | extensions to normal JSON syntax (see below). C<encode> will not be |
370 | affected in anyway. I<Be aware that this option makes you accept invalid |
370 | affected in any way. I<Be aware that this option makes you accept invalid |
371 | JSON texts as if they were valid!>. I suggest only to use this option to |
371 | JSON texts as if they were valid!>. I suggest only to use this option to |
372 | parse application-specific files written by humans (configuration files, |
372 | parse application-specific files written by humans (configuration files, |
373 | resource files etc.) |
373 | resource files etc.) |
374 | |
374 | |
375 | If C<$enable> is false (the default), then C<decode> will only accept |
375 | If C<$enable> is false (the default), then C<decode> will only accept |
… | |
… | |
515 | |
515 | |
516 | This setting has no effect on C<decode>. |
516 | This setting has no effect on C<decode>. |
517 | |
517 | |
518 | =item $json = $json->allow_tags ([$enable]) |
518 | =item $json = $json->allow_tags ([$enable]) |
519 | |
519 | |
520 | =item $enabled = $json->allow_tags |
520 | =item $enabled = $json->get_allow_tags |
521 | |
521 | |
522 | See L<OBJECT SERIALISATION> for details. |
522 | See L<OBJECT SERIALISATION> for details. |
523 | |
523 | |
524 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
524 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
525 | blessed object, will check for the availability of the C<FREEZE> method on |
525 | blessed object, will check for the availability of the C<FREEZE> method on |
… | |
… | |
534 | in C<decode>, as if tags were not part of the grammar. |
534 | in C<decode>, as if tags were not part of the grammar. |
535 | |
535 | |
536 | =item $json = $json->filter_json_object ([$coderef->($hashref)]) |
536 | =item $json = $json->filter_json_object ([$coderef->($hashref)]) |
537 | |
537 | |
538 | When C<$coderef> is specified, it will be called from C<decode> each |
538 | When C<$coderef> is specified, it will be called from C<decode> each |
539 | time it decodes a JSON object. The only argument is a reference to the |
539 | time it decodes a JSON object. The only argument is a reference to |
540 | newly-created hash. If the code references returns a single scalar (which |
540 | the newly-created hash. If the code reference returns a single scalar |
541 | need not be a reference), this value (i.e. a copy of that scalar to avoid |
541 | (which need not be a reference), this value (or rather a copy of it) is |
542 | aliasing) is inserted into the deserialised data structure. If it returns |
542 | inserted into the deserialised data structure. If it returns an empty |
543 | an empty list (NOTE: I<not> C<undef>, which is a valid scalar), the |
543 | list (NOTE: I<not> C<undef>, which is a valid scalar), the original |
544 | original deserialised hash will be inserted. This setting can slow down |
544 | deserialised hash will be inserted. This setting can slow down decoding |
545 | decoding considerably. |
545 | considerably. |
546 | |
546 | |
547 | When C<$coderef> is omitted or undefined, any existing callback will |
547 | When C<$coderef> is omitted or undefined, any existing callback will |
548 | be removed and C<decode> will not change the deserialised hash in any |
548 | be removed and C<decode> will not change the deserialised hash in any |
549 | way. |
549 | way. |
550 | |
550 | |
… | |
… | |
1289 | expect your input strings to be encoded as UTF-8, that is, no "character" |
1289 | expect your input strings to be encoded as UTF-8, that is, no "character" |
1290 | of the input string must have any value > 255, as UTF-8 does not allow |
1290 | of the input string must have any value > 255, as UTF-8 does not allow |
1291 | that. |
1291 | that. |
1292 | |
1292 | |
1293 | The C<utf8> flag therefore switches between two modes: disabled means you |
1293 | The C<utf8> flag therefore switches between two modes: disabled means you |
1294 | will get a Unicode string in Perl, enabled means you get an UTF-8 encoded |
1294 | will get a Unicode string in Perl, enabled means you get a UTF-8 encoded |
1295 | octet/binary string in Perl. |
1295 | octet/binary string in Perl. |
1296 | |
1296 | |
1297 | =item C<latin1> or C<ascii> flags enabled |
1297 | =item C<latin1> or C<ascii> flags enabled |
1298 | |
1298 | |
1299 | With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters |
1299 | With C<latin1> (or C<ascii>) enabled, C<encode> will escape characters |
… | |
… | |
1696 | ->allow_nonref(0) >> even if this is the current default, if they cannot |
1696 | ->allow_nonref(0) >> even if this is the current default, if they cannot |
1697 | handle non-reference values, in preparation for the day when the default |
1697 | handle non-reference values, in preparation for the day when the default |
1698 | will change. |
1698 | will change. |
1699 | |
1699 | |
1700 | |
1700 | |
1701 | =head1 THREADS |
1701 | =head1 (I-)THREADS |
1702 | |
1702 | |
1703 | This module is I<not> guaranteed to be thread safe and there are no |
1703 | This module is I<not> guaranteed to be ithread (or MULTIPLICITY-) safe |
1704 | plans to change this until Perl gets thread support (as opposed to the |
1704 | and there are no plans to change this. Note that perl's builtin so-called |
1705 | horribly slow so-called "threads" which are simply slow and bloated |
1705 | threads/ithreads are officially deprecated and should not be used. |
1706 | process simulations - use fork, it's I<much> faster, cheaper, better). |
|
|
1707 | |
|
|
1708 | (It might actually work, but you have been warned). |
|
|
1709 | |
1706 | |
1710 | |
1707 | |
1711 | =head1 THE PERILS OF SETLOCALE |
1708 | =head1 THE PERILS OF SETLOCALE |
1712 | |
1709 | |
1713 | Sometimes people avoid the Perl locale support and directly call the |
1710 | Sometimes people avoid the Perl locale support and directly call the |