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.110 by root, Sun Jul 20 17:55:19 2008 UTC vs.
Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC

49to write yet another JSON module? While it seems there are many JSON 49to write yet another JSON module? While it seems there are many JSON
50modules, none of them correctly handle all corner cases, and in most cases 50modules, none of them correctly handle all corner cases, and in most cases
51their maintainers are unresponsive, gone missing, or not listening to bug 51their maintainers are unresponsive, gone missing, or not listening to bug
52reports for other reasons. 52reports for other reasons.
53 53
54See COMPARISON, below, for a comparison to some other JSON modules.
55
56See MAPPING, below, on how JSON::XS maps perl values to JSON values and 54See MAPPING, below, on how JSON::XS maps perl values to JSON values and
57vice versa. 55vice versa.
58 56
59=head2 FEATURES 57=head2 FEATURES
60 58
66so, and even documents what "correct" means. 64so, and even documents what "correct" means.
67 65
68=item * round-trip integrity 66=item * round-trip integrity
69 67
70When you serialise a perl data structure using only data types supported 68When you serialise a perl data structure using only data types supported
71by JSON, the deserialised data structure is identical on the Perl level. 69by JSON and Perl, the deserialised data structure is identical on the Perl
72(e.g. the string "2.0" doesn't suddenly become "2" just because it looks 70level. (e.g. the string "2.0" doesn't suddenly become "2" just because
73like a number). There minor I<are> exceptions to this, read the MAPPING 71it looks like a number). There I<are> minor exceptions to this, read the
74section below to learn about those. 72MAPPING section below to learn about those.
75 73
76=item * strict checking of JSON correctness 74=item * strict checking of JSON correctness
77 75
78There is no guessing, no generating of illegal JSON texts by default, 76There is no guessing, no generating of illegal JSON texts by default,
79and only JSON is accepted as input by default (the latter is a security 77and only JSON is accepted as input by default (the latter is a security
85this module usually compares favourably in terms of speed, too. 83this module usually compares favourably in terms of speed, too.
86 84
87=item * simple to use 85=item * simple to use
88 86
89This module has both a simple functional interface as well as an object 87This module has both a simple functional interface as well as an object
90oriented interface interface. 88oriented interface.
91 89
92=item * reasonably versatile output formats 90=item * reasonably versatile output formats
93 91
94You can choose between the most compact guaranteed-single-line format 92You can choose between the most compact guaranteed-single-line format
95possible (nice for simple line-based protocols), a pure-ASCII format 93possible (nice for simple line-based protocols), a pure-ASCII format
101 99
102=cut 100=cut
103 101
104package JSON::XS; 102package JSON::XS;
105 103
106no warnings; 104use common::sense;
107use strict;
108 105
109our $VERSION = '2.2222'; 106our $VERSION = 2.34;
110our @ISA = qw(Exporter); 107our @ISA = qw(Exporter);
111 108
112our @EXPORT = qw(encode_json decode_json to_json from_json); 109our @EXPORT = qw(encode_json decode_json);
113
114sub to_json($) {
115 require Carp;
116 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");
117}
118
119sub from_json($) {
120 require Carp;
121 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");
122}
123 110
124use Exporter; 111use Exporter;
125use XSLoader; 112use XSLoader;
113
114use Types::Serialiser ();
126 115
127=head1 FUNCTIONAL INTERFACE 116=head1 FUNCTIONAL INTERFACE
128 117
129The following convenience methods are provided by this module. They are 118The following convenience methods are provided by this module. They are
130exported by default: 119exported by default:
151This function call is functionally identical to: 140This function call is functionally identical to:
152 141
153 $perl_scalar = JSON::XS->new->utf8->decode ($json_text) 142 $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
154 143
155Except being faster. 144Except being faster.
156
157=item $is_boolean = JSON::XS::is_bool $scalar
158
159Returns true if the passed scalar represents either JSON::XS::true or
160JSON::XS::false, two constants that act like C<1> and C<0>, respectively
161and are used to represent JSON C<true> and C<false> values in Perl.
162
163See MAPPING, below, for more information on how JSON values are mapped to
164Perl.
165 145
166=back 146=back
167 147
168 148
169=head1 A FEW NOTES ON UNICODE AND PERL 149=head1 A FEW NOTES ON UNICODE AND PERL
435If C<$enable> is true (or missing), then the C<encode> method will output JSON objects 415If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
436by sorting their keys. This is adding a comparatively high overhead. 416by sorting their keys. This is adding a comparatively high overhead.
437 417
438If C<$enable> is false, then the C<encode> method will output key-value 418If C<$enable> is false, then the C<encode> method will output key-value
439pairs in the order Perl stores them (which will likely change between runs 419pairs in the order Perl stores them (which will likely change between runs
440of the same script). 420of the same script, and can change even within the same run from 5.18
421onwards).
441 422
442This option is useful if you want the same data structure to be encoded as 423This option is useful if you want the same data structure to be encoded as
443the same JSON text (given the same overall settings). If it is disabled, 424the same JSON text (given the same overall settings). If it is disabled,
444the same hash might be encoded differently even if contains the same data, 425the same hash might be encoded differently even if contains the same data,
445as key-value pairs have no inherent ordering in Perl. 426as key-value pairs have no inherent ordering in Perl.
446 427
447This setting has no effect when decoding JSON texts. 428This setting has no effect when decoding JSON texts.
429
430This setting has currently no effect on tied hashes.
448 431
449=item $json = $json->allow_nonref ([$enable]) 432=item $json = $json->allow_nonref ([$enable])
450 433
451=item $enabled = $json->get_allow_nonref 434=item $enabled = $json->get_allow_nonref
452 435
667 650
668See SECURITY CONSIDERATIONS, below, for more info on why this is useful. 651See SECURITY CONSIDERATIONS, below, for more info on why this is useful.
669 652
670=item $json_text = $json->encode ($perl_scalar) 653=item $json_text = $json->encode ($perl_scalar)
671 654
672Converts the given Perl data structure (a simple scalar or a reference 655Converts the given Perl value or data structure to its JSON
673to a hash or array) to its JSON representation. Simple scalars will be 656representation. Croaks on error.
674converted into JSON string or number sequences, while references to arrays
675become JSON arrays and references to hashes become JSON objects. Undefined
676Perl values (e.g. C<undef>) become JSON C<null> values. Neither C<true>
677nor C<false> values will be generated.
678 657
679=item $perl_scalar = $json->decode ($json_text) 658=item $perl_scalar = $json->decode ($json_text)
680 659
681The opposite of C<encode>: expects a JSON text and tries to parse it, 660The opposite of C<encode>: expects a JSON text and tries to parse it,
682returning the resulting simple scalar or reference. Croaks on error. 661returning the resulting simple scalar or reference. Croaks on error.
683
684JSON numbers and strings become simple Perl scalars. JSON arrays become
685Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes
686C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.
687 662
688=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text) 663=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text)
689 664
690This works like the C<decode> method, but instead of raising an exception 665This works like the C<decode> method, but instead of raising an exception
691when there is trailing garbage after the first JSON object, it will 666when there is trailing garbage after the first JSON object, it will
692silently stop parsing there and return the number of characters consumed 667silently stop parsing there and return the number of characters consumed
693so far. 668so far.
694 669
695This is useful if your JSON texts are not delimited by an outer protocol 670This is useful if your JSON texts are not delimited by an outer protocol
696(which is not the brightest thing to do in the first place) and you need
697to know where the JSON text ends. 671and you need to know where the JSON text ends.
698 672
699 JSON::XS->new->decode_prefix ("[1] the tail") 673 JSON::XS->new->decode_prefix ("[1] the tail")
700 => ([], 3) 674 => ([], 3)
701 675
702=back 676=back
714calls). 688calls).
715 689
716JSON::XS will only attempt to parse the JSON text once it is sure it 690JSON::XS will only attempt to parse the JSON text once it is sure it
717has enough text to get a decisive result, using a very simple but 691has enough text to get a decisive result, using a very simple but
718truly incremental parser. This means that it sometimes won't stop as 692truly incremental parser. This means that it sometimes won't stop as
719early as the full parser, for example, it doesn't detect parenthese 693early as the full parser, for example, it doesn't detect mismatched
720mismatches. The only thing it guarantees is that it starts decoding as 694parentheses. The only thing it guarantees is that it starts decoding as
721soon as a syntactically valid JSON text has been seen. This means you need 695soon as a syntactically valid JSON text has been seen. This means you need
722to set resource limits (e.g. C<max_size>) to ensure the parser will stop 696to set resource limits (e.g. C<max_size>) to ensure the parser will stop
723parsing in the presence if syntax errors. 697parsing in the presence if syntax errors.
724 698
725The following methods implement this incremental parser. 699The following methods implement this incremental parser.
741 715
742If the method is called in scalar context, then it will try to extract 716If the method is called in scalar context, then it will try to extract
743exactly I<one> JSON object. If that is successful, it will return this 717exactly I<one> JSON object. If that is successful, it will return this
744object, otherwise it will return C<undef>. If there is a parse error, 718object, otherwise it will return C<undef>. If there is a parse error,
745this method will croak just as C<decode> would do (one can then use 719this method will croak just as C<decode> would do (one can then use
746C<incr_skip> to skip the errornous part). This is the most common way of 720C<incr_skip> to skip the erroneous part). This is the most common way of
747using the method. 721using the method.
748 722
749And finally, in list context, it will try to extract as many objects 723And finally, in list context, it will try to extract as many objects
750from the stream as it can find and return them, or the empty list 724from the stream as it can find and return them, or the empty list
751otherwise. For this to work, there must be no separators between the JSON 725otherwise. For this to work, there must be no separators between the JSON
752objects or arrays, instead they must be concatenated back-to-back. If 726objects or arrays, instead they must be concatenated back-to-back. If
753an error occurs, an exception will be raised as in the scalar context 727an error occurs, an exception will be raised as in the scalar context
754case. Note that in this case, any previously-parsed JSON texts will be 728case. Note that in this case, any previously-parsed JSON texts will be
755lost. 729lost.
756 730
731Example: Parse some JSON arrays/objects in a given string and return
732them.
733
734 my @objs = JSON::XS->new->incr_parse ("[5][7][1,2]");
735
757=item $lvalue_string = $json->incr_text 736=item $lvalue_string = $json->incr_text
758 737
759This method returns the currently stored JSON fragment as an lvalue, that 738This method returns the currently stored JSON fragment as an lvalue, that
760is, you can manipulate it. This I<only> works when a preceding call to 739is, you can manipulate it. This I<only> works when a preceding call to
761C<incr_parse> in I<scalar context> successfully returned an object. Under 740C<incr_parse> in I<scalar context> successfully returned an object. Under
768JSON object or b) parsing multiple JSON objects separated by non-JSON text 747JSON object or b) parsing multiple JSON objects separated by non-JSON text
769(such as commas). 748(such as commas).
770 749
771=item $json->incr_skip 750=item $json->incr_skip
772 751
773This will reset the state of the incremental parser and will remove the 752This will reset the state of the incremental parser and will remove
774parsed text from the input buffer. This is useful after C<incr_parse> 753the parsed text from the input buffer so far. This is useful after
775died, in which case the input buffer and incremental parser state is left 754C<incr_parse> died, in which case the input buffer and incremental parser
776unchanged, to skip the text parsed so far and to reset the parse state. 755state is left unchanged, to skip the text parsed so far and to reset the
756parse state.
757
758The difference to C<incr_reset> is that only text until the parse error
759occurred is removed.
777 760
778=item $json->incr_reset 761=item $json->incr_reset
779 762
780This completely resets the incremental parser, that is, after this call, 763This completely resets the incremental parser, that is, after this call,
781it will be as if the parser had never parsed anything. 764it will be as if the parser had never parsed anything.
782 765
783This is useful if you want ot repeatedly parse JSON objects and want to 766This is useful if you want to repeatedly parse JSON objects and want to
784ignore any trailing data, which means you have to reset the parser after 767ignore any trailing data, which means you have to reset the parser after
785each successful decode. 768each successful decode.
786 769
787=back 770=back
788 771
789=head2 LIMITATIONS 772=head2 LIMITATIONS
790 773
791All options that affect decoding are supported, except 774All options that affect decoding are supported, except
792C<allow_nonref>. The reason for this is that it cannot be made to 775C<allow_nonref>. The reason for this is that it cannot be made to work
793work sensibly: JSON objects and arrays are self-delimited, i.e. you can concatenate 776sensibly: JSON objects and arrays are self-delimited, i.e. you can
794them back to back and still decode them perfectly. This does not hold true 777concatenate them back to back and still decode them perfectly. This does
795for JSON numbers, however. 778not hold true for JSON numbers, however.
796 779
797For example, is the string C<1> a single JSON number, or is it simply the 780For example, is the string C<1> a single JSON number, or is it simply the
798start of C<12>? Or is C<12> a single JSON number, or the concatenation 781start of C<12>? Or is C<12> a single JSON number, or the concatenation
799of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS 782of C<1> and C<2>? In neither case you can tell, and this is why JSON::XS
800takes the conservative route and disallows this case. 783takes the conservative route and disallows this case.
979If the number consists of digits only, JSON::XS will try to represent 962If the number consists of digits only, JSON::XS will try to represent
980it as an integer value. If that fails, it will try to represent it as 963it as an integer value. If that fails, it will try to represent it as
981a numeric (floating point) value if that is possible without loss of 964a numeric (floating point) value if that is possible without loss of
982precision. Otherwise it will preserve the number as a string value (in 965precision. Otherwise it will preserve the number as a string value (in
983which case you lose roundtripping ability, as the JSON number will be 966which case you lose roundtripping ability, as the JSON number will be
984re-encoded toa JSON string). 967re-encoded to a JSON string).
985 968
986Numbers containing a fractional or exponential part will always be 969Numbers containing a fractional or exponential part will always be
987represented as numeric (floating point) values, possibly at a loss of 970represented as numeric (floating point) values, possibly at a loss of
988precision (in which case you might lose perfect roundtripping ability, but 971precision (in which case you might lose perfect roundtripping ability, but
989the JSON number will still be re-encoded as a JSON number). 972the JSON number will still be re-encoded as a JSON number).
990 973
974Note that precision is not accuracy - binary floating point values cannot
975represent most decimal fractions exactly, and when converting from and to
976floating point, JSON::XS only guarantees precision up to but not including
977the least significant bit.
978
991=item true, false 979=item true, false
992 980
993These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, 981These JSON atoms become C<Types::Serialiser::true> and
994respectively. They are overloaded to act almost exactly like the numbers 982C<Types::Serialiser::false>, respectively. They are overloaded to act
995C<1> and C<0>. You can check whether a scalar is a JSON boolean by using 983almost exactly like the numbers C<1> and C<0>. You can check whether
996the C<JSON::XS::is_bool> function. 984a scalar is a JSON boolean by using the C<Types::Serialiser::is_bool>
985function (after C<use Types::Serialier>, of course).
997 986
998=item null 987=item null
999 988
1000A JSON null atom becomes C<undef> in Perl. 989A JSON null atom becomes C<undef> in Perl.
1001 990
1010 999
1011=over 4 1000=over 4
1012 1001
1013=item hash references 1002=item hash references
1014 1003
1015Perl hash references become JSON objects. As there is no inherent ordering 1004Perl hash references become JSON objects. As there is no inherent
1016in hash keys (or JSON objects), they will usually be encoded in a 1005ordering in hash keys (or JSON objects), they will usually be encoded
1017pseudo-random order that can change between runs of the same program but 1006in a pseudo-random order. JSON::XS can optionally sort the hash keys
1018stays generally the same within a single run of a program. JSON::XS can 1007(determined by the I<canonical> flag), so the same datastructure will
1019optionally sort the hash keys (determined by the I<canonical> flag), so 1008serialise to the same JSON text (given same settings and version of
1020the same datastructure will serialise to the same JSON text (given same 1009JSON::XS), but this incurs a runtime overhead and is only rarely useful,
1021settings and version of JSON::XS), but this incurs a runtime overhead 1010e.g. when you want to compare some JSON text against another for equality.
1022and is only rarely useful, e.g. when you want to compare some JSON text
1023against another for equality.
1024 1011
1025=item array references 1012=item array references
1026 1013
1027Perl array references become JSON arrays. 1014Perl array references become JSON arrays.
1028 1015
1029=item other references 1016=item other references
1030 1017
1031Other unblessed references are generally not allowed and will cause an 1018Other unblessed references are generally not allowed and will cause an
1032exception to be thrown, except for references to the integers C<0> and 1019exception to be thrown, except for references to the integers C<0> and
1033C<1>, which get turned into C<false> and C<true> atoms in JSON. You can 1020C<1>, which get turned into C<false> and C<true> atoms in JSON.
1034also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
1035 1021
1022Since C<JSON::XS> uses the boolean model from L<Types::Serialiser>, you
1023can also C<use Types::Serialiser> and then use C<Types::Serialiser::false>
1024and C<Types::Serialiser::true> to improve readability.
1025
1026 use Types::Serialiser;
1036 encode_json [\0, JSON::XS::true] # yields [false,true] 1027 encode_json [\0, Types::Serialiser::true] # yields [false,true]
1037 1028
1038=item JSON::XS::true, JSON::XS::false 1029=item Types::Serialiser::true, Types::Serialiser::false
1039 1030
1040These special values become JSON true and JSON false values, 1031These special values from the L<Types::Serialiser> module become JSON true
1041respectively. You can also use C<\1> and C<\0> directly if you want. 1032and JSON false values, respectively. You can also use C<\1> and C<\0>
1033directly if you want.
1042 1034
1043=item blessed objects 1035=item blessed objects
1044 1036
1045Blessed objects are not directly representable in JSON. See the 1037Blessed objects are not directly representable in JSON. See the
1046C<allow_blessed> and C<convert_blessed> methods on various options on 1038C<allow_blessed> and C<convert_blessed> methods on various options on
1081 $x *= 1; # same thing, the choice is yours. 1073 $x *= 1; # same thing, the choice is yours.
1082 1074
1083You can not currently force the type in other, less obscure, ways. Tell me 1075You can not currently force the type in other, less obscure, ways. Tell me
1084if you need this capability (but don't forget to explain why it's needed 1076if you need this capability (but don't forget to explain why it's needed
1085:). 1077:).
1078
1079Note that numerical precision has the same meaning as under Perl (so
1080binary to decimal conversion follows the same rules as in Perl, which
1081can differ to other languages). Also, your perl interpreter might expose
1082extensions to the floating point numbers of your platform, such as
1083infinities or NaN's - these cannot be represented in JSON, and it is an
1084error to pass those in.
1086 1085
1087=back 1086=back
1088 1087
1089 1088
1090=head1 ENCODING/CODESET FLAG NOTES 1089=head1 ENCODING/CODESET FLAG NOTES
1117=item C<utf8> flag disabled 1116=item C<utf8> flag disabled
1118 1117
1119When C<utf8> is disabled (the default), then C<encode>/C<decode> generate 1118When C<utf8> is disabled (the default), then C<encode>/C<decode> generate
1120and expect Unicode strings, that is, characters with high ordinal Unicode 1119and expect Unicode strings, that is, characters with high ordinal Unicode
1121values (> 255) will be encoded as such characters, and likewise such 1120values (> 255) will be encoded as such characters, and likewise such
1122characters are decoded as-is, no canges to them will be done, except 1121characters are decoded as-is, no changes to them will be done, except
1123"(re-)interpreting" them as Unicode codepoints or Unicode characters, 1122"(re-)interpreting" them as Unicode codepoints or Unicode characters,
1124respectively (to Perl, these are the same thing in strings unless you do 1123respectively (to Perl, these are the same thing in strings unless you do
1125funny/weird/dumb stuff). 1124funny/weird/dumb stuff).
1126 1125
1127This is useful when you want to do the encoding yourself (e.g. when you 1126This is useful when you want to do the encoding yourself (e.g. when you
1183proper subset of most 8-bit and multibyte encodings in use in the world. 1182proper subset of most 8-bit and multibyte encodings in use in the world.
1184 1183
1185=back 1184=back
1186 1185
1187 1186
1187=head2 JSON and ECMAscript
1188
1189JSON syntax is based on how literals are represented in javascript (the
1190not-standardised predecessor of ECMAscript) which is presumably why it is
1191called "JavaScript Object Notation".
1192
1193However, JSON is not a subset (and also not a superset of course) of
1194ECMAscript (the standard) or javascript (whatever browsers actually
1195implement).
1196
1197If you want to use javascript's C<eval> function to "parse" JSON, you
1198might run into parse errors for valid JSON texts, or the resulting data
1199structure might not be queryable:
1200
1201One of the problems is that U+2028 and U+2029 are valid characters inside
1202JSON strings, but are not allowed in ECMAscript string literals, so the
1203following Perl fragment will not output something that can be guaranteed
1204to be parsable by javascript's C<eval>:
1205
1206 use JSON::XS;
1207
1208 print encode_json [chr 0x2028];
1209
1210The right fix for this is to use a proper JSON parser in your javascript
1211programs, and not rely on C<eval> (see for example Douglas Crockford's
1212F<json2.js> parser).
1213
1214If this is not an option, you can, as a stop-gap measure, simply encode to
1215ASCII-only JSON:
1216
1217 use JSON::XS;
1218
1219 print JSON::XS->new->ascii->encode ([chr 0x2028]);
1220
1221Note that this will enlarge the resulting JSON text quite a bit if you
1222have many non-ASCII characters. You might be tempted to run some regexes
1223to only escape U+2028 and U+2029, e.g.:
1224
1225 # DO NOT USE THIS!
1226 my $json = JSON::XS->new->utf8->encode ([chr 0x2028]);
1227 $json =~ s/\xe2\x80\xa8/\\u2028/g; # escape U+2028
1228 $json =~ s/\xe2\x80\xa9/\\u2029/g; # escape U+2029
1229 print $json;
1230
1231Note that I<this is a bad idea>: the above only works for U+2028 and
1232U+2029 and thus only for fully ECMAscript-compliant parsers. Many existing
1233javascript implementations, however, have issues with other characters as
1234well - using C<eval> naively simply I<will> cause problems.
1235
1236Another problem is that some javascript implementations reserve
1237some property names for their own purposes (which probably makes
1238them non-ECMAscript-compliant). For example, Iceweasel reserves the
1239C<__proto__> property name for its own purposes.
1240
1241If that is a problem, you could parse try to filter the resulting JSON
1242output for these property strings, e.g.:
1243
1244 $json =~ s/"__proto__"\s*:/"__proto__renamed":/g;
1245
1246This works because C<__proto__> is not valid outside of strings, so every
1247occurrence of C<"__proto__"\s*:> must be a string used as property name.
1248
1249If you know of other incompatibilities, please let me know.
1250
1251
1188=head2 JSON and YAML 1252=head2 JSON and YAML
1189 1253
1190You often hear that JSON is a subset of YAML. This is, however, a mass 1254You often hear that JSON is a subset of YAML. This is, however, a mass
1191hysteria(*) and very far from the truth (as of the time of this writing), 1255hysteria(*) and very far from the truth (as of the time of this writing),
1192so let me state it clearly: I<in general, there is no way to configure 1256so let me state it clearly: I<in general, there is no way to configure
1200 my $yaml = $to_yaml->encode ($ref) . "\n"; 1264 my $yaml = $to_yaml->encode ($ref) . "\n";
1201 1265
1202This will I<usually> generate JSON texts that also parse as valid 1266This will I<usually> generate JSON texts that also parse as valid
1203YAML. Please note that YAML has hardcoded limits on (simple) object key 1267YAML. Please note that YAML has hardcoded limits on (simple) object key
1204lengths that JSON doesn't have and also has different and incompatible 1268lengths that JSON doesn't have and also has different and incompatible
1205unicode handling, so you should make sure that your hash keys are 1269unicode character escape syntax, so you should make sure that your hash
1206noticeably shorter than the 1024 "stream characters" YAML allows and that 1270keys are noticeably shorter than the 1024 "stream characters" YAML allows
1207you do not have characters with codepoint values outside the Unicode BMP 1271and that you do not have characters with codepoint values outside the
1208(basic multilingual page). YAML also does not allow C<\/> sequences in 1272Unicode BMP (basic multilingual page). YAML also does not allow C<\/>
1209strings (which JSON::XS does not I<currently> generate, but other JSON 1273sequences in strings (which JSON::XS does not I<currently> generate, but
1210generators might). 1274other JSON generators might).
1211 1275
1212There might be other incompatibilities that I am not aware of (or the YAML 1276There might be other incompatibilities that I am not aware of (or the YAML
1213specification has been changed yet again - it does so quite often). In 1277specification has been changed yet again - it does so quite often). In
1214general you should not try to generate YAML with a JSON generator or vice 1278general you should not try to generate YAML with a JSON generator or vice
1215versa, or try to parse JSON with a YAML parser or vice versa: chances are 1279versa, or try to parse JSON with a YAML parser or vice versa: chances are
1234that difficult or long) and finally make YAML compatible to it, and 1298that difficult or long) and finally make YAML compatible to it, and
1235educating users about the changes, instead of spreading lies about the 1299educating users about the changes, instead of spreading lies about the
1236real compatibility for many I<years> and trying to silence people who 1300real compatibility for many I<years> and trying to silence people who
1237point out that it isn't true. 1301point out that it isn't true.
1238 1302
1303Addendum/2009: the YAML 1.2 spec is still incompatible with JSON, even
1304though the incompatibilities have been documented (and are known to Brian)
1305for many years and the spec makes explicit claims that YAML is a superset
1306of JSON. It would be so easy to fix, but apparently, bullying people and
1307corrupting userdata is so much easier.
1308
1239=back 1309=back
1240 1310
1241 1311
1242=head2 SPEED 1312=head2 SPEED
1243 1313
1250a very short single-line JSON string (also available at 1320a very short single-line JSON string (also available at
1251L<http://dist.schmorp.de/misc/json/short.json>). 1321L<http://dist.schmorp.de/misc/json/short.json>).
1252 1322
1253 {"method": "handleMessage", "params": ["user1", 1323 {"method": "handleMessage", "params": ["user1",
1254 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, 1324 "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
1255 true, false]} 1325 1, 0]}
1256 1326
1257It shows the number of encodes/decodes per second (JSON::XS uses 1327It shows the number of encodes/decodes per second (JSON::XS uses
1258the functional interface, while JSON::XS/2 uses the OO interface 1328the functional interface, while JSON::XS/2 uses the OO interface
1259with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables 1329with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
1260shrink). Higher is better: 1330shrink. JSON::DWIW/DS uses the deserialise function, while JSON::DWIW::FJ
1331uses the from_json method). Higher is better:
1261 1332
1262 module | encode | decode | 1333 module | encode | decode |
1263 -----------|------------|------------| 1334 --------------|------------|------------|
1264 JSON 1.x | 4990.842 | 4088.813 | 1335 JSON::DWIW/DS | 86302.551 | 102300.098 |
1265 JSON::DWIW | 51653.990 | 71575.154 | 1336 JSON::DWIW/FJ | 86302.551 | 75983.768 |
1266 JSON::PC | 65948.176 | 74631.744 | 1337 JSON::PP | 15827.562 | 6638.658 |
1267 JSON::PP | 8931.652 | 3817.168 | 1338 JSON::Syck | 63358.066 | 47662.545 |
1268 JSON::Syck | 24877.248 | 27776.848 | 1339 JSON::XS | 511500.488 | 511500.488 |
1269 JSON::XS | 388361.481 | 227951.304 | 1340 JSON::XS/2 | 291271.111 | 388361.481 |
1270 JSON::XS/2 | 227951.304 | 218453.333 | 1341 JSON::XS/3 | 361577.931 | 361577.931 |
1271 JSON::XS/3 | 338250.323 | 218453.333 | 1342 Storable | 66788.280 | 265462.278 |
1272 Storable | 16500.016 | 135300.129 |
1273 -----------+------------+------------+ 1343 --------------+------------+------------+
1274 1344
1275That is, JSON::XS is about five times faster than JSON::DWIW on encoding, 1345That is, JSON::XS is almost six times faster than JSON::DWIW on encoding,
1276about three times faster on decoding, and over forty times faster 1346about five times faster on decoding, and over thirty to seventy times
1277than JSON, even with pretty-printing and key sorting. It also compares 1347faster than JSON's pure perl implementation. It also compares favourably
1278favourably to Storable for small amounts of data. 1348to Storable for small amounts of data.
1279 1349
1280Using a longer test string (roughly 18KB, generated from Yahoo! Locals 1350Using a longer test string (roughly 18KB, generated from Yahoo! Locals
1281search API (L<http://dist.schmorp.de/misc/json/long.json>). 1351search API (L<http://dist.schmorp.de/misc/json/long.json>).
1282 1352
1283 module | encode | decode | 1353 module | encode | decode |
1284 -----------|------------|------------| 1354 --------------|------------|------------|
1285 JSON 1.x | 55.260 | 34.971 | 1355 JSON::DWIW/DS | 1647.927 | 2673.916 |
1286 JSON::DWIW | 825.228 | 1082.513 | 1356 JSON::DWIW/FJ | 1630.249 | 2596.128 |
1287 JSON::PC | 3571.444 | 2394.829 |
1288 JSON::PP | 210.987 | 32.574 | 1357 JSON::PP | 400.640 | 62.311 |
1289 JSON::Syck | 552.551 | 787.544 | 1358 JSON::Syck | 1481.040 | 1524.869 |
1290 JSON::XS | 5780.463 | 4854.519 | 1359 JSON::XS | 20661.596 | 9541.183 |
1291 JSON::XS/2 | 3869.998 | 4798.975 | 1360 JSON::XS/2 | 10683.403 | 9416.938 |
1292 JSON::XS/3 | 5862.880 | 4798.975 | 1361 JSON::XS/3 | 20661.596 | 9400.054 |
1293 Storable | 4445.002 | 5235.027 | 1362 Storable | 19765.806 | 10000.725 |
1294 -----------+------------+------------+ 1363 --------------+------------+------------+
1295 1364
1296Again, JSON::XS leads by far (except for Storable which non-surprisingly 1365Again, JSON::XS leads by far (except for Storable which non-surprisingly
1297decodes faster). 1366decodes a bit faster).
1298 1367
1299On large strings containing lots of high Unicode characters, some modules 1368On large strings containing lots of high Unicode characters, some modules
1300(such as JSON::PC) seem to decode faster than JSON::XS, but the result 1369(such as JSON::PC) seem to decode faster than JSON::XS, but the result
1301will be broken due to missing (or wrong) Unicode handling. Others refuse 1370will be broken due to missing (or wrong) Unicode handling. Others refuse
1302to decode or encode properly, so it was impossible to prepare a fair 1371to decode or encode properly, so it was impossible to prepare a fair
1338information you might want to make sure that exceptions thrown by JSON::XS 1407information you might want to make sure that exceptions thrown by JSON::XS
1339will not end up in front of untrusted eyes. 1408will not end up in front of untrusted eyes.
1340 1409
1341If you are using JSON::XS to return packets to consumption 1410If you are using JSON::XS to return packets to consumption
1342by JavaScript scripts in a browser you should have a look at 1411by JavaScript scripts in a browser you should have a look at
1343L<http://jpsykes.com/47/practical-csrf-and-json-security> to see whether 1412L<http://blog.archive.jpsykes.com/47/practical-csrf-and-json-security/> to
1344you are vulnerable to some common attack vectors (which really are browser 1413see whether you are vulnerable to some common attack vectors (which really
1345design bugs, but it is still you who will have to deal with it, as major 1414are browser design bugs, but it is still you who will have to deal with
1346browser developers care only for features, not about getting security 1415it, as major browser developers care only for features, not about getting
1347right). 1416security right).
1417
1418
1419=head1 INTEROPERABILITY WITH OTHER MODULES
1420
1421C<JSON::XS> uses the L<Types::Serialiser> module to provide boolean
1422constants. That means that the JSON true and false values will be
1423comaptible to true and false values of iother modules that do the same,
1424such as L<JSON::PP> and L<CBOR::XS>.
1348 1425
1349 1426
1350=head1 THREADS 1427=head1 THREADS
1351 1428
1352This module is I<not> guaranteed to be thread safe and there are no 1429This module is I<not> guaranteed to be thread safe and there are no
1355process simulations - use fork, it's I<much> faster, cheaper, better). 1432process simulations - use fork, it's I<much> faster, cheaper, better).
1356 1433
1357(It might actually work, but you have been warned). 1434(It might actually work, but you have been warned).
1358 1435
1359 1436
1437=head1 THE PERILS OF SETLOCALE
1438
1439Sometimes people avoid the Perl locale support and directly call the
1440system's setlocale function with C<LC_ALL>.
1441
1442This breaks both perl and modules such as JSON::XS, as stringification of
1443numbers no longer works correctly (e.g. C<$x = 0.1; print "$x"+1> might
1444print C<1>, and JSON::XS might output illegal JSON as JSON::XS relies on
1445perl to stringify numbers).
1446
1447The solution is simple: don't call C<setlocale>, or use it for only those
1448categories you need, such as C<LC_MESSAGES> or C<LC_CTYPE>.
1449
1450If you need C<LC_NUMERIC>, you should enable it only around the code that
1451actually needs it (avoiding stringification of numbers), and restore it
1452afterwards.
1453
1454
1360=head1 BUGS 1455=head1 BUGS
1361 1456
1362While the goal of this module is to be correct, that unfortunately does 1457While the goal of this module is to be correct, that unfortunately does
1363not mean it's bug-free, only that I think its design is bug-free. If you 1458not mean it's bug-free, only that I think its design is bug-free. If you
1364keep reporting bugs they will be fixed swiftly, though. 1459keep reporting bugs they will be fixed swiftly, though.
1366Please refrain from using rt.cpan.org or any other bug reporting 1461Please refrain from using rt.cpan.org or any other bug reporting
1367service. I put the contact address into my modules for a reason. 1462service. I put the contact address into my modules for a reason.
1368 1463
1369=cut 1464=cut
1370 1465
1371our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; 1466BEGIN {
1372our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; 1467 *true = \$Types::Serialiser::true;
1468 *true = \&Types::Serialiser::true;
1469 *false = \$Types::Serialiser::false;
1470 *false = \&Types::Serialiser::false;
1471 *is_bool = \&Types::Serialiser::is_bool;
1373 1472
1374sub true() { $true } 1473 *JSON::XS::Boolean:: = *Types::Serialiser::Boolean::;
1375sub false() { $false }
1376
1377sub is_bool($) {
1378 UNIVERSAL::isa $_[0], "JSON::XS::Boolean"
1379# or UNIVERSAL::isa $_[0], "JSON::Literal"
1380} 1474}
1381 1475
1382XSLoader::load "JSON::XS", $VERSION; 1476XSLoader::load "JSON::XS", $VERSION;
1383
1384package JSON::XS::Boolean;
1385
1386use overload
1387 "0+" => sub { ${$_[0]} },
1388 "++" => sub { $_[0] = ${$_[0]} + 1 },
1389 "--" => sub { $_[0] = ${$_[0]} - 1 },
1390 fallback => 1;
1391
13921;
1393 1477
1394=head1 SEE ALSO 1478=head1 SEE ALSO
1395 1479
1396The F<json_xs> command line utility for quick experiments. 1480The F<json_xs> command line utility for quick experiments.
1397 1481
1400 Marc Lehmann <schmorp@schmorp.de> 1484 Marc Lehmann <schmorp@schmorp.de>
1401 http://home.schmorp.de/ 1485 http://home.schmorp.de/
1402 1486
1403=cut 1487=cut
1404 1488
14891
1490

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines