File Coverage

blib/lib/Chess/PGN/Parse/FileHandle.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod	1	1	100.0
total	18	18	100.0

package Chess::PGN::Parse::FileHandle;

use warnings;
use strict;

use Chess::PGN::Parse;

=head1 NAME

Chess::PGN::Parse::FileHandle - Parse PGN from a FileHandle

=head1 VERSION

Version 0.02

=cut

our $VERSION = '0.02';
our @ISA = qw(Chess::PGN::Parse);

=head1 SYNOPSIS

    use Chess::PGN::Parse::FileHandle;

    # read from a gzip'ed file with gunzipping first
    open my $pgn_gz, "<:gzip", "my_pgns.pgn.gz" or die $!;

    my $pgn = Chess::PGN::Parse::FileHandle->new($pgn_gz);
    while ($pgn->read_game()) {
        # Process the file like you would with Chess::PGN::Parse
        ...
    }

=head1 DESCRIPTION

After getting tired of having to repeatedly C and C PGN
files to process through C, I decided there had to
be an easier way.  Well, this is it.  This module is simple subclass
of C that allows Cs as a parameter.

=head1 FUNCTIONS

=head2 new FILEHANDLE

Returns a new C object, ready to read from
C.

The remaining methods of this class are inherited directly from
C.

=cut

sub new {
    my ($class, $fh) = @_;
    my $self = $class->SUPER::new('');
    $self->{fh} = \$fh;
    return bless $self, $class;
}

=head1 NOTES

This is a naughty module that peeks at the internals of another module.
It could easily break if changes are made to C.

=head1 AUTHOR

Steve Peters, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to
C, or through the web interface at
L.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.

=head1 ACKNOWLEDGMENTS

Giuseppe Maxia for C

=head1 COPYRIGHT & LICENSE

Copyright 2005 Steve Peters, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1; # End of Chess::PGN::Parse::FileHandle