[ViewVC] Diff of: cvs/JSON-XS/XS.pm

Comparing JSON-XS/XS.pm (file contents):
Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs.
Revision 1.43 by root, Sat Jun 23 23:49:29 2007 UTC

 package JSON::XS;
 use strict;
-BEGIN {
-   our $VERSION = '1.23';
+our $VERSION = '1.3';
-   our @ISA = qw(Exporter);
+our @ISA = qw(Exporter);
-   our @EXPORT = qw(to_json from_json objToJson jsonToObj);
+our @EXPORT = qw(to_json from_json objToJson jsonToObj);
-   require Exporter;
-   require XSLoader;
+use Exporter;
-   XSLoader::load JSON::XS::, $VERSION;
+use XSLoader;
-}
 =head1 FUNCTIONAL INTERFACE
 The following convinience methods are provided by this module. They are
 exported by default:
 This function call is functionally identical to:
    $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
 except being faster.
+=item $is_boolean = JSON::XS::is_bool $scalar
+Returns true if the passed scalar represents either JSON::XS::true or
+JSON::XS::false, two constants that act like C<1> and C<0>, respectively
+and are used to represent JSON C<true> and C<false> values in Perl.
+See MAPPING, below, for more information on how JSON values are mapped to
+Perl.
 =back
 =head1 OBJECT-ORIENTED INTERFACE
 For the more enlightened: note that in the following descriptions,
 lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl>
 refers to the abstract Perl language itself.
 =head2 JSON -> PERL
 =over 4
 =item object
 conversion details, but an integer may take slightly less memory and might
 represent more values exactly than (floating point) numbers.
 =item true, false
-These JSON atoms become C<0>, C<1>, respectively. Information is lost in
+These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,
-this process. Future versions might represent those values differently,
+respectively. They are overloaded to act almost exactly like the numbers
-but they will be guarenteed to act like these integers would normally in
+C<1> and C<0>. You can check wether a scalar is a JSON boolean by using
-Perl.
+the C<JSON::XS::is_bool> function.
 =item null
 A JSON null atom becomes C<undef> in Perl.
 =back
 =head2 PERL -> JSON
 The mapping from Perl to JSON is slightly more difficult, as Perl is a
 truly typeless language, so we can only guess which JSON type is meant by
 C<1>, which get turned into C<false> and C<true> atoms in JSON. You can
 also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
    to_json [\0,JSON::XS::true]      # yields [false,true]
+=item JSON::XS::true, JSON::XS::false
+These special values become JSON true and JSON false values,
+respectively. You cna alos use C<\1> and C<\0> directly if you want.
 =item blessed objects
 Blessed objects are not allowed. JSON::XS currently tries to encode their
 underlying representation (hash- or arrayref), but this behaviour might
 change in future versions.
 Does not check input for validity.
 =back
+=head2 JSON and YAML
+You often hear that JSON is a subset (or a close subset) of YAML. This is,
+however, a mass hysteria and very far from the truth. In general, there is
+no way to configure JSON::XS to output a data structure as valid YAML.
+If you really must use JSON::XS to generate YAML, you should use this
+algorithm (subject to change in future versions):
+   my $to_yaml = JSON::XS->new->utf8->space_after (1);
+   my $yaml = $to_yaml->encode ($ref) . "\n";
+This will usually generate JSON texts that also parse as valid
+YAML. Please note that YAML has hardcoded limits on (simple) object key
+lengths that JSON doesn't have, so you should make sure that your hash
+keys are noticably shorter than the 1024 characters YAML allows.
+There might be other incompatibilities that I am not aware of. In general
+you should not try to generate YAML with a JSON generator or vice versa,
+or try to parse JSON with a YAML parser or vice versa: chances are high
+that you will run into severe interoperability problems.
 =head2 SPEED
 It seems that JSON::XS is surprisingly fast, as shown in the following
 tables. They have been generated with the help of the C<eg/bench> program
 in the JSON::XS distribution, to make it easy to compare on your own
 single-line JSON string:
    {"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
+It shows the number of encodes/decodes per second (JSON::XS uses
-functional interface, while JSON::XS/2 uses the OO interface with
+the functional interface, while JSON::XS/2 uses the OO interface
-pretty-printing and hashkey sorting enabled). Higher is better:
+with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
+shrink). Higher is better:
    module     |     encode |     decode |
    -----------|------------|------------|
    JSON       |   7645.468 |   4208.613 |
