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.143 by root, Fri Oct 25 20:02:54 2013 UTC vs.
Revision 1.144 by root, Mon Oct 28 23:19:54 2013 UTC

… …
109our @EXPORT = qw(encode_json decode_json); 109our @EXPORT = qw(encode_json decode_json);
110 110
111use Exporter; 111use Exporter;
112use XSLoader; 112use XSLoader;
113 113
114use Types::Serialiser ();
115
114=head1 FUNCTIONAL INTERFACE 116=head1 FUNCTIONAL INTERFACE
115 117
116The following convenience methods are provided by this module. They are 118The following convenience methods are provided by this module. They are
117exported by default: 119exported by default:
118 120
… …
138This function call is functionally identical to: 140This function call is functionally identical to:
139 141
140 $perl_scalar = JSON::XS->new->utf8->decode ($json_text) 142 $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
141 143
142Except being faster. 144Except being faster.
143
144=item $is_boolean = JSON::XS::is_bool $scalar
145
146Returns true if the passed scalar represents either JSON::XS::true or
147JSON::XS::false, two constants that act like C<1> and C<0>, respectively
148and are used to represent JSON C<true> and C<false> values in Perl.
149
150See MAPPING, below, for more information on how JSON values are mapped to
151Perl.
152 145
153=back 146=back
154 147
155 148
156=head1 A FEW NOTES ON UNICODE AND PERL 149=head1 A FEW NOTES ON UNICODE AND PERL
… …
983floating point, JSON::XS only guarantees precision up to but not including 976floating point, JSON::XS only guarantees precision up to but not including
984the least significant bit. 977the least significant bit.
985 978
986=item true, false 979=item true, false
987 980
988These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, 981These JSON atoms become C<Types::Serialiser::true> and
989respectively. They are overloaded to act almost exactly like the numbers 982C<Types::Serialiser::false>, respectively. They are overloaded to act
990C<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
991the 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).
992 986
993=item null 987=item null
994 988
995A JSON null atom becomes C<undef> in Perl. 989A JSON null atom becomes C<undef> in Perl.
996 990
… …
1021 1015
1022=item other references 1016=item other references
1023 1017
1024Other unblessed references are generally not allowed and will cause an 1018Other unblessed references are generally not allowed and will cause an
1025exception 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
1026C<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.
1027also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability.
1028 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;
1029 encode_json [\0, JSON::XS::true] # yields [false,true] 1027 encode_json [\0, Types::Serialiser::true] # yields [false,true]
1030 1028
1031=item JSON::XS::true, JSON::XS::false 1029=item Types::Serialiser::true, Types::Serialiser::false
1032 1030
1033These special values become JSON true and JSON false values, 1031These special values from the L<Types::Serialiser> module become JSON true
1034respectively. 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.
1035 1034
1036=item blessed objects 1035=item blessed objects
1037 1036
1038Blessed objects are not directly representable in JSON. See the 1037Blessed objects are not directly representable in JSON. See the
1039C<allow_blessed> and C<convert_blessed> methods on various options on 1038C<allow_blessed> and C<convert_blessed> methods on various options on
… …
1415are browser design bugs, but it is still you who will have to deal with 1414are browser design bugs, but it is still you who will have to deal with
1416it, as major browser developers care only for features, not about getting 1415it, as major browser developers care only for features, not about getting
1417security right). 1416security right).
1418 1417
1419 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>.
1425
1426
1420=head1 THREADS 1427=head1 THREADS
1421 1428
1422This 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
1423plans to change this until Perl gets thread support (as opposed to the 1430plans to change this until Perl gets thread support (as opposed to the
1424horribly slow so-called "threads" which are simply slow and bloated 1431horribly slow so-called "threads" which are simply slow and bloated
… …
1454Please refrain from using rt.cpan.org or any other bug reporting 1461Please refrain from using rt.cpan.org or any other bug reporting
1455service. I put the contact address into my modules for a reason. 1462service. I put the contact address into my modules for a reason.
1456 1463
1457=cut 1464=cut
1458 1465
1459our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; 1466BEGIN {
1460our $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;
1461 1472
1462sub true() { $true } 1473 *JSON::XS::Boolean:: = *Types::Serialiser::Boolean::;
1463sub false() { $false }
1464
1465sub is_bool($) {
1466 UNIVERSAL::isa $_[0], "JSON::XS::Boolean"
1467# or UNIVERSAL::isa $_[0], "JSON::Literal"
1468} 1474}
1469 1475
1470XSLoader::load "JSON::XS", $VERSION; 1476XSLoader::load "JSON::XS", $VERSION;
1471
1472package JSON::XS::Boolean;
1473
1474use overload
1475 "0+" => sub { ${$_[0]} },
1476 "++" => sub { $_[0] = ${$_[0]} + 1 },
1477 "--" => sub { $_[0] = ${$_[0]} - 1 },
1478 fallback => 1;
1479
14801;
1481 1477
1482=head1 SEE ALSO 1478=head1 SEE ALSO
1483 1479
1484The F<json_xs> command line utility for quick experiments. 1480The F<json_xs> command line utility for quick experiments.
1485 1481
… …
1488 Marc Lehmann <schmorp@schmorp.de> 1484 Marc Lehmann <schmorp@schmorp.de>
1489 http://home.schmorp.de/ 1485 http://home.schmorp.de/
1490 1486
1491=cut 1487=cut
1492 1488
14891
1490

Diff Legend

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