… | |
… | |
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 |
52 | reports for other reasons. |
52 | reports for other reasons. |
53 | |
53 | |
54 | See COMPARISON, below, for a comparison to some other JSON modules. |
|
|
55 | |
|
|
56 | See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
54 | See MAPPING, below, on how JSON::XS maps perl values to JSON values and |
57 | vice versa. |
55 | vice versa. |
58 | |
56 | |
59 | =head2 FEATURES |
57 | =head2 FEATURES |
60 | |
58 | |
… | |
… | |
101 | |
99 | |
102 | =cut |
100 | =cut |
103 | |
101 | |
104 | package JSON::XS; |
102 | package JSON::XS; |
105 | |
103 | |
106 | use strict; |
104 | use common::sense; |
107 | |
105 | |
108 | our $VERSION = '2.222'; |
106 | our $VERSION = '2.24'; |
109 | our @ISA = qw(Exporter); |
107 | our @ISA = qw(Exporter); |
110 | |
108 | |
111 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
109 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
112 | |
110 | |
113 | sub to_json($) { |
111 | sub to_json($) { |
… | |
… | |
767 | JSON object or b) parsing multiple JSON objects separated by non-JSON text |
765 | JSON object or b) parsing multiple JSON objects separated by non-JSON text |
768 | (such as commas). |
766 | (such as commas). |
769 | |
767 | |
770 | =item $json->incr_skip |
768 | =item $json->incr_skip |
771 | |
769 | |
772 | This will reset the state of the incremental parser and will remove the |
770 | This will reset the state of the incremental parser and will remove |
773 | parsed text from the input buffer. This is useful after C<incr_parse> |
771 | the parsed text from the input buffer so far. This is useful after |
774 | died, in which case the input buffer and incremental parser state is left |
772 | C<incr_parse> died, in which case the input buffer and incremental parser |
775 | unchanged, to skip the text parsed so far and to reset the parse state. |
773 | state is left unchanged, to skip the text parsed so far and to reset the |
|
|
774 | parse state. |
|
|
775 | |
|
|
776 | The difference to C<incr_reset> is that only text until the parse error |
|
|
777 | occured is removed. |
776 | |
778 | |
777 | =item $json->incr_reset |
779 | =item $json->incr_reset |
778 | |
780 | |
779 | This completely resets the incremental parser, that is, after this call, |
781 | This completely resets the incremental parser, that is, after this call, |
780 | it will be as if the parser had never parsed anything. |
782 | it will be as if the parser had never parsed anything. |
781 | |
783 | |
782 | This is useful if you want ot repeatedly parse JSON objects and want to |
784 | This is useful if you want to repeatedly parse JSON objects and want to |
783 | ignore any trailing data, which means you have to reset the parser after |
785 | ignore any trailing data, which means you have to reset the parser after |
784 | each successful decode. |
786 | each successful decode. |
785 | |
787 | |
786 | =back |
788 | =back |
787 | |
789 | |
… | |
… | |
1180 | when your channel for JSON transfer is not 8-bit clean or the encoding |
1182 | when your channel for JSON transfer is not 8-bit clean or the encoding |
1181 | might be mangled in between (e.g. in mail), and works because ASCII is a |
1183 | might be mangled in between (e.g. in mail), and works because ASCII is a |
1182 | proper subset of most 8-bit and multibyte encodings in use in the world. |
1184 | proper subset of most 8-bit and multibyte encodings in use in the world. |
1183 | |
1185 | |
1184 | =back |
1186 | =back |
|
|
1187 | |
|
|
1188 | |
|
|
1189 | =head2 JSON and ECMAscript |
|
|
1190 | |
|
|
1191 | JSON syntax is based on how literals are represented in javascript (the |
|
|
1192 | not-standardised predecessor of ECMAscript) which is presumably why it is |
|
|
1193 | called "JavaScript Object Notation". |
|
|
1194 | |
|
|
1195 | However, JSON is not a subset (and also not a superset of course) of |
|
|
1196 | ECMAscript (the standard) or javascript (whatever browsers actually |
|
|
1197 | implement). |
|
|
1198 | |
|
|
1199 | If you want to use javascript's C<eval> function to "parse" JSON, you |
|
|
1200 | might run into parse errors for valid JSON texts, or the resulting data |
|
|
1201 | structure might not be queryable: |
|
|
1202 | |
|
|
1203 | One of the problems is that U+2028 and U+2029 are valid characters inside |
|
|
1204 | JSON strings, but are not allowed in ECMAscript string literals, so the |
|
|
1205 | following Perl fragment will not output something that can be guaranteed |
|
|
1206 | to be parsable by javascript's C<eval>: |
|
|
1207 | |
|
|
1208 | use JSON::XS; |
|
|
1209 | |
|
|
1210 | print encode_json [chr 0x2028]; |
|
|
1211 | |
|
|
1212 | The right fix for this is to use a proper JSON parser in your javascript |
|
|
1213 | programs, and not rely on C<eval> (see for example Douglas Crockford's |
|
|
1214 | F<json2.js> parser). |
|
|
1215 | |
|
|
1216 | If this is not an option, you can, as a stop-gap measure, simply encode to |
|
|
1217 | ASCII-only JSON: |
|
|
1218 | |
|
|
1219 | use JSON::XS; |
|
|
1220 | |
|
|
1221 | print JSON::XS->new->ascii->encode ([chr 0x2028]); |
|
|
1222 | |
|
|
1223 | Note that this will enlarge the resulting JSON text quite a bit if you |
|
|
1224 | have many non-ASCII characters. You might be tempted to run some regexes |
|
|
1225 | to only escape U+2028 and U+2029, e.g.: |
|
|
1226 | |
|
|
1227 | # DO NOT USE THIS! |
|
|
1228 | my $json = JSON::XS->new->utf8->encode ([chr 0x2028]); |
|
|
1229 | $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028 |
|
|
1230 | $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029 |
|
|
1231 | print $json; |
|
|
1232 | |
|
|
1233 | Note that I<this is a bad idea>: the above only works for U+2028 and |
|
|
1234 | U+2029 and thus only for fully ECMAscript-compliant parsers. Many existing |
|
|
1235 | javascript implementations, however, have issues with other characters as |
|
|
1236 | well - using C<eval> naively simply I<will> cause problems. |
|
|
1237 | |
|
|
1238 | Another problem is that some javascript implementations reserve |
|
|
1239 | some property names for their own purposes (which probably makes |
|
|
1240 | them non-ECMAscript-compliant). For example, Iceweasel reserves the |
|
|
1241 | C<__proto__> property name for it's own purposes. |
|
|
1242 | |
|
|
1243 | If that is a problem, you could parse try to filter the resulting JSON |
|
|
1244 | output for these property strings, e.g.: |
|
|
1245 | |
|
|
1246 | $json =~ s/"__proto__"\s*:/"__proto__renamed":/g; |
|
|
1247 | |
|
|
1248 | This works because C<__proto__> is not valid outside of strings, so every |
|
|
1249 | occurence of C<"__proto__"\s*:> must be a string used as property name. |
|
|
1250 | |
|
|
1251 | If you know of other incompatibilities, please let me know. |
1185 | |
1252 | |
1186 | |
1253 | |
1187 | =head2 JSON and YAML |
1254 | =head2 JSON and YAML |
1188 | |
1255 | |
1189 | You often hear that JSON is a subset of YAML. This is, however, a mass |
1256 | You often hear that JSON is a subset of YAML. This is, however, a mass |