ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/JSON-XS/XS.pm
(Generate patch)

Comparing JSON-XS/XS.pm (file contents):
Revision 1.116 by root, Tue Feb 17 23:41:20 2009 UTC vs.
Revision 1.126 by root, Wed Jan 6 08:02:18 2010 UTC

… …
99 99
100=cut 100=cut
101 101
102package JSON::XS; 102package JSON::XS;
103 103
104no warnings; 104use common::sense;
105use strict;
106 105
107our $VERSION = '2.232'; 106our $VERSION = '2.27';
108our @ISA = qw(Exporter); 107our @ISA = qw(Exporter);
109 108
110our @EXPORT = qw(encode_json decode_json to_json from_json); 109our @EXPORT = qw(encode_json decode_json to_json from_json);
111 110
112sub to_json($) { 111sub to_json($) {
… …
441the same JSON text (given the same overall settings). If it is disabled, 440the same JSON text (given the same overall settings). If it is disabled,
442the same hash might be encoded differently even if contains the same data, 441the same hash might be encoded differently even if contains the same data,
443as key-value pairs have no inherent ordering in Perl. 442as key-value pairs have no inherent ordering in Perl.
444 443
445This setting has no effect when decoding JSON texts. 444This setting has no effect when decoding JSON texts.
445
446This setting has currently no effect on tied hashes.
446 447
447=item $json = $json->allow_nonref ([$enable]) 448=item $json = $json->allow_nonref ([$enable])
448 449
449=item $enabled = $json->get_allow_nonref 450=item $enabled = $json->get_allow_nonref
450 451
… …
1209 use JSON::XS; 1210 use JSON::XS;
1210 1211
1211 print encode_json [chr 0x2028]; 1212 print encode_json [chr 0x2028];
1212 1213
1213The right fix for this is to use a proper JSON parser in your javascript 1214The right fix for this is to use a proper JSON parser in your javascript
1214programs, and not rely on C<eval>. 1215programs, and not rely on C<eval> (see for example Douglas Crockford's
1216F<json2.js> parser).
1215 1217
1216If this is not an option, you can, as a stop-gap measure, simply encode to 1218If this is not an option, you can, as a stop-gap measure, simply encode to
1217ASCII-only JSON: 1219ASCII-only JSON:
1218 1220
1219 use JSON::XS; 1221 use JSON::XS;
1220 1222
1221 print JSON::XS->new->ascii->encode ([chr 0x2028]); 1223 print JSON::XS->new->ascii->encode ([chr 0x2028]);
1222 1224
1223And if you are concerned about the size of the resulting JSON text, you 1225Note that this will enlarge the resulting JSON text quite a bit if you
1224can run some regexes to only escape U+2028 and U+2029: 1226have many non-ASCII characters. You might be tempted to run some regexes
1227to only escape U+2028 and U+2029, e.g.:
1225 1228
1226 use JSON::XS; 1229 # DO NOT USE THIS!
1227
1228 my $json = JSON::XS->new->utf8->encode ([chr 0x2028]); 1230 my $json = JSON::XS->new->utf8->encode ([chr 0x2028]);
1229 $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028 1231 $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028
1230 $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029 1232 $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029
1231 print $json; 1233 print $json;
1232 1234
1233This works because U+2028/U+2029 are not allowed outside of strings and 1235Note that I<this is a bad idea>: the above only works for U+2028 and
1234are not used for syntax, so replacing them unconditionally just works.
1235
1236Note, however, that fixing the broken JSON parser is better than working
1237around it in every other generator. The above regexes should work well in
1238other languages, as long as they operate on UTF-8. It is equally valid to
1239replace all occurences of U+2028/2029 directly by their \\u-escaped forms
1240in unicode texts, so they can simply be used to fix any parsers relying on
1241C<eval> by first applying the regexes on the encoded texts.
1242
1243Note also that the above only works for U+2028 and U+2029 and thus
1244only for fully ECMAscript-compliant parsers. Many existing javascript 1236U+2029 and thus only for fully ECMAscript-compliant parsers. Many existing
1245implementations misparse other characters as well. Best rely on a good 1237javascript implementations, however, have issues with other characters as
1246JSON parser, such as Douglas Crockfords F<json2.js>, which escapes the 1238well - using C<eval> naively simply I<will> cause problems.
1247above and many more problematic characters properly before passing them
1248into C<eval>.
1249 1239
1250Another problem is that some javascript implementations reserve 1240Another problem is that some javascript implementations reserve
1251some property names for their own purposes (which probably makes 1241some property names for their own purposes (which probably makes
1252them non-ECMAscript-compliant). For example, Iceweasel reserves the 1242them non-ECMAscript-compliant). For example, Iceweasel reserves the
1253C<__proto__> property name for it's own purposes. 1243C<__proto__> property name for it's own purposes.
… …
1278 my $yaml = $to_yaml->encode ($ref) . "\n"; 1268 my $yaml = $to_yaml->encode ($ref) . "\n";
1279 1269
1280This will I<usually> generate JSON texts that also parse as valid 1270This will I<usually> generate JSON texts that also parse as valid
1281YAML. Please note that YAML has hardcoded limits on (simple) object key 1271YAML. Please note that YAML has hardcoded limits on (simple) object key
1282lengths that JSON doesn't have and also has different and incompatible 1272lengths that JSON doesn't have and also has different and incompatible
1283unicode handling, so you should make sure that your hash keys are 1273unicode character escape syntax, so you should make sure that your hash
1284noticeably shorter than the 1024 "stream characters" YAML allows and that 1274keys are noticeably shorter than the 1024 "stream characters" YAML allows
1285you do not have characters with codepoint values outside the Unicode BMP 1275and that you do not have characters with codepoint values outside the
1286(basic multilingual page). YAML also does not allow C<\/> sequences in 1276Unicode BMP (basic multilingual page). YAML also does not allow C<\/>
1287strings (which JSON::XS does not I<currently> generate, but other JSON 1277sequences in strings (which JSON::XS does not I<currently> generate, but
1288generators might). 1278other JSON generators might).
1289 1279
1290There might be other incompatibilities that I am not aware of (or the YAML 1280There might be other incompatibilities that I am not aware of (or the YAML
1291specification has been changed yet again - it does so quite often). In 1281specification has been changed yet again - it does so quite often). In
1292general you should not try to generate YAML with a JSON generator or vice 1282general you should not try to generate YAML with a JSON generator or vice
1293versa, or try to parse JSON with a YAML parser or vice versa: chances are 1283versa, or try to parse JSON with a YAML parser or vice versa: chances are
… …
1311proponents, I would kindly suggest reading the JSON spec (which is not 1301proponents, I would kindly suggest reading the JSON spec (which is not
1312that difficult or long) and finally make YAML compatible to it, and 1302that difficult or long) and finally make YAML compatible to it, and
1313educating users about the changes, instead of spreading lies about the 1303educating users about the changes, instead of spreading lies about the
1314real compatibility for many I<years> and trying to silence people who 1304real compatibility for many I<years> and trying to silence people who
1315point out that it isn't true. 1305point out that it isn't true.
1306
1307Addendum/2009: the YAML 1.2 spec is still incomaptible with JSON, even
1308though the incompatibilities have been documented (and are known to
1309Brian) for many years and the spec makes explicit claims that YAML is a
1310superset of JSON. It would be so easy to fix, but apparently, bullying and
1311corrupting userdata is so much easier.
1316 1312
1317=back 1313=back
1318 1314
1319 1315
1320=head2 SPEED 1316=head2 SPEED

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines