… | |
… | |
85 | |
85 | |
86 | package JSON::XS; |
86 | package JSON::XS; |
87 | |
87 | |
88 | use strict; |
88 | use strict; |
89 | |
89 | |
90 | BEGIN { |
|
|
91 | our $VERSION = '1.24'; |
90 | our $VERSION = '1.3'; |
92 | our @ISA = qw(Exporter); |
91 | our @ISA = qw(Exporter); |
93 | |
92 | |
94 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
93 | our @EXPORT = qw(to_json from_json objToJson jsonToObj); |
95 | require Exporter; |
|
|
96 | |
94 | |
97 | require XSLoader; |
95 | use Exporter; |
98 | XSLoader::load JSON::XS::, $VERSION; |
96 | use XSLoader; |
99 | } |
|
|
100 | |
97 | |
101 | =head1 FUNCTIONAL INTERFACE |
98 | =head1 FUNCTIONAL INTERFACE |
102 | |
99 | |
103 | The following convinience methods are provided by this module. They are |
100 | The following convinience methods are provided by this module. They are |
104 | exported by default: |
101 | exported by default: |
… | |
… | |
126 | This function call is functionally identical to: |
123 | This function call is functionally identical to: |
127 | |
124 | |
128 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
125 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
129 | |
126 | |
130 | except being faster. |
127 | except being faster. |
|
|
128 | |
|
|
129 | =item $is_boolean = JSON::XS::is_bool $scalar |
|
|
130 | |
|
|
131 | Returns true if the passed scalar represents either JSON::XS::true or |
|
|
132 | JSON::XS::false, two constants that act like C<1> and C<0>, respectively |
|
|
133 | and are used to represent JSON C<true> and C<false> values in Perl. |
|
|
134 | |
|
|
135 | See MAPPING, below, for more information on how JSON values are mapped to |
|
|
136 | Perl. |
131 | |
137 | |
132 | =back |
138 | =back |
133 | |
139 | |
134 | |
140 | |
135 | =head1 OBJECT-ORIENTED INTERFACE |
141 | =head1 OBJECT-ORIENTED INTERFACE |
… | |
… | |
432 | conversion details, but an integer may take slightly less memory and might |
438 | conversion details, but an integer may take slightly less memory and might |
433 | represent more values exactly than (floating point) numbers. |
439 | represent more values exactly than (floating point) numbers. |
434 | |
440 | |
435 | =item true, false |
441 | =item true, false |
436 | |
442 | |
437 | These JSON atoms become C<0>, C<1>, respectively. Information is lost in |
443 | These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, |
438 | this process. Future versions might represent those values differently, |
444 | respectively. They are overloaded to act almost exactly like the numbers |
439 | but they will be guarenteed to act like these integers would normally in |
445 | C<1> and C<0>. You can check wether a scalar is a JSON boolean by using |
440 | Perl. |
446 | the C<JSON::XS::is_bool> function. |
441 | |
447 | |
442 | =item null |
448 | =item null |
443 | |
449 | |
444 | A JSON null atom becomes C<undef> in Perl. |
450 | A JSON null atom becomes C<undef> in Perl. |
445 | |
451 | |
… | |
… | |
477 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
483 | C<1>, which get turned into C<false> and C<true> atoms in JSON. You can |
478 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
484 | also use C<JSON::XS::false> and C<JSON::XS::true> to improve readability. |
479 | |
485 | |
480 | to_json [\0,JSON::XS::true] # yields [false,true] |
486 | to_json [\0,JSON::XS::true] # yields [false,true] |
481 | |
487 | |
|
|
488 | =item JSON::XS::true, JSON::XS::false |
|
|
489 | |
|
|
490 | These special values become JSON true and JSON false values, |
|
|
491 | respectively. You cna alos use C<\1> and C<\0> directly if you want. |
|
|
492 | |
482 | =item blessed objects |
493 | =item blessed objects |
483 | |
494 | |
484 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
495 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
485 | underlying representation (hash- or arrayref), but this behaviour might |
496 | underlying representation (hash- or arrayref), but this behaviour might |
486 | change in future versions. |
497 | change in future versions. |
… | |
… | |
614 | |
625 | |
615 | You often hear that JSON is a subset (or a close subset) of YAML. This is, |
626 | You often hear that JSON is a subset (or a close subset) of YAML. This is, |
616 | however, a mass hysteria and very far from the truth. In general, there is |
627 | however, a mass hysteria and very far from the truth. In general, there is |
617 | no way to configure JSON::XS to output a data structure as valid YAML. |
628 | no way to configure JSON::XS to output a data structure as valid YAML. |
618 | |
629 | |
619 | If you really must use JSON::XS to generate YAML, you should this |
630 | If you really must use JSON::XS to generate YAML, you should use this |
620 | algorithm (subject to change in future versions): |
631 | algorithm (subject to change in future versions): |
621 | |
632 | |
622 | my $to_yaml = JSON::XS->new->utf8->space_after (1); |
633 | my $to_yaml = JSON::XS->new->utf8->space_after (1); |
623 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
634 | my $yaml = $to_yaml->encode ($ref) . "\n"; |
624 | |
635 | |
625 | This will usually generate JSON texts that also parse as valid |
636 | This will usually generate JSON texts that also parse as valid |
626 | YAML. Please note that YAML has hardcoded limits on object key lengths |
637 | YAML. Please note that YAML has hardcoded limits on (simple) object key |
627 | that JSON doesn't have, so you should make sure that your hash keys are |
638 | lengths that JSON doesn't have, so you should make sure that your hash |
628 | noticably shorter than 1024 characters. |
639 | keys are noticably shorter than the 1024 characters YAML allows. |
629 | |
640 | |
630 | There might be other incompatibilities that I am not aware of. In general |
641 | There might be other incompatibilities that I am not aware of. In general |
631 | you should not try to generate YAML with a JSON generator or vice versa, |
642 | you should not try to generate YAML with a JSON generator or vice versa, |
632 | or try to parse JSON with a YAML parser or vice versa. |
643 | or try to parse JSON with a YAML parser or vice versa: chances are high |
|
|
644 | that you will run into severe interoperability problems. |
633 | |
645 | |
634 | |
646 | |
635 | =head2 SPEED |
647 | =head2 SPEED |
636 | |
648 | |
637 | It seems that JSON::XS is surprisingly fast, as shown in the following |
649 | It seems that JSON::XS is surprisingly fast, as shown in the following |
… | |
… | |
719 | |
731 | |
720 | And last but least, something else could bomb you that I forgot to think |
732 | And last but least, something else could bomb you that I forgot to think |
721 | of. In that case, you get to keep the pieces. I am always open for hints, |
733 | of. In that case, you get to keep the pieces. I am always open for hints, |
722 | though... |
734 | though... |
723 | |
735 | |
|
|
736 | If you are using JSON::XS to return packets to consumption |
|
|
737 | by javascript scripts in a browser you should have a look at |
|
|
738 | L<http://jpsykes.com/47/practical-csrf-and-json-security> to see wether |
|
|
739 | you are vulnerable to some common attack vectors (which really are browser |
|
|
740 | design bugs, but it is still you who will have to deal with it, as major |
|
|
741 | browser developers care only for features, not about doing security |
|
|
742 | right). |
|
|
743 | |
724 | |
744 | |
725 | =head1 BUGS |
745 | =head1 BUGS |
726 | |
746 | |
727 | While the goal of this module is to be correct, that unfortunately does |
747 | While the goal of this module is to be correct, that unfortunately does |
728 | not mean its bug-free, only that I think its design is bug-free. It is |
748 | not mean its bug-free, only that I think its design is bug-free. It is |
729 | still relatively early in its development. If you keep reporting bugs they |
749 | still relatively early in its development. If you keep reporting bugs they |
730 | will be fixed swiftly, though. |
750 | will be fixed swiftly, though. |
731 | |
751 | |
732 | =cut |
752 | =cut |
733 | |
753 | |
|
|
754 | our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
|
|
755 | our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |
|
|
756 | |
734 | sub true() { \1 } |
757 | sub true() { $true } |
735 | sub false() { \0 } |
758 | sub false() { $false } |
|
|
759 | |
|
|
760 | sub is_bool($) { |
|
|
761 | UNIVERSAL::isa $_[0], "JSON::XS::Boolean" |
|
|
762 | or UNIVERSAL::isa $_[0], "JSON::Literal" |
|
|
763 | } |
|
|
764 | |
|
|
765 | XSLoader::load "JSON::XS", $VERSION; |
|
|
766 | |
|
|
767 | package JSON::XS::Boolean; |
|
|
768 | |
|
|
769 | use overload |
|
|
770 | "0+" => sub { ${$_[0]} }, |
|
|
771 | "++" => sub { $_[0] = ${$_[0]} + 1 }, |
|
|
772 | "--" => sub { $_[0] = ${$_[0]} - 1 }, |
|
|
773 | fallback => 1; |
736 | |
774 | |
737 | 1; |
775 | 1; |
738 | |
776 | |
739 | =head1 AUTHOR |
777 | =head1 AUTHOR |
740 | |
778 | |