… | |
… | |
10 | use JSON::XS; |
10 | use JSON::XS; |
11 | |
11 | |
12 | # exported functions, they croak on error |
12 | # exported functions, they croak on error |
13 | # and expect/generate UTF-8 |
13 | # and expect/generate UTF-8 |
14 | |
14 | |
15 | $utf8_encoded_json_text = to_json $perl_hash_or_arrayref; |
15 | $utf8_encoded_json_text = encode_json $perl_hash_or_arrayref; |
16 | $perl_hash_or_arrayref = from_json $utf8_encoded_json_text; |
16 | $perl_hash_or_arrayref = decode_json $utf8_encoded_json_text; |
17 | |
17 | |
18 | # OO-interface |
18 | # OO-interface |
19 | |
19 | |
20 | $coder = JSON::XS->new->ascii->pretty->allow_nonref; |
20 | $coder = JSON::XS->new->ascii->pretty->allow_nonref; |
21 | $pretty_printed_unencoded = $coder->encode ($perl_scalar); |
21 | $pretty_printed_unencoded = $coder->encode ($perl_scalar); |
22 | $perl_scalar = $coder->decode ($unicode_json_text); |
22 | $perl_scalar = $coder->decode ($unicode_json_text); |
23 | |
23 | |
|
|
24 | # Note that JSON version 2.0 and above will automatically use JSON::XS |
|
|
25 | # if available, at virtually no speed overhead either, so you should |
|
|
26 | # be able to just: |
|
|
27 | |
|
|
28 | use JSON; |
|
|
29 | |
|
|
30 | # and do the same things, except that you have a pure-perl fallback now. |
|
|
31 | |
24 | =head1 DESCRIPTION |
32 | =head1 DESCRIPTION |
25 | |
33 | |
26 | This module converts Perl data structures to JSON and vice versa. Its |
34 | This module converts Perl data structures to JSON and vice versa. Its |
27 | primary goal is to be I<correct> and its secondary goal is to be |
35 | primary goal is to be I<correct> and its secondary goal is to be |
28 | I<fast>. To reach the latter goal it was written in C. |
36 | I<fast>. To reach the latter goal it was written in C. |
|
|
37 | |
|
|
38 | Beginning with version 2.0 of the JSON module, when both JSON and |
|
|
39 | JSON::XS are installed, then JSON will fall back on JSON::XS (this can be |
|
|
40 | overriden) with no overhead due to emulation (by inheritign constructor |
|
|
41 | and methods). If JSON::XS is not available, it will fall back to the |
|
|
42 | compatible JSON::PP module as backend, so using JSON instead of JSON::XS |
|
|
43 | gives you a portable JSON API that can be fast when you need and doesn't |
|
|
44 | require a C compiler when that is a problem. |
29 | |
45 | |
30 | As this is the n-th-something JSON module on CPAN, what was the reason |
46 | As this is the n-th-something JSON module on CPAN, what was the reason |
31 | to write yet another JSON module? While it seems there are many JSON |
47 | to write yet another JSON module? While it seems there are many JSON |
32 | modules, none of them correctly handle all corner cases, and in most cases |
48 | modules, none of them correctly handle all corner cases, and in most cases |
33 | their maintainers are unresponsive, gone missing, or not listening to bug |
49 | their maintainers are unresponsive, gone missing, or not listening to bug |
… | |
… | |
84 | |
100 | |
85 | package JSON::XS; |
101 | package JSON::XS; |
86 | |
102 | |
87 | use strict; |
103 | use strict; |
88 | |
104 | |
89 | our $VERSION = '1.53'; |
105 | our $VERSION = '2.01'; |
90 | our @ISA = qw(Exporter); |
106 | our @ISA = qw(Exporter); |
91 | |
107 | |
92 | our @EXPORT = qw(to_json from_json); |
108 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
|
|
109 | |
|
|
110 | sub to_json($) { |
|
|
111 | require Carp; |
|
|
112 | Carp::croak ("JSON::XS::to_json has been renamed to encode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call"); |
|
|
113 | } |
|
|
114 | |
|
|
115 | sub from_json($) { |
|
|
116 | require Carp; |
|
|
117 | Carp::croak ("JSON::XS::from_json has been renamed to decode_json, either downgrade to pre-2.0 versions of JSON::XS or rename the call"); |
|
|
118 | } |
93 | |
119 | |
94 | use Exporter; |
120 | use Exporter; |
95 | use XSLoader; |
121 | use XSLoader; |
96 | |
122 | |
97 | =head1 FUNCTIONAL INTERFACE |
123 | =head1 FUNCTIONAL INTERFACE |
… | |
… | |
99 | The following convenience methods are provided by this module. They are |
125 | The following convenience methods are provided by this module. They are |
100 | exported by default: |
126 | exported by default: |
101 | |
127 | |
102 | =over 4 |
128 | =over 4 |
103 | |
129 | |
104 | =item $json_text = to_json $perl_scalar |
130 | =item $json_text = encode_json $perl_scalar |
105 | |
131 | |
106 | Converts the given Perl data structure to a UTF-8 encoded, binary string |
132 | Converts the given Perl data structure to a UTF-8 encoded, binary string |
107 | (that is, the string contains octets only). Croaks on error. |
133 | (that is, the string contains octets only). Croaks on error. |
108 | |
134 | |
109 | This function call is functionally identical to: |
135 | This function call is functionally identical to: |
110 | |
136 | |
111 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
137 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
112 | |
138 | |
113 | except being faster. |
139 | except being faster. |
114 | |
140 | |
115 | =item $perl_scalar = from_json $json_text |
141 | =item $perl_scalar = decode_json $json_text |
116 | |
142 | |
117 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries |
143 | The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries |
118 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
144 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
119 | reference. Croaks on error. |
145 | reference. Croaks on error. |
120 | |
146 | |
121 | This function call is functionally identical to: |
147 | This function call is functionally identical to: |
122 | |
148 | |
… | |
… | |
276 | |
302 | |
277 | use Encode; |
303 | use Encode; |
278 | $object = JSON::XS->new->decode (decode "UTF-32LE", $jsontext); |
304 | $object = JSON::XS->new->decode (decode "UTF-32LE", $jsontext); |
279 | |
305 | |
280 | =item $json = $json->pretty ([$enable]) |
306 | =item $json = $json->pretty ([$enable]) |
281 | |
|
|
282 | =item $enabled = $json->get_pretty |
|
|
283 | |
307 | |
284 | This enables (or disables) all of the C<indent>, C<space_before> and |
308 | This enables (or disables) all of the C<indent>, C<space_before> and |
285 | C<space_after> (and in the future possibly more) flags in one call to |
309 | C<space_after> (and in the future possibly more) flags in one call to |
286 | generate the most readable (or most compact) form possible. |
310 | generate the most readable (or most compact) form possible. |
287 | |
311 | |
… | |
… | |
429 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
453 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
430 | => "Hello, World!" |
454 | => "Hello, World!" |
431 | |
455 | |
432 | =item $json = $json->allow_blessed ([$enable]) |
456 | =item $json = $json->allow_blessed ([$enable]) |
433 | |
457 | |
434 | =item $enabled = $json->get_allow_bless |
458 | =item $enabled = $json->get_allow_blessed |
435 | |
459 | |
436 | If C<$enable> is true (or missing), then the C<encode> method will not |
460 | If C<$enable> is true (or missing), then the C<encode> method will not |
437 | barf when it encounters a blessed reference. Instead, the value of the |
461 | barf when it encounters a blessed reference. Instead, the value of the |
438 | B<convert_blessed> option will decide whether C<null> (C<convert_blessed> |
462 | B<convert_blessed> option will decide whether C<null> (C<convert_blessed> |
439 | disabled or no C<to_json> method found) or a representation of the |
463 | disabled or no C<TO_JSON> method found) or a representation of the |
440 | object (C<convert_blessed> enabled and C<to_json> method found) is being |
464 | object (C<convert_blessed> enabled and C<TO_JSON> method found) is being |
441 | encoded. Has no effect on C<decode>. |
465 | encoded. Has no effect on C<decode>. |
442 | |
466 | |
443 | If C<$enable> is false (the default), then C<encode> will throw an |
467 | If C<$enable> is false (the default), then C<encode> will throw an |
444 | exception when it encounters a blessed object. |
468 | exception when it encounters a blessed object. |
445 | |
469 | |
… | |
… | |
457 | The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON> |
481 | The C<TO_JSON> method may safely call die if it wants. If C<TO_JSON> |
458 | returns other blessed objects, those will be handled in the same |
482 | returns other blessed objects, those will be handled in the same |
459 | way. C<TO_JSON> must take care of not causing an endless recursion cycle |
483 | way. C<TO_JSON> must take care of not causing an endless recursion cycle |
460 | (== crash) in this case. The name of C<TO_JSON> was chosen because other |
484 | (== crash) in this case. The name of C<TO_JSON> was chosen because other |
461 | methods called by the Perl core (== not by the user of the object) are |
485 | methods called by the Perl core (== not by the user of the object) are |
462 | usually in upper case letters and to avoid collisions with the C<to_json> |
486 | usually in upper case letters and to avoid collisions with any C<to_json> |
463 | function. |
487 | function or method. |
464 | |
488 | |
465 | This setting does not yet influence C<decode> in any way, but in the |
489 | This setting does not yet influence C<decode> in any way, but in the |
466 | future, global hooks might get installed that influence C<decode> and are |
490 | future, global hooks might get installed that influence C<decode> and are |
467 | enabled by this setting. |
491 | enabled by this setting. |
468 | |
492 | |
… | |
… | |
741 | Other unblessed references are generally not allowed and will cause an |
765 | Other unblessed references are generally not allowed and will cause an |
742 | exception to be thrown, except for references to the integers C<0> and |
766 | exception to be thrown, except for references to the integers C<0> and |
743 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
767 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
744 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
768 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
745 | |
769 | |
746 | to_json [\0,JSON::XS::true] # yields [false,true] |
770 | encode_json [\0,JSON::XS::true] # yields [false,true] |
747 | |
771 | |
748 | =item JSON::XS::true, JSON::XS::false |
772 | =item JSON::XS::true, JSON::XS::false |
749 | |
773 | |
750 | These special values become JSON true and JSON false values, |
774 | These special values become JSON true and JSON false values, |
751 | respectively. You can also use C<\1> and C<\0> directly if you want. |
775 | respectively. You can also use C<\1> and C<\0> directly if you want. |
… | |
… | |
762 | difficult objects to encode: JSON::XS will encode undefined scalars as |
786 | difficult objects to encode: JSON::XS will encode undefined scalars as |
763 | JSON null value, scalars that have last been used in a string context |
787 | JSON null value, scalars that have last been used in a string context |
764 | before encoding as JSON strings and anything else as number value: |
788 | before encoding as JSON strings and anything else as number value: |
765 | |
789 | |
766 | # dump as number |
790 | # dump as number |
767 | to_json [2] # yields [2] |
791 | encode_json [2] # yields [2] |
768 | to_json [-3.0e17] # yields [-3e+17] |
792 | encode_json [-3.0e17] # yields [-3e+17] |
769 | my $value = 5; to_json [$value] # yields [5] |
793 | my $value = 5; encode_json [$value] # yields [5] |
770 | |
794 | |
771 | # used as string, so dump as string |
795 | # used as string, so dump as string |
772 | print $value; |
796 | print $value; |
773 | to_json [$value] # yields ["5"] |
797 | encode_json [$value] # yields ["5"] |
774 | |
798 | |
775 | # undef becomes null |
799 | # undef becomes null |
776 | to_json [undef] # yields [null] |
800 | encode_json [undef] # yields [null] |
777 | |
801 | |
778 | You can force the type to be a JSON string by stringifying it: |
802 | You can force the type to be a JSON string by stringifying it: |
779 | |
803 | |
780 | my $x = 3.1; # some variable containing a number |
804 | my $x = 3.1; # some variable containing a number |
781 | "$x"; # stringified |
805 | "$x"; # stringified |