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

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.22 by root, Fri Nov 22 15:28:38 2013 UTC vs.
Revision 1.34 by root, Sun Dec 1 14:48:00 2013 UTC

     substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string
  }
 =head1 DESCRIPTION
-WARNING! This module is very new, and not very well tested (that's up
-to you to do). Furthermore, details of the implementation might change
-freely before version 1.0. And lastly, most extensions depend on an IANA
-assignment, and until that assignment is official, this implementation is
-not interoperable with other implementations (even future versions of this
-module) until the assignment is done.
-You are still invited to try out CBOR, and this module.
 This module converts Perl data structures to the Concise Binary Object
 Representation (CBOR) and vice versa. CBOR is a fast binary serialisation
-format that aims to use a superset of the JSON data model, i.e. when you
+format that aims to use an (almost) superset of the JSON data model, i.e.
-can represent something in JSON, you should be able to represent it in
+when you can represent something useful in JSON, you should be able to
-CBOR.
+represent it in CBOR.
-In short, CBOR is a faster and very compact binary alternative to JSON,
+In short, CBOR is a faster and quite compact binary alternative to JSON,
 with the added ability of supporting serialisation of Perl objects. (JSON
 often compresses better than CBOR though, so if you plan to compress the
-data later you might want to compare both formats first).
+data later and speed is less important you might want to compare both
+formats first).
 To give you a general idea about speed, with texts in the megabyte range,
 C<CBOR::XS> usually encodes roughly twice as fast as L<Storable> or
 L<JSON::XS> and decodes about 15%-30% faster than those. The shorter the
 data, the worse L<Storable> performs in comparison.
-As for compactness, C<CBOR::XS> encoded data structures are usually about
+Regarding compactness, C<CBOR::XS>-encoded data structures are usually
-20% smaller than the same data encoded as (compact) JSON or L<Storable>.
+about 20% smaller than the same data encoded as (compact) JSON or
+L<Storable>.
-In addition to the core CBOR data format, this module implements a number
+In addition to the core CBOR data format, this module implements a
-of extensions, to support cyclic and self-referencing data structures
+number of extensions, to support cyclic and shared data structures
-(see C<allow_sharing>), string deduplication (see C<allow_stringref>) and
+(see C<allow_sharing> and C<allow_cycles>), string deduplication (see
-scalar references (always enabled).
+C<pack_strings>) and scalar references (always enabled).
 The primary goal of this module is to be I<correct> and the secondary goal
 is to be I<fast>. To reach the latter goal it was written in C.
 See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and
 package CBOR::XS;
 use common::sense;
-our $VERSION = 0.08;
+our $VERSION = 1.11;
 our @ISA = qw(Exporter);
 our @EXPORT = qw(encode_cbor decode_cbor);
 use Exporter;
 strings. All boolean flags described below are by default I<disabled>.
 The mutators for flags all return the CBOR object again and thus calls can
 be chained:
-#TODO
    my $cbor = CBOR::XS->new->encode ({a => [1,2]});
 =item $cbor = $cbor->max_depth ([$maximum_nesting_depth])
 =item $max_depth = $cbor->get_max_depth
 as an array, is referenced multiple times), but instead will emit a
 reference to the earlier value.
 This means that such values will only be encoded once, and will not result
 in a deep cloning of the value on decode, in decoders supporting the value
-sharing extension.
+sharing extension. This also makes it possible to encode cyclic data
+structures (which need C<allow_cycles> to ne enabled to be decoded by this
+module).
 It is recommended to leave it off unless you know your
 communication partner supports the value sharing extensions to CBOR
