… | |
… | |
64 | |
64 | |
65 | package CBOR::XS; |
65 | package CBOR::XS; |
66 | |
66 | |
67 | use common::sense; |
67 | use common::sense; |
68 | |
68 | |
69 | our $VERSION = 1.11; |
69 | our $VERSION = 1.41; |
70 | our @ISA = qw(Exporter); |
70 | our @ISA = qw(Exporter); |
71 | |
71 | |
72 | our @EXPORT = qw(encode_cbor decode_cbor); |
72 | our @EXPORT = qw(encode_cbor decode_cbor); |
73 | |
73 | |
74 | use Exporter; |
74 | use Exporter; |
… | |
… | |
218 | isn't prepared for this will not leak memory. |
218 | isn't prepared for this will not leak memory. |
219 | |
219 | |
220 | If C<$enable> is false (the default), then C<decode> will throw an error |
220 | If C<$enable> is false (the default), then C<decode> will throw an error |
221 | when it encounters a self-referential/cyclic data structure. |
221 | when it encounters a self-referential/cyclic data structure. |
222 | |
222 | |
|
|
223 | FUTURE DIRECTION: the motivation behind this option is to avoid I<real> |
|
|
224 | cycles - future versions of this module might chose to decode cyclic data |
|
|
225 | structures using weak references when this option is off, instead of |
|
|
226 | throwing an error. |
|
|
227 | |
223 | This option does not affect C<encode> in any way - shared values and |
228 | This option does not affect C<encode> in any way - shared values and |
224 | references will always be decoded properly if present. |
229 | references will always be encoded properly if present. |
225 | |
230 | |
226 | =item $cbor = $cbor->pack_strings ([$enable]) |
231 | =item $cbor = $cbor->pack_strings ([$enable]) |
227 | |
232 | |
228 | =item $enabled = $cbor->get_pack_strings |
233 | =item $enabled = $cbor->get_pack_strings |
229 | |
234 | |
… | |
… | |
333 | CBOR::XS->new->decode_prefix ("......") |
338 | CBOR::XS->new->decode_prefix ("......") |
334 | => ("...", 3) |
339 | => ("...", 3) |
335 | |
340 | |
336 | =back |
341 | =back |
337 | |
342 | |
|
|
343 | =head2 INCREMENTAL PARSING |
|
|
344 | |
|
|
345 | In some cases, there is the need for incremental parsing of JSON |
|
|
346 | texts. While this module always has to keep both CBOR text and resulting |
|
|
347 | Perl data structure in memory at one time, it does allow you to parse a |
|
|
348 | CBOR stream incrementally, using a similar to using "decode_prefix" to see |
|
|
349 | if a full CBOR object is available, but is much more efficient. |
|
|
350 | |
|
|
351 | It basically works by parsing as much of a CBOR string as possible - if |
|
|
352 | the CBOR data is not complete yet, the pasrer will remember where it was, |
|
|
353 | to be able to restart when more data has been accumulated. Once enough |
|
|
354 | data is available to either decode a complete CBOR value or raise an |
|
|
355 | error, a real decode will be attempted. |
|
|
356 | |
|
|
357 | A typical use case would be a network protocol that consists of sending |
|
|
358 | and receiving CBOR-encoded messages. The solution that works with CBOR and |
|
|
359 | about anything else is by prepending a length to every CBOR value, so the |
|
|
360 | receiver knows how many octets to read. More compact (and slightly slower) |
|
|
361 | would be to just send CBOR values back-to-back, as C<CBOR::XS> knows where |
|
|
362 | a CBOR value ends, and doesn't need an explicit length. |
|
|
363 | |
|
|
364 | The following methods help with this: |
|
|
365 | |
|
|
366 | =over 4 |
|
|
367 | |
|
|
368 | =item @decoded = $cbor->incr_parse ($buffer) |
|
|
369 | |
|
|
370 | This method attempts to decode exactly one CBOR value from the beginning |
|
|
371 | of the given C<$buffer>. The value is removed from the C<$buffer> on |
|
|
372 | success. When C<$buffer> doesn't contain a complete value yet, it returns |
|
|
373 | nothing. Finally, when the C<$buffer> doesn't start with something |
|
|
374 | that could ever be a valid CBOR value, it raises an exception, just as |
|
|
375 | C<decode> would. In the latter case the decoder state is undefined and |
|
|
376 | must be reset before being able to parse further. |
|
|
377 | |
|
|
378 | This method modifies the C<$buffer> in place. When no CBOR value can be |
|
|
379 | decoded, the decoder stores the current string offset. On the next call, |
|
|
380 | continues decoding at the place where it stopped before. For this to make |
|
|
381 | sense, the C<$buffer> must begin with the same octets as on previous |
|
|
382 | unsuccessful calls. |
|
|
383 | |
|
|
384 | You can call this method in scalar context, in which case it either |
|
|
385 | returns a decoded value or C<undef>. This makes it impossible to |
|
|
386 | distinguish between CBOR null values (which decode to C<undef>) and an |
|
|
387 | unsuccessful decode, which is often acceptable. |
|
|
388 | |
|
|
389 | =item @decoded = $cbor->incr_parse_multiple ($buffer) |
|
|
390 | |
|
|
391 | Same as C<incr_parse>, but attempts to decode as many CBOR values as |
|
|
392 | possible in one go, instead of at most one. Calls to C<incr_parse> and |
|
|
393 | C<incr_parse_multiple> can be interleaved. |
|
|
394 | |
|
|
395 | =item $cbor->incr_reset |
|
|
396 | |
|
|
397 | Resets the incremental decoder. This throws away any saved state, so that |
|
|
398 | subsequent calls to C<incr_parse> or C<incr_parse_multiple> start to parse |
|
|
399 | a new CBOR value from the beginning of the C<$buffer> again. |
|
|
400 | |
|
|
401 | This method can be caled at any time, but it I<must> be called if you want |
|
|
402 | to change your C<$buffer> or there was a decoding error and you want to |
|
|
403 | reuse the C<$cbor> object for future incremental parsings. |
|
|
404 | |
|
|
405 | =back |
|
|
406 | |
338 | |
407 | |
339 | =head1 MAPPING |
408 | =head1 MAPPING |
340 | |
409 | |
341 | This section describes how CBOR::XS maps Perl values to CBOR values and |
410 | This section describes how CBOR::XS maps Perl values to CBOR values and |
342 | vice versa. These mappings are designed to "do the right thing" in most |
411 | vice versa. These mappings are designed to "do the right thing" in most |
… | |
… | |
412 | |
481 | |
413 | =item hash references |
482 | =item hash references |
414 | |
483 | |
415 | Perl hash references become CBOR maps. As there is no inherent ordering in |
484 | Perl hash references become CBOR maps. As there is no inherent ordering in |
416 | hash keys (or CBOR maps), they will usually be encoded in a pseudo-random |
485 | hash keys (or CBOR maps), they will usually be encoded in a pseudo-random |
417 | order. This order can be different each time a hahs is encoded. |
486 | order. This order can be different each time a hash is encoded. |
418 | |
487 | |
419 | Currently, tied hashes will use the indefinite-length format, while normal |
488 | Currently, tied hashes will use the indefinite-length format, while normal |
420 | hashes will use the fixed-length format. |
489 | hashes will use the fixed-length format. |
421 | |
490 | |
422 | =item array references |
491 | =item array references |
… | |
… | |
745 | |
814 | |
746 | These tags are automatically created (and decoded) for serialisable |
815 | These tags are automatically created (and decoded) for serialisable |
747 | objects using the C<FREEZE/THAW> methods (the L<Types::Serialier> object |
816 | objects using the C<FREEZE/THAW> methods (the L<Types::Serialier> object |
748 | serialisation protocol). See L<OBJECT SERIALISATION> for details. |
817 | serialisation protocol). See L<OBJECT SERIALISATION> for details. |
749 | |
818 | |
750 | =item 28, 29 (shareable, sharedref, L <http://cbor.schmorp.de/value-sharing>) |
819 | =item 28, 29 (shareable, sharedref, L<http://cbor.schmorp.de/value-sharing>) |
751 | |
820 | |
752 | These tags are automatically decoded when encountered (and they do not |
821 | These tags are automatically decoded when encountered (and they do not |
753 | result in a cyclic data structure, see C<allow_cycles>), resulting in |
822 | result in a cyclic data structure, see C<allow_cycles>), resulting in |
754 | shared values in the decoded object. They are only encoded, however, when |
823 | shared values in the decoded object. They are only encoded, however, when |
755 | C<allow_sharing> is enabled. |
824 | C<allow_sharing> is enabled. |
… | |
… | |
765 | will be shared, others will not. While non-reference shared values can be |
834 | will be shared, others will not. While non-reference shared values can be |
766 | generated in Perl with some effort, they were considered too unimportant |
835 | generated in Perl with some effort, they were considered too unimportant |
767 | to be supported in the encoder. The decoder, however, will decode these |
836 | to be supported in the encoder. The decoder, however, will decode these |
768 | values as shared values. |
837 | values as shared values. |
769 | |
838 | |
770 | =item 256, 25 (stringref-namespace, stringref, L <http://cbor.schmorp.de/stringref>) |
839 | =item 256, 25 (stringref-namespace, stringref, L<http://cbor.schmorp.de/stringref>) |
771 | |
840 | |
772 | These tags are automatically decoded when encountered. They are only |
841 | These tags are automatically decoded when encountered. They are only |
773 | encoded, however, when C<pack_strings> is enabled. |
842 | encoded, however, when C<pack_strings> is enabled. |
774 | |
843 | |
775 | =item 22098 (indirection, L<http://cbor.schmorp.de/indirection>) |
844 | =item 22098 (indirection, L<http://cbor.schmorp.de/indirection>) |
… | |
… | |
953 | |
1022 | |
954 | |
1023 | |
955 | =head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT |
1024 | =head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT |
956 | |
1025 | |
957 | On perls that were built without 64 bit integer support (these are rare |
1026 | On perls that were built without 64 bit integer support (these are rare |
958 | nowadays, even on 32 bit architectures), support for any kind of 64 bit |
1027 | nowadays, even on 32 bit architectures, as all major Perl distributions |
|
|
1028 | are built with 64 bit integer support), support for any kind of 64 bit |
959 | integer in CBOR is very limited - most likely, these 64 bit values will |
1029 | integer in CBOR is very limited - most likely, these 64 bit values will |
960 | be truncated, corrupted, or otherwise not decoded correctly. This also |
1030 | be truncated, corrupted, or otherwise not decoded correctly. This also |
961 | includes string, array and map sizes that are stored as 64 bit integers. |
1031 | includes string, array and map sizes that are stored as 64 bit integers. |
962 | |
1032 | |
963 | |
1033 | |
… | |
… | |
988 | # Time::Piece::Strptime uses the "incredibly flexible date parsing routine" |
1058 | # Time::Piece::Strptime uses the "incredibly flexible date parsing routine" |
989 | # from FreeBSD, which can't parse ISO 8601, RFC3339, RFC4287 or much of anything |
1059 | # from FreeBSD, which can't parse ISO 8601, RFC3339, RFC4287 or much of anything |
990 | # else either. Whats incredibe over standard strptime totally escapes me. |
1060 | # else either. Whats incredibe over standard strptime totally escapes me. |
991 | # doesn't do fractional times, either. sigh. |
1061 | # doesn't do fractional times, either. sigh. |
992 | # In fact, it's all a lie, it uses whatever strptime it wants, and of course, |
1062 | # In fact, it's all a lie, it uses whatever strptime it wants, and of course, |
993 | # they are all incomptible. The openbsd one simply ignores %z (but according to the |
1063 | # they are all incompatible. The openbsd one simply ignores %z (but according to the |
994 | # docs, it would be much more incredibly flexible indeed. If it worked, that is.). |
1064 | # docs, it would be much more incredibly flexible indeed. If it worked, that is.). |
995 | scalar eval { |
1065 | scalar eval { |
996 | my $s = $_[1]; |
1066 | my $s = $_[1]; |
997 | |
1067 | |
998 | $s =~ s/Z$/+00:00/; |
1068 | $s =~ s/Z$/+00:00/; |
… | |
… | |
1072 | my ($m, $e) = $_[0]->parts; |
1142 | my ($m, $e) = $_[0]->parts; |
1073 | tag 4, [$e->numify, $m] |
1143 | tag 4, [$e->numify, $m] |
1074 | } |
1144 | } |
1075 | |
1145 | |
1076 | sub Time::Piece::TO_CBOR { |
1146 | sub Time::Piece::TO_CBOR { |
1077 | tag 1, $_[0]->epoch |
1147 | tag 1, 0 + $_[0]->epoch |
1078 | } |
1148 | } |
1079 | |
1149 | |
1080 | XSLoader::load "CBOR::XS", $VERSION; |
1150 | XSLoader::load "CBOR::XS", $VERSION; |
1081 | |
1151 | |
1082 | =head1 SEE ALSO |
1152 | =head1 SEE ALSO |