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

外挂编程

开发平台:

Windows_Unix

  1. package Data::YAML::Reader;
  2. use strict;
  3. use warnings;
  4. use Carp;
  5. use vars qw{$VERSION};
  6. $VERSION = '0.0.5';
  7. # TODO:
  8. #   Handle blessed object syntax
  9. # Printable characters for escapes
  10. my %UNESCAPES = (
  11.     z    => "x00",
  12.     a    => "x07",
  13.     t    => "x09",
  14.     n    => "x0a",
  15.     v    => "x0b",
  16.     f    => "x0c",
  17.     r    => "x0d",
  18.     e    => "x1b",
  19.     '\' => '\',
  20. );
  21. my $QQ_STRING    = qr{ " (?:\. | [^"])* " }x;
  22. my $HASH_LINE    = qr{ ^ ($QQ_STRING|S+) s* : (?: s+ (.+?) s* )? $ }x;
  23. my $IS_HASH_KEY  = qr{ ^ [w'"] }x;
  24. my $IS_END_YAML  = qr{ ^ [.][.][.] s* $ }x;
  25. my $IS_QQ_STRING = qr{ ^ $QQ_STRING $ }x;
  26. # Create an empty Data::YAML::Reader object
  27. sub new {
  28.     my $class = shift;
  29.     bless {}, $class;
  30. }
  31. sub _make_reader {
  32.     my $self = shift;
  33.     my $obj  = shift;
  34.     croak "Must have something to read from"
  35.       unless defined $obj;
  36.     if ( my $ref = ref $obj ) {
  37.         if ( 'CODE' eq $ref ) {
  38.             return $obj;
  39.         }
  40.         elsif ( 'ARRAY' eq $ref ) {
  41.             return sub { shift @$obj };
  42.         }
  43.         elsif ( 'SCALAR' eq $ref ) {
  44.             return $self->_make_reader( $$obj );
  45.         }
  46.         elsif ( 'GLOB' eq $ref || 'IO::Handle' eq $ref ) {
  47.             return sub {
  48.                 my $line = <$obj>;
  49.                 chomp $line if defined $line;
  50.                 return $line;
  51.             };
  52.         }
  53.         croak "Don't know how to read $ref";
  54.     }
  55.     else {
  56.         my @lines = split( /n/, $obj );
  57.         return sub { shift @lines };
  58.     }
  59. }
  60. sub read {
  61.     my $self = shift;
  62.     my $obj  = shift;
  63.     $self->{reader}  = $self->_make_reader( $obj );
  64.     $self->{capture} = [];
  65.     #聽Prime the reader
  66.     $self->_next;
  67.     my $doc = $self->_read;
  68.     # The terminator is mandatory otherwise we'd consume a line from the
  69.     # iterator that doesn't belong to us. If we want to remove this
  70.     # restriction we'll have to implement look-ahead in the iterators.
  71.     # Which might not be a bad idea.
  72.     my $dots = $self->_peek;
  73.     croak "Missing '...' at end of YAML"
  74.       unless $dots =~ $IS_END_YAML;
  75.     delete $self->{reader};
  76.     delete $self->{next};
  77.     return $doc;
  78. }
  79. sub get_raw {
  80.     my $self = shift;
  81.     if ( defined( my $capture = $self->{capture} ) ) {
  82.         return join( "n", @$capture ) . "n";
  83.     }
  84.     return '';
  85. }
  86. sub _peek {
  87.     my $self = shift;
  88.     return $self->{next} unless wantarray;
  89.     my $line = $self->{next};
  90.     $line =~ /^ (s*) (.*) $ /x;
  91.     return ( $2, length $1 );
  92. }
  93. sub _next {
  94.     my $self = shift;
  95.     croak "_next called with no reader"
  96.       unless $self->{reader};
  97.     my $line = $self->{reader}->();
  98.     $self->{next} = $line;
  99.     push @{ $self->{capture} }, $line;
  100. }
  101. sub _read {
  102.     my $self = shift;
  103.     my $line = $self->_peek;
  104.     # Do we have a document header?
  105.     if ( $line =~ /^ --- (?: s* (.+?) s* )? $/x ) {
  106.         $self->_next;
  107.         return $self->_read_scalar( $1 ) if defined $1;    # Inline?
  108.         my ( $next, $indent ) = $self->_peek;
  109.         if ( $next =~ /^ - /x ) {
  110.             return $self->_read_array( $indent );
  111.         }
  112.         elsif ( $next =~ $IS_HASH_KEY ) {
  113.             return $self->_read_hash( $next, $indent );
  114.         }
  115.         elsif ( $next =~ $IS_END_YAML ) {
  116.             croak "Premature end of YAML";
  117.         }
  118.         else {
  119.             croak "Unsupported YAML syntax: '$next'";
  120.         }
  121.     }
  122.     else {
  123.         croak "YAML document header not found";
  124.     }
  125. }
  126. # Parse a double quoted string
  127. sub _read_qq {
  128.     my $self = shift;
  129.     my $str  = shift;
  130.     unless ( $str =~ s/^ " (.*?) " $/$1/x ) {
  131.         die "Internal: not a quoted string";
  132.     }
  133.     $str =~ s/\"/"/gx;
  134.     $str =~ s/ \ ( [tartan\favez] | x([0-9a-fA-F]{2}) ) 
  135.                  / (length($1) > 1) ? pack("H2", $2) : $UNESCAPES{$1} /gex;
  136.     return $str;
  137. }
  138. # Parse a scalar string to the actual scalar
  139. sub _read_scalar {
  140.     my $self   = shift;
  141.     my $string = shift;
  142.     return undef if $string eq '~';
  143.     if ( $string eq '>' || $string eq '|' ) {
  144.         my ( $line, $indent ) = $self->_peek;
  145.         die "Multi-line scalar content missing" unless defined $line;
  146.         my @multiline = ($line);
  147.         while (1) {
  148.             $self->_next;
  149.             my ( $next, $ind ) = $self->_peek;
  150.             last if $ind < $indent;
  151.             push @multiline, $next;
  152.         }
  153.         return join( ( $string eq '>' ? ' ' : "n" ), @multiline ) . "n";
  154.     }
  155.     if ( $string =~ /^ ' (.*) ' $/x ) {
  156.         ( my $rv = $1 ) =~ s/''/'/g;
  157.         return $rv;
  158.     }
  159.     if ( $string =~ $IS_QQ_STRING ) {
  160.         return $self->_read_qq($string);
  161.     }
  162.     if ( $string =~ /^['"]/ ) {
  163.         # A quote with folding... we don't support that
  164.         die __PACKAGE__ . " does not support multi-line quoted scalars";
  165.     }
  166.     # Regular unquoted string
  167.     return $string;
  168. }
  169. sub _read_nested {
  170.     my $self = shift;
  171.     my ( $line, $indent ) = $self->_peek;
  172.     if ( $line =~ /^ -/x ) {
  173.         return $self->_read_array( $indent );
  174.     }
  175.     elsif ( $line =~ $IS_HASH_KEY ) {
  176.         return $self->_read_hash( $line, $indent );
  177.     }
  178.     else {
  179.         croak "Unsupported YAML syntax: '$line'";
  180.     }
  181. }
  182. # Parse an array
  183. sub _read_array {
  184.     my ( $self, $limit ) = @_;
  185.     my $ar = [];
  186.     while ( 1 ) {
  187.         my ( $line, $indent ) = $self->_peek;
  188.         last if $indent < $limit || !defined $line || $line =~ $IS_END_YAML;
  189.         if ( $indent > $limit ) {
  190.             croak "Array line over-indented";
  191.         }
  192.         if ( $line =~ /^ (- s+) S+ s* : (?: s+ | $ ) /x ) {
  193.             $indent += length $1;
  194.             $line =~ s/-s+//;
  195.             push @$ar, $self->_read_hash( $line, $indent );
  196.         }
  197.         elsif ( $line =~ /^ - s* (.+?) s* $/x ) {
  198.             croak "Unexpected start of YAML" if $line =~ /^---/;
  199.             $self->_next;
  200.             push @$ar, $self->_read_scalar( $1 );
  201.         }
  202.         elsif ( $line =~ /^ - s* $/x ) {
  203.             $self->_next;
  204.             push @$ar, $self->_read_nested;
  205.         }
  206.         elsif ( $line =~ $IS_HASH_KEY ) {
  207.             $self->_next;
  208.             push @$ar, $self->_read_hash( $line, $indent, );
  209.         }
  210.         else {
  211.             croak "Unsupported YAML syntax: '$line'";
  212.         }
  213.     }
  214.     return $ar;
  215. }
  216. sub _read_hash {
  217.     my ( $self, $line, $limit ) = @_;
  218.     my $indent;
  219.     my $hash = {};
  220.     while ( 1 ) {
  221.         croak "Badly formed hash line: '$line'"
  222.           unless $line =~ $HASH_LINE;
  223.         my ( $key, $value ) = ( $self->_read_scalar( $1 ), $2 );
  224.         $self->_next;
  225.         if ( defined $value ) {
  226.             $hash->{$key} = $self->_read_scalar( $value );
  227.         }
  228.         else {
  229.             $hash->{$key} = $self->_read_nested;
  230.         }
  231.         ( $line, $indent ) = $self->_peek;
  232.         last if $indent < $limit || !defined $line || $line =~ $IS_END_YAML;
  233.     }
  234.     return $hash;
  235. }
  236. 1;
  237. __END__
  238. =head1 NAME
  239. Data::YAML::Reader - Parse YAML created by Data::YAML::Writer
  240. =head1 VERSION
  241. This document describes Data::YAML::Reader version 0.0.5
  242. =head1 SYNOPSIS
  243.     use Data::YAML::Reader;
  244.     my $yr = Data::YAML::Reader->new;
  245.     
  246.     # Read from an array...
  247.     my $from_array = $yr->read( @some_array );
  248.     
  249.     # ...an open file handle...
  250.     my $from_handle = $yr->read( $some_file );
  251.     
  252.     # ...a string containing YAML...
  253.     my $from_string = $yr->read( $some_string );
  254.     
  255.     # ...or a closure
  256.     my $from_code = $yr->read( sub { return get_next_line() } );
  257. =head1 DESCRIPTION
  258. In the spirit of L<YAML::Tiny> this is a lightweight, dependency-free
  259. YAML reader. While C<YAML::Tiny> is designed principally for working
  260. with configuration files C<Data::YAML> concentrates on the transparent
  261. round-tripping of YAML serialized Perl data structures.
  262. The syntax accepted by C<Data::YAML::Reader> is a subset of YAML.
  263. Specifically it is the same subset of YAML that L<Data::YAML::Writer>
  264. produces. See L<Data::YAML> for more information.
  265. =head1 INTERFACE
  266. =over
  267. =item C<< new >>
  268. Creates and returns an empty C<Data::YAML::Reader> object. No options may be passed.
  269. =item C<< read( $source ) >>
  270. Read YAML and return the data structure it represents. The YAML data may be supplied by a
  271. =over
  272. =item * scalar string containing YAML source
  273. =item * the handle of an open file
  274. =item * a reference to an array of lines
  275. =item * a code reference
  276. =back
  277. In the case of a code reference a subroutine (most likely a closure)
  278. that returns successive lines of YAML must be supplied. Lines should
  279. have no trailing newline. When the YAML is exhausted the subroutine must
  280. return undef.
  281. Returns the data structure (specifically either a scalar, hash ref or
  282. array ref) that results from decoding the YAML.
  283. =item C<< get_raw >>
  284. Return the raw YAML source from the most recent C<read>.
  285. =back
  286. =head1 BUGS AND LIMITATIONS
  287. No bugs have been reported.
  288. Please report any bugs or feature requests to
  289. C<data-yaml@rt.cpan.org>, or through the web interface at
  290. L<http://rt.cpan.org>.
  291. =head1 SEE ALSO
  292. L<YAML::Tiny>, L<YAML>, L<YAML::Syck>, L<Config::Tiny>, L<CSS::Tiny>
  293. =head1 AUTHOR
  294. Andy Armstrong  C<< <andy@hexten.net> >>
  295. Adam Kennedy wrote L<YAML::Tiny> which provided the template and many of
  296. the YAML matching regular expressions for this module.
  297. =head1 LICENCE AND COPYRIGHT
  298. Copyright (c) 2007, Andy Armstrong C<< <andy@hexten.net> >>. All rights reserved.
  299. This module is free software; you can redistribute it and/or
  300. modify it under the same terms as Perl itself. See L<perlartistic>.
  301. =head1 DISCLAIMER OF WARRANTY
  302. BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
  303. FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
  304. OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
  305. PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  306. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  307. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
  308. ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
  309. YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
  310. NECESSARY SERVICING, REPAIR, OR CORRECTION.
  311. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  312. WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
  313. REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
  314. LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
  315. OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  316. THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
  317. RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
  318. FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
  319. SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
  320. SUCH DAMAGES.