-(http://cbor.schmorp.de/value-sharing).
+(L<http://cbor.schmorp.de/value-sharing>), as without decoder support, the
+resulting data structure might be unusable.
 Detecting shared values incurs a runtime overhead when values are encoded
 that have a reference counter large than one, and might unnecessarily
 increase the encoded size, as potentially shared values are encode as
-sharable whether or not they are actually shared.
+shareable whether or not they are actually shared.
 At the moment, only targets of references can be shared (e.g. scalars,
 arrays or hashes pointed to by a reference). Weirder constructs, such as
 an array with multiple "copies" of the I<same> string, which are hard but
 not impossible to create in Perl, are not supported (this is the same as
-for L<Storable>).
+with L<Storable>).
-If C<$enable> is false (the default), then C<encode> will encode
+If C<$enable> is false (the default), then C<encode> will encode shared
-exception when it encounters anything it cannot encode as CBOR.
+data structures repeatedly, unsharing them in the process. Cyclic data
+structures cannot be encoded in this mode.
 This option does not affect C<decode> in any way - shared values and
 references will always be decoded properly if present.
+=item $cbor = $cbor->allow_cycles ([$enable])
+=item $enabled = $cbor->get_allow_cycles
+If C<$enable> is true (or missing), then C<decode> will happily decode
+self-referential (cyclic) data structures. By default these will not be
+decoded, as they need manual cleanup to avoid memory leaks, so code that
+isn't prepared for this will not leak memory.
+If C<$enable> is false (the default), then C<decode> will throw an error
+when it encounters a self-referential/cyclic data structure.
+This option does not affect C<encode> in any way - shared values and
+references will always be decoded properly if present.
-=item $cbor = $cbor->allow_stringref ([$enable])
+=item $cbor = $cbor->pack_strings ([$enable])
-=item $enabled = $cbor->get_allow_stringref
+=item $enabled = $cbor->get_pack_strings
 If C<$enable> is true (or missing), then C<encode> will try not to encode
 the same string twice, but will instead encode a reference to the string
-instead. Depending on your data format. this can save a lot of space, but
+instead. Depending on your data format, this can save a lot of space, but
 also results in a very large runtime overhead (expect encoding times to be
 2-4 times as high as without).
 It is recommended to leave it off unless you know your
 communications partner supports the stringref extension to CBOR
-(http://cbor.schmorp.de/stringref).
+(L<http://cbor.schmorp.de/stringref>), as without decoder support, the
+resulting data structure might not be usable.
-If C<$enable> is false (the default), then C<encode> will encode
+If C<$enable> is false (the default), then C<encode> will encode strings
-exception when it encounters anything it cannot encode as CBOR.
+the standard CBOR way.
 This option does not affect C<decode> in any way - string references will
 always be decoded properly if present.
+=item $cbor = $cbor->validate_utf8 ([$enable])
+=item $enabled = $cbor->get_validate_utf8
+If C<$enable> is true (or missing), then C<decode> will validate that
+elements (text strings) containing UTF-8 data in fact contain valid UTF-8
+data (instead of blindly accepting it). This validation obviously takes
+extra time during decoding.
+The concept of "valid UTF-8" used is perl's concept, which is a superset
+of the official UTF-8.
+If C<$enable> is false (the default), then C<decode> will blindly accept
+UTF-8 data, marking them as valid UTF-8 in the resulting data structure
+regardless of whether thats true or not.
+Perl isn't too happy about corrupted UTF-8 in strings, but should
+generally not crash or do similarly evil things. Extensions might be not
+so forgiving, so it's recommended to turn on this setting if you receive
+untrusted CBOR.
+This option does not affect C<encode> in any way - strings that are
+supposedly valid UTF-8 will simply be dumped into the resulting CBOR
+string without checking whether that is, in fact, true or not.
+=item $cbor = $cbor->filter ([$cb->($tag, $value)])
+=item $cb_or_undef = $cbor->get_filter
+Sets or replaces the tagged value decoding filter (when C<$cb> is
+specified) or clears the filter (if no argument or C<undef> is provided).
+The filter callback is called only during decoding, when a non-enforced
+tagged value has been decoded (see L<TAG HANDLING AND EXTENSIONS> for a
+list of enforced tags). For specific tags, it's often better to provide a
+default converter using the C<%CBOR::XS::FILTER> hash (see below).
+The first argument is the numerical tag, the second is the (decoded) value
+that has been tagged.
+The filter function should return either exactly one value, which will
+replace the tagged value in the decoded data structure, or no values,
+which will result in default handling, which currently means the decoder
+creates a C<CBOR::XS::Tagged> object to hold the tag and the value.
+When the filter is cleared (the default state), the default filter
+function, C<CBOR::XS::default_filter>, is used. This function simply looks
+up the tag in the C<%CBOR::XS::FILTER> hash. If an entry exists it must be
+a code reference that is called with tag and value, and is responsible for
+decoding the value. If no entry exists, it returns no values.
+Example: decode all tags not handled internally into C<CBOR::XS::Tagged>
+objects, with no other special handling (useful when working with
+potentially "unsafe" CBOR data).
+   CBOR::XS->new->filter (sub { })->decode ($cbor_data);
+Example: provide a global filter for tag 1347375694, converting the value
+into some string form.
+   $CBOR::XS::FILTER{1347375694} = sub {
+      my ($tag, $value);
+      "tag 1347375694 value $value"
+   };
 =item $cbor_data = $cbor->encode ($perl_scalar)
 Converts the given Perl data structure (a scalar value) to its CBOR
 representation.
 CBOR integers become (numeric) perl scalars. On perls without 64 bit
 support, 64 bit integers will be truncated or otherwise corrupted.
 =item byte strings
-Byte strings will become octet strings in Perl (the byte values 0..255
+Byte strings will become octet strings in Perl (the Byte values 0..255
 will simply become characters of the same value in Perl).
 =item UTF-8 strings
 UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be
 C<Types:Serialiser::false> and C<Types::Serialiser::error>,
 respectively. They are overloaded to act almost exactly like the numbers
 C<1> and C<0> (for true and false) or to throw an exception on access (for
 error). See the L<Types::Serialiser> manpage for details.
-=item CBOR tag 256 (perl object)
+=item tagged values
-The tag value C<256> (TODO: pending iana registration) will be used
-to deserialise a Perl object serialised with C<FREEZE>. See L<OBJECT
-SERIALISATION>, below, for details.
-=item CBOR tag 55799 (magic header)
-The tag 55799 is ignored (this tag implements the magic header).
-=item other CBOR tags
-Tagged items consists of a numeric tag and another CBOR value. Tags not
+Tagged items consists of a numeric tag and another CBOR value.
-handled internally are currently converted into a L<CBOR::XS::Tagged>
-object, which is simply a blessed array reference consisting of the
-numeric tag value followed by the (decoded) CBOR value.
-In the future, support for user-supplied conversions might get added.
+See L<TAG HANDLING AND EXTENSIONS> and the description of C<< ->filter >>
+for details on which tags are handled how.
 =item anything else
 Anything else (e.g. unsupported simple values) will raise a decoding
 error.
 =head2 PERL -> CBOR
 The mapping from Perl to CBOR is slightly more difficult, as Perl is a
-truly typeless language, so we can only guess which CBOR type is meant by
+typeless language. That means this module can only guess which CBOR type
-a Perl value.
+is meant by a perl value.
 =over 4
 =item hash references
 Perl hash references become CBOR maps. As there is no inherent ordering in
 hash keys (or CBOR maps), they will usually be encoded in a pseudo-random
-order.
+order. This order can be different each time a hahs is encoded.
 Currently, tied hashes will use the indefinite-length format, while normal
 hashes will use the fixed-length format.
 =item array references
 Perl array references become fixed-length CBOR arrays.
 =item other references
-Other unblessed references are generally not allowed and will cause an
+Other unblessed references will be represented using
-exception to be thrown, except for references to the integers C<0> and
+the indirection tag extension (tag value C<22098>,
-C<1>, which get turned into false and true in CBOR.
+L<http://cbor.schmorp.de/indirection>). CBOR decoders are guaranteed
+to be able to decode these values somehow, by either "doing the right
+thing", decoding into a generic tagged object, simply ignoring the tag, or
+something else.
 =item CBOR::XS::Tagged objects
 Objects of this type must be arrays consisting of a single C<[tag, value]>
 pair. The (numerical) tag will be encoded as a CBOR tag, the value will
-be encoded as appropriate for the value. You cna use C<CBOR::XS::tag> to
+be encoded as appropriate for the value. You must use C<CBOR::XS::tag> to
 create such objects.
 =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error
 These special values become CBOR true, CBOR false and CBOR undefined
 if you want.
 =item other blessed objects
 Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See
-L<OBJECT SERIALISATION>, below, for details.
+L<TAG HANDLING AND EXTENSIONS> for specific classes handled by this
+module, and L<OBJECT SERIALISATION> for generic object serialisation.
 =item simple scalars
-TODO
 Simple Perl scalars (any scalar that is not a reference) are the most
 difficult objects to encode: CBOR::XS will encode undefined scalars as
 CBOR null values, scalars that have last been used in a string context
 before encoding as CBOR strings, and anything else as number value:
    # dump as number
    encode_cbor [2]                      # yields [2]
    encode_cbor [-3.0e17]                # yields [-3e+17]
    my $value = 5; encode_cbor [$value]  # yields [5]
-   # used as string, so dump as string
+   # used as string, so dump as string (either byte or text)
    print $value;
    encode_cbor [$value]                 # yields ["5"]
    # undef becomes null
    encode_cbor [undef]                  # yields [null]
    my $x = 3.1; # some variable containing a number
    "$x";        # stringified
    $x .= "";    # another, more awkward way to stringify
    print $x;    # perl does it for you, too, quite often
+You can force whether a string ie encoded as byte or text string by using
+C<utf8::upgrade> and C<utf8::downgrade>):
+  utf8::upgrade $x;   # encode $x as text string
+  utf8::downgrade $x; # encode $x as byte string
+Perl doesn't define what operations up- and downgrade strings, so if the
+difference between byte and text is important, you should up- or downgrade
+your string as late as possible before encoding.
 You can force the type to be a CBOR number by numifying it:
    my $x = "3"; # some variable containing a string
    $x += 0;     # numify it, ensuring it will be dumped as a number
 =back
 =head2 OBJECT SERIALISATION
+This module implements both a CBOR-specific and the generic
+L<Types::Serialier> object serialisation protocol. The following
+subsections explain both methods.
+=head3 ENCODING
 This module knows two way to serialise a Perl object: The CBOR-specific
 way, and the generic way.
-Whenever the encoder encounters a Perl object that it cnanot serialise
+Whenever the encoder encounters a Perl object that it cannot serialise
 directly (most of them), it will first look up the C<TO_CBOR> method on
 it.
 If it has a C<TO_CBOR> method, it will call it with the object as only
 argument, and expects exactly one return value, which it will then
 The C<FREEZE> method can return any number of values (i.e. zero or
 more). These will be encoded as CBOR perl object, together with the
 classname.
+These methods I<MUST NOT> change the data structure that is being
+serialised. Failure to comply to this can result in memory corruption -
+and worse.
 If an object supports neither C<TO_CBOR> nor C<FREEZE>, encoding will fail
 with an error.
+=head3 DECODING
-Objects encoded via C<TO_CBOR> cannot be automatically decoded, but
+Objects encoded via C<TO_CBOR> cannot (normally) be automatically decoded,
-objects encoded via C<FREEZE> can be decoded using the following protocol:
+but objects encoded via C<FREEZE> can be decoded using the following
+protocol:
 When an encoded CBOR perl object is encountered by the decoder, it will
 look up the C<THAW> method, by using the stored classname, and will fail
 if the method cannot be found.
 After the lookup it will call the C<THAW> method with the stored classname
 as first argument, the constant string C<CBOR> as second argument, and all
 values returned by C<FREEZE> as remaining arguments.
-=head4 EXAMPLES
+=head3 EXAMPLES
 Here is an example C<TO_CBOR> method:
    sub My::Object::TO_CBOR {
       my ($obj) = @_;
   sub URI::TO_CBOR {
      my ($self) = @_;
      my $uri = "$self"; # stringify uri
      utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string
-     CBOR::XS::tagged 32, "$_[0]"
+     CBOR::XS::tag 32, "$_[0]"
   }
 This will encode URIs as a UTF-8 string with tag 32, which indicates an
 URI.
 and extensions. If a tag is not mentioned here and no additional filters
 are provided for it, then the default handling applies (creating a
 CBOR::XS::Tagged object on decoding, and only encoding the tag when
 explicitly requested).
+Tags not handled specifically are currently converted into a
+L<CBOR::XS::Tagged> object, which is simply a blessed array reference
+consisting of the numeric tag value followed by the (decoded) CBOR value.
 Future versions of this module reserve the right to special case
 additional tags (such as base64url).
 =head2 ENFORCED TAGS
 These tags are always handled when decoding, and their handling cannot be
 overriden by the user.
 =over 4
-=item <unassigned> (perl-object, L<http://cbor.schmorp.de/perl-object>)
+=item 26 (perl-object, L<http://cbor.schmorp.de/perl-object>)
-These tags are automatically created for serialisable objects using the
+These tags are automatically created (and decoded) for serialisable
-C<FREEZE/THAW> methods (the L<Types::Serialier> object serialisation
+objects using the C<FREEZE/THAW> methods (the L<Types::Serialier> object
-protocol).
+serialisation protocol). See L<OBJECT SERIALISATION> for details.
-=item <unassigned>, <unassigned> (sharable, sharedref, L <http://cbor.schmorp.de/value-sharing>)
+=item 28, 29 (shareable, sharedref, L <http://cbor.schmorp.de/value-sharing>)
-These tags are automatically decoded when encountered, resulting in
+These tags are automatically decoded when encountered (and they do not
+result in a cyclic data structure, see C<allow_cycles>), resulting in
 shared values in the decoded object. They are only encoded, however, when
-C<allow_sharable> is enabled.
+C<allow_sharing> is enabled.
+Not all shared values can be successfully decoded: values that reference
+themselves will I<currently> decode as C<undef> (this is not the same
+as a reference pointing to itself, which will be represented as a value
+that contains an indirect reference to itself - these will be decoded
+properly).
+Note that considerably more shared value data structures can be decoded
+than will be encoded - currently, only values pointed to by references
+will be shared, others will not. While non-reference shared values can be
+generated in Perl with some effort, they were considered too unimportant
+to be supported in the encoder. The decoder, however, will decode these
+values as shared values.
-=item <unassigned>, <unassigned> (stringref-namespace, stringref, L <http://cbor.schmorp.de/stringref>)
+=item 256, 25 (stringref-namespace, stringref, L <http://cbor.schmorp.de/stringref>)
 These tags are automatically decoded when encountered. They are only
-encoded, however, when C<allow_stringref> is enabled.
+encoded, however, when C<pack_strings> is enabled.
 =item 22098 (indirection, L<http://cbor.schmorp.de/indirection>)
 This tag is automatically generated when a reference are encountered (with
 the exception of hash and array refernces). It is converted to a reference
 This value is not generated on encoding (unless explicitly requested by
 the user), and is simply ignored when decoding.
 =back
-=head2 OPTIONAL TAGS
+=head2 NON-ENFORCED TAGS
 These tags have default filters provided when decoding. Their handling can
 be overriden by changing the C<%CBOR::XS::FILTER> entry for the tag, or by
-providing a custom C<filter> function when decoding.
+providing a custom C<filter> callback when decoding.
 When they result in decoding into a specific Perl class, the module
 usually provides a corresponding C<TO_CBOR> method as well.
 When any of these need to load additional modules that are not part of the
 Only the double data type is supported for NV data types - when Perl uses
 long double to represent floating point values, they might not be encoded
 properly. Half precision types are accepted, but not encoded.
 Strict mode and canonical mode are not implemented.
+=head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT
+On perls that were built without 64 bit integer support (these are rare
+nowadays, even on 32 bit architectures), support for any kind of 64 bit
+integer in CBOR is very limited - most likely, these 64 bit values will
+be truncated, corrupted, or otherwise not decoded correctly. This also
+includes string, array and map sizes that are stored as 64 bit integers.
 =head1 THREADS
 This module is I<not> guaranteed to be thread safe and there are no

Diff Legend

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

Comparing CBOR-XS/XS.pm (file contents): Revision 1.22 by root, Fri Nov 22 15:28:38 2013 UTC vs. Revision 1.34 by root, Sun Dec 1 14:48:00 2013 UTC

Diff Legend

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.22 by root, Fri Nov 22 15:28:38 2013 UTC vs.
Revision 1.34 by root, Sun Dec 1 14:48:00 2013 UTC