-   JSON::DWIW |  68534.379 |  79437.576 |
+   JSON::DWIW |  40721.398 |  77101.176 |
    JSON::PC   |  65948.176 |  78251.940 |
-   JSON::Syck |  23379.621 |  28416.694 |
+   JSON::Syck |  22844.793 |  26479.192 |
    JSON::XS   | 388361.481 | 199728.762 |
    JSON::XS/2 | 218453.333 | 192399.266 |
    JSON::XS/3 | 338250.323 | 192399.266 |
-   Storable   |  15732.573 |  28571.553 |
+   Storable   |  15779.925 |  14169.946 |
    -----------+------------+------------+
 That is, JSON::XS is about five times faster than JSON::DWIW on encoding,
 about three times faster on decoding, and over fourty times faster
 than JSON, even with pretty-printing and key sorting. It also compares
 search API (http://nanoref.com/yahooapis/mgPdGg):
    module     |     encode |     decode |
    -----------|------------|------------|
    JSON       |    254.685 |     37.665 |
-   JSON::DWIW |   1014.244 |   1087.678 |
+   JSON::DWIW |    843.343 |   1049.731 |
    JSON::PC   |   3602.116 |   2307.352 |
-   JSON::Syck |    558.035 |    776.263 |
+   JSON::Syck |    505.107 |    787.899 |
-   JSON::XS   |   5747.196 |   3543.684 |
+   JSON::XS   |   5747.196 |   3690.220 |
-   JSON::XS/2 |   3968.121 |   3589.170 |
+   JSON::XS/2 |   3968.121 |   3676.634 |
-   JSON::XS/3 |   6105.246 |   3561.134 |
+   JSON::XS/3 |   6105.246 |   3662.508 |
-   Storable   |   4456.337 |   5320.020 |
+   Storable   |   4417.337 |   5285.161 |
    -----------+------------+------------+
-Again, JSON::XS leads by far.
+Again, JSON::XS leads by far (except for Storable which non-surprisingly
+decodes faster).
 On large strings containing lots of high unicode characters, some modules
 (such as JSON::PC) seem to decode faster than JSON::XS, but the result
 will be broken due to missing (or wrong) unicode handling. Others refuse
 to decode or encode properly, so it was impossible to prepare a fair
 And last but least, something else could bomb you that I forgot to think
 of. In that case, you get to keep the pieces. I am always open for hints,
 though...
+If you are using JSON::XS to return packets to consumption
+by javascript scripts in a browser you should have a look at
+L<http://jpsykes.com/47/practical-csrf-and-json-security> to see wether
+you are vulnerable to some common attack vectors (which really are browser
+design bugs, but it is still you who will have to deal with it, as major
+browser developers care only for features, not about doing security
+right).
 =head1 BUGS
 While the goal of this module is to be correct, that unfortunately does
 not mean its bug-free, only that I think its design is bug-free. It is
 still relatively early in its development. If you keep reporting bugs they
 will be fixed swiftly, though.
 =cut
+our $true  = do { bless \(my $dummy = 1), "JSON::XS::Boolean" };
+our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" };
-sub true()  { \1 }
+sub true()  { $true  }
-sub false() { \0 }
+sub false() { $false }
+sub is_bool($) {
+   UNIVERSAL::isa $_[0], "JSON::XS::Boolean"
+      or UNIVERSAL::isa $_[0], "JSON::Literal"
+}
+XSLoader::load "JSON::XS", $VERSION;
+package JSON::XS::Boolean;
+use overload
+   "0+"     => sub { ${$_[0]} },
+   "++"     => sub { $_[0] = ${$_[0]} + 1 },
+   "--"     => sub { $_[0] = ${$_[0]} - 1 },
+   fallback => 1;
 1;
 =head1 AUTHOR

Diff Legend

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

Comparing JSON-XS/XS.pm (file contents): Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs. Revision 1.43 by root, Sat Jun 23 23:49:29 2007 UTC

Diff Legend

Comparing JSON-XS/XS.pm (file contents):
Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs.
Revision 1.43 by root, Sat Jun 23 23:49:29 2007 UTC