--- JSON-XS/XS.pm 2008/03/25 07:46:15 1.94 +++ JSON-XS/XS.pm 2008/03/30 09:27:16 1.100 @@ -105,7 +105,7 @@ use strict; -our $VERSION = '2.1'; +our $VERSION = '2.2'; our @ISA = qw(Exporter); our @EXPORT = qw(encode_json decode_json to_json from_json); @@ -465,6 +465,22 @@ JSON::XS->new->allow_nonref->encode ("Hello, World!") => "Hello, World!" +=item $json = $json->allow_unknown ([$enable]) + +=item $enabled = $json->get_allow_unknown + +If C<$enable> is true (or missing), then C will I throw an +exception when it encounters values it cannot represent in JSON (for +example, filehandles) but instead will encode a JSON C value. Note +that blessed objects are not included here and are handled separately by +c. + +If C<$enable> is false (the default), then C will throw an +exception when it encounters anything it cannot encode as JSON. + +This option does not affect C in any way, and it is recommended to +leave it off unless you know your communications partner. + =item $json = $json->allow_blessed ([$enable]) =item $enabled = $json->get_allow_blessed @@ -685,7 +701,7 @@ =head1 INCREMENTAL PARSING -[This section is still EXPERIMENTAL] +[This section and the API it details is still EXPERIMENTAL] In some cases, there is the need for incremental parsing of JSON texts. While this module always has to keep both JSON text and resulting @@ -716,13 +732,18 @@ If the method is called in scalar context, then it will try to extract exactly I JSON object. If that is successful, it will return this -object, otherwise it will return C. This is the most common way of +object, otherwise it will return C. If there is a parse error, +this method will croak just as C would do (one can then use +C to skip the errornous part). This is the most common way of using the method. And finally, in list context, it will try to extract as many objects from the stream as it can find and return them, or the empty list otherwise. For this to work, there must be no separators between the JSON -objects or arrays, instead they must be concatenated back-to-back. +objects or arrays, instead they must be concatenated back-to-back. If +an error occurs, an exception will be raised as in the scalar context +case. Note that in this case, any previously-parsed JSON texts will be +lost. =item $lvalue_string = $json->incr_text @@ -738,6 +759,13 @@ JSON object or b) parsing multiple JSON objects separated by non-JSON text (such as commas). +=item $json->incr_skip + +This will reset the state of the incremental parser and will remove the +parsed text from the input buffer. This is useful after C +died, in which case the input buffer and incremental parser state is left +unchanged, to skip the text parsed so far and to reset the parse state. + =back =head2 LIMITATIONS @@ -1139,104 +1167,6 @@ =back -=head1 COMPARISON - -As already mentioned, this module was created because none of the existing -JSON modules could be made to work correctly. First I will describe the -problems (or pleasures) I encountered with various existing JSON modules, -followed by some benchmark values. JSON::XS was designed not to suffer -from any of these problems or limitations. - -=over 4 - -=item JSON 2.xx - -A marvellous piece of engineering, this module either uses JSON::XS -directly when available (so will be 100% compatible with it, including -speed), or it uses JSON::PP, which is basically JSON::XS translated to -Pure Perl, which should be 100% compatible with JSON::XS, just a bit -slower. - -You cannot really lose by using this module, especially as it tries very -hard to work even with ancient Perl versions, while JSON::XS does not. - -=item JSON 1.07 - -Slow (but very portable, as it is written in pure Perl). - -Undocumented/buggy Unicode handling (how JSON handles Unicode values is -undocumented. One can get far by feeding it Unicode strings and doing -en-/decoding oneself, but Unicode escapes are not working properly). - -No round-tripping (strings get clobbered if they look like numbers, e.g. -the string C<2.0> will encode to C<2.0> instead of C<"2.0">, and that will -decode into the number 2. - -=item JSON::PC 0.01 - -Very fast. - -Undocumented/buggy Unicode handling. - -No round-tripping. - -Has problems handling many Perl values (e.g. regex results and other magic -values will make it croak). - -Does not even generate valid JSON (C<{1,2}> gets converted to C<{1:2}> -which is not a valid JSON text. - -Unmaintained (maintainer unresponsive for many months, bugs are not -getting fixed). - -=item JSON::Syck 0.21 - -Very buggy (often crashes). - -Very inflexible (no human-readable format supported, format pretty much -undocumented. I need at least a format for easy reading by humans and a -single-line compact format for use in a protocol, and preferably a way to -generate ASCII-only JSON texts). - -Completely broken (and confusingly documented) Unicode handling (Unicode -escapes are not working properly, you need to set ImplicitUnicode to -I values on en- and decoding to get symmetric behaviour). - -No round-tripping (simple cases work, but this depends on whether the scalar -value was used in a numeric context or not). - -Dumping hashes may skip hash values depending on iterator state. - -Unmaintained (maintainer unresponsive for many months, bugs are not -getting fixed). - -Does not check input for validity (i.e. will accept non-JSON input and -return "something" instead of raising an exception. This is a security -issue: imagine two banks transferring money between each other using -JSON. One bank might parse a given non-JSON request and deduct money, -while the other might reject the transaction with a syntax error. While a -good protocol will at least recover, that is extra unnecessary work and -the transaction will still not succeed). - -=item JSON::DWIW 0.04 - -Very fast. Very natural. Very nice. - -Undocumented Unicode handling (but the best of the pack. Unicode escapes -still don't get parsed properly). - -Very inflexible. - -No round-tripping. - -Does not generate valid JSON texts (key strings are often unquoted, empty keys -result in nothing being output) - -Does not check input for validity. - -=back - - =head2 JSON and YAML You often hear that JSON is a subset of YAML. This is, however, a mass @@ -1302,8 +1232,9 @@ a very short single-line JSON string (also available at L). - {"method": "handleMessage", "params": ["user1", "we were just talking"], \ - "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} + {"method": "handleMessage", "params": ["user1", + "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, + true, false]} It shows the number of encodes/decodes per second (JSON::XS uses the functional interface, while JSON::XS/2 uses the OO interface