File Coverage

blib/lib/Graph/Writer.pm

Criterion	Covered	Total	%
statement	26	28	92.8
branch	5	6	83.3
condition			n/a
subroutine	7	7	100.0
pod	2	2	100.0
total	40	43	93.0

#
# Graph::Writer - perl base class for Graph file format writers
#
package Graph::Writer;
$Graph::Writer::VERSION = '2.09';
use 5.006;
use strict;
use warnings;

use IO::File;

#=======================================================================
#
# new () - constructor
#
# Create an instance of a Graph writer. This will not be invoked
# directly on this class, but will be inherited by writers for
# specific formats.
#
#=======================================================================
sub new
{
    my $class = shift;

    die "don't create an instance of $class!\n" if $class eq __PACKAGE__;

    my $self = bless {}, $class;

    $self->_init(@_);

    return $self;
}

#=======================================================================
#
# _init() - initialise instance
#
# This is for any instance-specific initialisation. The idea is that
# a sub-class will define an _init() method if it needs one.
# For future compatibility the class-specific method should invoke
# this.
#
#=======================================================================
sub _init
{
}


#=======================================================================
#
# write_graph() - write the specified graph to the specified file (handle)
#
# This is the public method that will be invoked to write a graph.
# The file can be specified either as a filename, or a filehandle.
#
#=======================================================================
sub write_graph
{
    my $self     = shift;
    my $graph    = shift;
    my $filename = shift;


    if (ref $filename)
    {
        $self->_write_graph($graph, $filename);
    }
    else
    {
        my $FILE = IO::File->new("> $filename");
        if (not defined $FILE)
        {
            warn "couldn't write to $filename: $!\n";
            return 0;
        }
        $self->_write_graph($graph, $FILE);
        $FILE->close();
    }

    return 1;
}

1;

__END__