| … | |
… | |
| 86 | package JSON::XS; |
86 | package JSON::XS; |
| 87 | |
87 | |
| 88 | use strict; |
88 | use strict; |
| 89 | |
89 | |
| 90 | BEGIN { |
90 | BEGIN { |
| 91 | our $VERSION = '1.12'; |
91 | our $VERSION = '1.21'; |
| 92 | our @ISA = qw(Exporter); |
92 | our @ISA = qw(Exporter); |
| 93 | |
93 | |
| 94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
| 95 | require Exporter; |
95 | require Exporter; |
| 96 | |
96 | |
| … | |
… | |
| 154 | |
154 | |
| 155 | If C<$enable> is true (or missing), then the C<encode> method will not |
155 | If C<$enable> is true (or missing), then the C<encode> method will not |
| 156 | generate characters outside the code range C<0..127> (which is ASCII). Any |
156 | generate characters outside the code range C<0..127> (which is ASCII). Any |
| 157 | unicode characters outside that range will be escaped using either a |
157 | unicode characters outside that range will be escaped using either a |
| 158 | single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, |
158 | single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence, |
| 159 | as per RFC4627. |
159 | as per RFC4627. The resulting encoded JSON text can be treated as a native |
|
|
160 | unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string, |
|
|
161 | or any other superset of ASCII. |
| 160 | |
162 | |
| 161 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
163 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
| 162 | characters unless required by the JSON syntax. This results in a faster |
164 | characters unless required by the JSON syntax or other flags. This results |
| 163 | and more compact format. |
165 | in a faster and more compact format. |
|
|
166 | |
|
|
167 | The main use for this flag is to produce JSON texts that can be |
|
|
168 | transmitted over a 7-bit channel, as the encoded JSON texts will not |
|
|
169 | contain any 8 bit characters. |
| 164 | |
170 | |
| 165 | JSON::XS->new->ascii (1)->encode ([chr 0x10401]) |
171 | JSON::XS->new->ascii (1)->encode ([chr 0x10401]) |
| 166 | => ["\ud801\udc01"] |
172 | => ["\ud801\udc01"] |
|
|
173 | |
|
|
174 | =item $json = $json->latin1 ([$enable]) |
|
|
175 | |
|
|
176 | If C<$enable> is true (or missing), then the C<encode> method will encode |
|
|
177 | the resulting JSON text as latin1 (or iso-8859-1), escaping any characters |
|
|
178 | outside the code range C<0..255>. The resulting string can be treated as a |
|
|
179 | latin1-encoded JSON text or a native unicode string. The C<decode> method |
|
|
180 | will not be affected in any way by this flag, as C<decode> by default |
|
|
181 | expects unicode, which is a strict superset of latin1. |
|
|
182 | |
|
|
183 | If C<$enable> is false, then the C<encode> method will not escape Unicode |
|
|
184 | characters unless required by the JSON syntax or other flags. |
|
|
185 | |
|
|
186 | The main use for this flag is efficiently encoding binary data as JSON |
|
|
187 | text, as most octets will not be escaped, resulting in a smaller encoded |
|
|
188 | size. The disadvantage is that the resulting JSON text is encoded |
|
|
189 | in latin1 (and must correctly be treated as such when storing and |
|
|
190 | transfering), a rare encoding for JSON. It is therefore most useful when |
|
|
191 | you want to store data structures known to contain binary data efficiently |
|
|
192 | in files or databases, not when talking to other JSON encoders/decoders. |
|
|
193 | |
|
|
194 | JSON::XS->new->latin1->encode (["\x{89}\x{abc}"] |
|
|
195 | => ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not) |
| 167 | |
196 | |
| 168 | =item $json = $json->utf8 ([$enable]) |
197 | =item $json = $json->utf8 ([$enable]) |
| 169 | |
198 | |
| 170 | If C<$enable> is true (or missing), then the C<encode> method will encode |
199 | If C<$enable> is true (or missing), then the C<encode> method will encode |
| 171 | the JSON result into UTF-8, as required by many protocols, while the |
200 | the JSON result into UTF-8, as required by many protocols, while the |
| … | |
… | |
| 345 | |
374 | |
| 346 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
375 | JSON numbers and strings become simple Perl scalars. JSON arrays become |
| 347 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
376 | Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes |
| 348 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
377 | C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. |
| 349 | |
378 | |
|
|
379 | =item ($perl_scalar, $characters) = $json->decode_prefix ($json_text) |
|
|
380 | |
|
|
381 | This works like the C<decode> method, but instead of raising an exception |
|
|
382 | when there is trailing garbage after the first JSON object, it will |
|
|
383 | silently stop parsing there and return the number of characters consumed |
|
|
384 | so far. |
|
|
385 | |
|
|
386 | This is useful if your JSON texts are not delimited by an outer protocol |
|
|
387 | (which is not the brightest thing to do in the first place) and you need |
|
|
388 | to know where the JSON text ends. |
|
|
389 | |
|
|
390 | JSON::XS->new->decode_prefix ("[1] the tail") |
|
|
391 | => ([], 3) |
|
|
392 | |
| 350 | =back |
393 | =back |
| 351 | |
394 | |
| 352 | |
395 | |
| 353 | =head1 MAPPING |
396 | =head1 MAPPING |
| 354 | |
397 | |
