ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Types-Serialiser/Serialiser.pm
(Generate patch)

Comparing Types-Serialiser/Serialiser.pm (file contents):
Revision 1.3 by root, Sun Oct 27 22:46:21 2013 UTC vs.
Revision 1.9 by root, Sat Nov 30 18:33:51 2013 UTC

… …
15 15
16=cut 16=cut
17 17
18package Types::Serialiser; 18package Types::Serialiser;
19 19
20use common::sense; # required to suppress annoying warnings
21
20our $VERSION = 0.01; 22our $VERSION = '1.0';
21 23
22=head1 SIMPLE SCALAR CONSTANTS 24=head1 SIMPLE SCALAR CONSTANTS
23 25
24Simple scalar constants are values that are overloaded to act like simple 26Simple scalar constants are values that are overloaded to act like simple
25Perl values, but have (class) type to differentiate them from normal Perl 27Perl values, but have (class) type to differentiate them from normal Perl
… …
95 97
96=back 98=back
97 99
98=cut 100=cut
99 101
102BEGIN {
103 # for historical reasons, and to avoid extra dependencies in JSON::PP,
104 # we alias *Types::Serialiser::Boolean with JSON::PP::Boolean.
105 package JSON::PP::Boolean;
106
107 *Types::Serialiser::Boolean:: = *JSON::PP::Boolean::;
108}
109
110{
111 # this must done before blessing to work around bugs
112 # in perl < 5.18 (it seems to be fixed in 5.18).
113 package Types::Serialiser::BooleanBase;
114
115 use overload
116 "0+" => sub { ${$_[0]} },
117 "++" => sub { $_[0] = ${$_[0]} + 1 },
118 "--" => sub { $_[0] = ${$_[0]} - 1 },
119 fallback => 1;
120
121 @Types::Serialiser::Boolean::ISA = Types::Serialiser::BooleanBase::;
122}
123
100our $true = do { bless \(my $dummy = 1), Types::Serialiser::Boolean:: }; 124our $true = do { bless \(my $dummy = 1), Types::Serialiser::Boolean:: };
101our $false = do { bless \(my $dummy = 0), Types::Serialiser::Boolean:: }; 125our $false = do { bless \(my $dummy = 0), Types::Serialiser::Boolean:: };
102our $error = do { bless \(my $dummy ), Types::Serialiser::Error:: }; 126our $error = do { bless \(my $dummy ), Types::Serialiser::Error:: };
103 127
104sub true () { $true } 128sub true () { $true }
… …
107 131
108sub is_bool ($) { UNIVERSAL::isa $_[0], Types::Serialiser::Boolean:: } 132sub is_bool ($) { UNIVERSAL::isa $_[0], Types::Serialiser::Boolean:: }
109sub is_true ($) { $_[0] && UNIVERSAL::isa $_[0], Types::Serialiser::Boolean:: } 133sub is_true ($) { $_[0] && UNIVERSAL::isa $_[0], Types::Serialiser::Boolean:: }
110sub is_false ($) { !$_[0] && UNIVERSAL::isa $_[0], Types::Serialiser::Boolean:: } 134sub is_false ($) { !$_[0] && UNIVERSAL::isa $_[0], Types::Serialiser::Boolean:: }
111sub is_error ($) { UNIVERSAL::isa $_[0], Types::Serialiser::Error:: } 135sub is_error ($) { UNIVERSAL::isa $_[0], Types::Serialiser::Error:: }
112
113package Types::Serialiser::Boolean;
114
115use overload
116 "0+" => sub { ${$_[0]} },
117 "++" => sub { $_[0] = ${$_[0]} + 1 },
118 "--" => sub { $_[0] = ${$_[0]} - 1 },
119 fallback => 1;
120 136
121package Types::Serialiser::Error; 137package Types::Serialiser::Error;
122 138
123sub error { 139sub error {
124 require Carp; 140 require Carp;
… …
139see if it's C<1> (true), C<0> (false) or C<undef> (error). 155see if it's C<1> (true), C<0> (false) or C<undef> (error).
140 156
141While it is possible to use an isa test, directly comparing stash pointers 157While it is possible to use an isa test, directly comparing stash pointers
142is faster and guaranteed to work. 158is faster and guaranteed to work.
143 159
160For historical reasons, the C<Types::Serialiser::Boolean> stash is
161just an alias for C<JSON::PP::Boolean>. When printed, the classname
162with usually be C<JSON::PP::Boolean>, but isa tests and stash pointer
163comparison will normally work correctly (i.e. Types::Serialiser::true ISA
164JSON::PP::Boolean, but also ISA Types::Serialiser::Boolean).
165
144=head1 A GENERIC OBJECT SERIALIATION PROTOCOL 166=head1 A GENERIC OBJECT SERIALIATION PROTOCOL
145 167
146This section explains the object serialisation protocol used by 168This section explains the object serialisation protocol used by
147L<CBOR::XS>. It is meant to be generic enough to support any kind of 169L<CBOR::XS>. It is meant to be generic enough to support any kind of
148generic object serialiser. 170generic object serialiser.
… …
155When the encoder encounters an object that it cannot otherwise encode (for 177When the encoder encounters an object that it cannot otherwise encode (for
156example, L<CBOR::XS> can encode a few special types itself, and will first 178example, L<CBOR::XS> can encode a few special types itself, and will first
157attempt to use the special C<TO_CBOR> serialisation protocol), it will 179attempt to use the special C<TO_CBOR> serialisation protocol), it will
158look up the C<FREEZE> method on the object. 180look up the C<FREEZE> method on the object.
159 181
182Note that the C<FREEZE> method will normally be called I<during> encoding,
183and I<MUST NOT> change the data structure that is being encoded in any
184way, or it might cause memory corruption or worse.
185
160If it exists, it will call it with two arguments: the object to 186If it exists, it will call it with two arguments: the object to serialise,
161serialise, and a constant string that indicates the name of the 187and a constant string that indicates the name of the data model. For
162serialisationformat. For example L<CBOR::XS> uses C<CBOR>, and L<JSON> and 188example L<CBOR::XS> uses C<CBOR>, and the L<JSON> and L<JSON::XS> modules
163L<JSON::XS> (or any other JSON serialiser), would use C<JSON> as second 189(or any other JSON serialiser), would use C<JSON> as second argument.
164argument.
165 190
166The C<FREEZE> method can then return zero or more values to identify the 191The C<FREEZE> method can then return zero or more values to identify the
167object instance. The serialiser is then supposed to encode the class name 192object instance. The serialiser is then supposed to encode the class name
168and all of these return values (which must be encodable in the format) 193and all of these return values (which must be encodable in the format)
169using the relevant form for perl objects. In CBOR for example, there is a 194using the relevant form for Perl objects. In CBOR for example, there is a
170registered tag number for encoded perl objects. 195registered tag number for encoded perl objects.
196
197The values that C<FREEZE> returns must be serialisable with the serialiser
198that calls it. Therefore, it is recommended to use simple types such as
199strings and numbers, and maybe array references and hashes (basically, the
200JSON data model). You can always use a more complex format for a specific
201data model by checking the second argument, the data model.
202
203The "data model" is not the same as the "data format" - the data model
204indicates what types and kinds of return values can be returned from
205C<FREEZE>. For example, in C<CBOR> it is permissible to return tagged CBOR
206values, while JSON does not support these at all, so C<JSON> would be a
207valid (but too limited) data model name for C<CBOR::XS>. similarly, a
208serialising format that supports more or less the same data model as JSON
209could use C<JSON> as data model without losing anything.
171 210
172=head2 DECODING 211=head2 DECODING
173 212
174When the decoder then encounters such an encoded perl object, it should 213When the decoder then encounters such an encoded perl object, it should
175look up the C<THAW> method on the stored classname, and invoke it with the 214look up the C<THAW> method on the stored classname, and invoke it with the
176classname, the constant string to identify the format, and all the return 215classname, the constant string to identify the data model/data format, and
177values returned by C<FREEZE>. 216all the return values returned by C<FREEZE>.
178 217
179=head2 EXAMPLES 218=head2 EXAMPLES
180 219
181See the C<OBJECT SERIALISATION> section in the L<CBOR::XS> manpage for 220See the C<OBJECT SERIALISATION> section in the L<CBOR::XS> manpage for
182more details, an example implementation, and code examples. 221more details, an example implementation, and code examples.
183 222
184Here is an example C<FREEZE>/C<THAW> method pair: 223Here is an example C<FREEZE>/C<THAW> method pair:
185 224
186 sub My::Object::FREEZE { 225 sub My::Object::FREEZE {
187 my ($self, $serialiser) = @_; 226 my ($self, $model) = @_;
188 227
189 ($self->{type}, $self->{id}, $self->{variant}) 228 ($self->{type}, $self->{id}, $self->{variant})
190 } 229 }
191 230
192 sub My::Object::THAW { 231 sub My::Object::THAW {
193 my ($class, $serialiser, $type, $id, $variant) = @_; 232 my ($class, $model, $type, $id, $variant) = @_;
194 233
195 $class-<new (type => $type, id => $id, variant => $variant) 234 $class->new (type => $type, id => $id, variant => $variant)
196 } 235 }
197 236
198=head1 BUGS 237=head1 BUGS
199 238
200The use of L<overload> makes this module much heavier than it should be 239The use of L<overload> makes this module much heavier than it should be

Diff Legend

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