Writer.pm
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:6k
源码类别:

外挂编程

开发平台:

Windows_Unix

  1. package Data::YAML::Writer;
  2. use strict;
  3. use warnings;
  4. use Carp;
  5. use vars qw{$VERSION};
  6. $VERSION = '0.0.5';
  7. my $ESCAPE_CHAR = qr{ [ x00-x1f " ] }x;
  8. my @UNPRINTABLE = qw(
  9.   z    x01  x02  x03  x04  x05  x06  a
  10.   x08  t    n    v    f    r    x0e  x0f
  11.   x10  x11  x12  x13  x14  x15  x16  x17
  12.   x18  x19  x1a  e    x1c  x1d  x1e  x1f
  13. );
  14. # Create an empty Data::YAML::Writer object
  15. sub new {
  16.     my $class = shift;
  17.     bless {}, $class;
  18. }
  19. sub write {
  20.     my $self = shift;
  21.     croak "Need something to write"
  22.       unless @_;
  23.     my $obj = shift;
  24.     my $out = shift || *STDOUT;
  25.     croak "Need a reference to something I can write to"
  26.       unless ref $out;
  27.     $self->{writer} = $self->_make_writer( $out );
  28.     $self->_write_obj( '---', $obj );
  29.     $self->_put( '...' );
  30.     delete $self->{writer};
  31. }
  32. sub _make_writer {
  33.     my $self = shift;
  34.     my $out  = shift;
  35.     my $ref = ref $out;
  36.     if ( 'CODE' eq $ref ) {
  37.         return $out;
  38.     }
  39.     elsif ( 'ARRAY' eq $ref ) {
  40.         return sub { push @$out, shift };
  41.     }
  42.     elsif ( 'SCALAR' eq $ref ) {
  43.         return sub { $$out .= shift() . "n" };
  44.     }
  45.     elsif ( 'GLOB' eq $ref || 'IO::Handle' eq $ref ) {
  46.         return sub { print $out shift(), "n" };
  47.     }
  48.     croak "Can't write to $out";
  49. }
  50. sub _put {
  51.     my $self = shift;
  52.     $self->{writer}->( join '', @_ );
  53. }
  54. sub _enc_scalar {
  55.     my $self = shift;
  56.     my $val  = shift;
  57.     return '~' unless defined $val;
  58.     if ( $val =~ /$ESCAPE_CHAR/ ) {
  59.         $val =~ s/\/\\/g;
  60.         $val =~ s/"/\"/g;
  61.         $val =~ s/ ( [x00-x1f] ) / '\' . $UNPRINTABLE[ ord($1) ] /gex;
  62.         return qq{"$val"};
  63.     }
  64.     if ( length( $val ) == 0 or $val =~ /s/ ) {
  65.         $val =~ s/'/''/;
  66.         return "'$val'";
  67.     }
  68.     return $val;
  69. }
  70. sub _write_obj {
  71.     my $self   = shift;
  72.     my $prefix = shift;
  73.     my $obj    = shift;
  74.     my $indent = shift || 0;
  75.     if ( my $ref = ref $obj ) {
  76.         my $pad = '  ' x $indent;
  77.         $self->_put( $prefix );
  78.         if ( 'HASH' eq $ref ) {
  79.             for my $key ( sort keys %$obj ) {
  80.                 my $value = $obj->{$key};
  81.                 $self->_write_obj( $pad . $self->_enc_scalar( $key ) . ':',
  82.                     $value, $indent + 1 );
  83.             }
  84.         }
  85.         elsif ( 'ARRAY' eq $ref ) {
  86.             for my $value ( @$obj ) {
  87.                 $self->_write_obj( $pad . '-', $value, $indent + 1 );
  88.             }
  89.         }
  90.         else {
  91.             croak "Don't know how to encode $ref";
  92.         }
  93.     }
  94.     else {
  95.         $self->_put( $prefix, ' ', $self->_enc_scalar( $obj ) );
  96.     }
  97. }
  98. 1;
  99. __END__
  100. =head1 NAME
  101. Data::YAML::Writer - Easy YAML serialisation
  102. =head1 VERSION
  103. This document describes Data::YAML::Writer version 0.0.5
  104. =head1 SYNOPSIS
  105.     
  106.     use Data::YAML::Writer;
  107.     
  108.     my $data = {
  109.         one => 1,
  110.         two => 2,
  111.         three => [ 1, 2, 3 ],
  112.     };
  113.     
  114.     my $yw = Data::YAML::Writer->new;
  115.     
  116.     # Write to an array...
  117.     $yw->write( $data, @some_array );
  118.     
  119.     # ...an open file handle...
  120.     $yw->write( $data, $some_file_handle );
  121.     
  122.     # ...a string ...
  123.     $yw->write( $data, $some_string );
  124.     
  125.     # ...or a closure
  126.     $yw->write( $data, sub {
  127.         my $line = shift;
  128.         print "$linen";
  129.     } );
  130. =head1 DESCRIPTION
  131. Encodes a scalar, hash reference or array reference as YAML.
  132. In the spirit of L<YAML::Tiny> this is a lightweight, dependency-free
  133. YAML writer. While C<YAML::Tiny> is designed principally for working
  134. with configuration files C<Data::YAML> concentrates on the transparent
  135. round-tripping of YAML serialized Perl data structures.
  136. The syntax produced by C<Data::YAML::Writer> is a subset of YAML.
  137. Specifically it is the same subset of YAML that L<Data::YAML::Reader>
  138. consumes. See L<Data::YAML> for more information.
  139. =head1 INTERFACE
  140. =over
  141. =item C<< new >>
  142. The constructor C<new> creates and returns an empty C<Data::YAML::Writer> object.
  143. =item C<< write( $obj, $output ) >>
  144. Encode a scalar, hash reference or array reference as YAML.
  145.     my $writer = sub {
  146.         my $line = shift;
  147.         print SOMEFILE "$linen";
  148.     };
  149.     
  150.     my $data = {
  151.         one => 1,
  152.         two => 2,
  153.         three => [ 1, 2, 3 ],
  154.     };
  155.     
  156.     my $yw = Data::YAML::Writer->new;
  157.     $yw->write( $data, $writer );
  158. The C< $output > argument may be
  159. =over
  160. =item * a reference to a scalar to append YAML to
  161. =item * the handle of an open file
  162. =item * a reference to an array into which YAML will be pushed
  163. =item * a code reference
  164. =back
  165. If you supply a code reference the subroutine will be called once for
  166. each line of output with the line as its only argument. Passed lines
  167. will have no trailing newline.
  168. =back
  169. =head1 BUGS AND LIMITATIONS
  170. No bugs have been reported.
  171. Please report any bugs or feature requests to
  172. C<data-yaml@rt.cpan.org>, or through the web interface at
  173. L<http://rt.cpan.org>.
  174. =head1 SEE ALSO
  175. L<YAML::Tiny>, L<YAML>, L<YAML::Syck>, L<Config::Tiny>, L<CSS::Tiny>
  176. =head1 AUTHOR
  177. Andy Armstrong  C<< <andy@hexten.net> >>
  178. =head1 LICENCE AND COPYRIGHT
  179. Copyright (c) 2007, Andy Armstrong C<< <andy@hexten.net> >>. All rights reserved.
  180. This module is free software; you can redistribute it and/or
  181. modify it under the same terms as Perl itself. See L<perlartistic>.
  182. =head1 DISCLAIMER OF WARRANTY
  183. BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
  184. FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
  185. OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
  186. PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  187. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  188. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
  189. ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
  190. YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
  191. NECESSARY SERVICING, REPAIR, OR CORRECTION.
  192. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  193. WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
  194. REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
  195. LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
  196. OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  197. THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
  198. RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
  199. FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
  200. SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
  201. SUCH DAMAGES.