1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
|
#========================================================================
#
# Badger::Codec::YAML
#
# DESCRIPTION
# Codec module for encoding/decoding YAML
#
# AUTHOR
# Andy Wardley <abw@wardley.org>
#
#========================================================================
package Badger::Codec::YAML;
use Badger::Class
version => 0.01,
base => 'Badger::Codec',
import => 'class CLASS';
eval "require YAML::XS";
our $HAS_YAML_XS = $@ ? 0 : 1;
our $HAS_YAML;
unless ($HAS_YAML_XS) {
eval "require YAML";
$HAS_YAML = $@ ? 0 : 1;
}
our $MODULE =
$HAS_YAML_XS ? 'YAML::XS' :
$HAS_YAML ? 'YAML' :
CLASS->error("You don't have YAML or YAML::XS installed");
#die "No YAML implementation installed\n";
*yaml_dump = $HAS_YAML_XS ? \&YAML::XS::Dump : \&YAML::Dump;
*yaml_load = $HAS_YAML_XS ? \&YAML::XS::Load : \&YAML::Load;
sub encode {
my $self = shift;
yaml_dump(shift);
}
sub decode {
my $self = shift;
yaml_load(shift);
}
# shortcuts straight to the real encoder/decoder subs for efficient aliasing
sub encoder {
\&yaml_dump;
}
sub decoder {
\&yaml_load;
}
1;
__END__
=head1 NAME
Badger::Codec::YAML - encode/decode data using YAML
=head1 SYNOPSIS
use Badger::Codec::YAML;
my $codec = Badger::Codec::YAML->new();
my $encoded = $codec->encode("Hello World");
my $decoded = $codec->decode($encoded);
=head1 DESCRIPTION
This module implements a subclass of L<Badger::Codec> which uses the
L<YAML> module to encode and decode data to and from YAML.
=head1 METHODS
=head2 encode($data)
Encodes C<$data> to YAML.
$encoded = Badger::Codec::YAML->encode($data);
=head2 decode($data)
Decodes C<$data> from YAML.
$decoded = Badger::Codec::YAML->decode($encoded);
=head2 encoder()
This method returns a reference to the real subroutine that's doing
all the encoding work, i.e. the C<Dump()> subroutine in L<YAML>.
=head2 decoder()
This method returns a reference to the real subroutine that's doing
all the decoding work, i.e. the C<Load()> subroutine in L<YAML>.
=head1 AUTHOR
Andy Wardley L<http://wardley.org/>
=head1 COPYRIGHT
Copyright (C) 2005-2009 Andy Wardley. All rights reserved.
=head1 SEE ALSO
L<Badger::Codecs>, L<Badger::Codec>, L<YAML>
=cut
# Local Variables:
# mode: Perl
# perl-indent-level: 4
# indent-tabs-mode: nil
# End:
#
# vim: expandtab shiftwidth=4:
|