… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use JSON::XS; |
7 | use JSON::XS; |
8 | |
8 | |
9 | # exported functions, croak on error |
9 | # exported functions, they croak on error |
|
|
10 | # and expect/generate UTF-8 |
10 | |
11 | |
11 | $utf8_encoded_json_text = to_json $perl_hash_or_arrayref; |
12 | $utf8_encoded_json_text = to_json $perl_hash_or_arrayref; |
12 | $perl_hash_or_arrayref = from_json $utf8_encoded_json_text; |
13 | $perl_hash_or_arrayref = from_json $utf8_encoded_json_text; |
13 | |
14 | |
|
|
15 | # objToJson and jsonToObj aliases to to_json and from_json |
|
|
16 | # are exported for compatibility to the JSON module, |
|
|
17 | # but should not be used in new code. |
|
|
18 | |
14 | # oo-interface |
19 | # OO-interface |
15 | |
20 | |
16 | $coder = JSON::XS->new->ascii->pretty->allow_nonref; |
21 | $coder = JSON::XS->new->ascii->pretty->allow_nonref; |
17 | $pretty_printed_unencoded = $coder->encode ($perl_scalar); |
22 | $pretty_printed_unencoded = $coder->encode ($perl_scalar); |
18 | $perl_scalar = $coder->decode ($unicode_json_text); |
23 | $perl_scalar = $coder->decode ($unicode_json_text); |
19 | |
24 | |
… | |
… | |
36 | |
41 | |
37 | =head2 FEATURES |
42 | =head2 FEATURES |
38 | |
43 | |
39 | =over 4 |
44 | =over 4 |
40 | |
45 | |
41 | =item * correct handling of unicode issues |
46 | =item * correct unicode handling |
42 | |
47 | |
43 | This module knows how to handle Unicode, and even documents how and when |
48 | This module knows how to handle Unicode, and even documents how and when |
44 | it does so. |
49 | it does so. |
45 | |
50 | |
46 | =item * round-trip integrity |
51 | =item * round-trip integrity |
47 | |
52 | |
48 | When you serialise a perl data structure using only datatypes supported |
53 | When you serialise a perl data structure using only datatypes supported |
49 | by JSON, the deserialised data structure is identical on the Perl level. |
54 | by JSON, the deserialised data structure is identical on the Perl level. |
50 | (e.g. the string "2.0" doesn't suddenly become "2"). |
55 | (e.g. the string "2.0" doesn't suddenly become "2" just because it looks |
|
|
56 | like a number). |
51 | |
57 | |
52 | =item * strict checking of JSON correctness |
58 | =item * strict checking of JSON correctness |
53 | |
59 | |
54 | There is no guessing, no generating of illegal JSON texts by default, |
60 | There is no guessing, no generating of illegal JSON texts by default, |
55 | and only JSON is accepted as input by default (the latter is a security |
61 | and only JSON is accepted as input by default (the latter is a security |
… | |
… | |
66 | interface. |
72 | interface. |
67 | |
73 | |
68 | =item * reasonably versatile output formats |
74 | =item * reasonably versatile output formats |
69 | |
75 | |
70 | You can choose between the most compact guarenteed single-line format |
76 | You can choose between the most compact guarenteed single-line format |
71 | possible (nice for simple line-based protocols), a pure-ascii format (for |
77 | possible (nice for simple line-based protocols), a pure-ascii format |
72 | when your transport is not 8-bit clean), or a pretty-printed format (for |
78 | (for when your transport is not 8-bit clean, still supports the whole |
73 | when you want to read that stuff). Or you can combine those features in |
79 | unicode range), or a pretty-printed format (for when you want to read that |
74 | whatever way you like. |
80 | stuff). Or you can combine those features in whatever way you like. |
75 | |
81 | |
76 | =back |
82 | =back |
77 | |
83 | |
78 | =cut |
84 | =cut |
79 | |
85 | |
80 | package JSON::XS; |
86 | package JSON::XS; |
81 | |
87 | |
|
|
88 | use strict; |
|
|
89 | |
82 | BEGIN { |
90 | BEGIN { |
83 | $VERSION = '0.5'; |
91 | our $VERSION = '0.8'; |
84 | @ISA = qw(Exporter); |
92 | our @ISA = qw(Exporter); |
85 | |
93 | |
86 | @EXPORT = qw(to_json from_json); |
94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
87 | require Exporter; |
95 | require Exporter; |
88 | |
96 | |
89 | require XSLoader; |
97 | require XSLoader; |
90 | XSLoader::load JSON::XS::, $VERSION; |
98 | XSLoader::load JSON::XS::, $VERSION; |
91 | } |
99 | } |