File Coverage

lib/Devel/Trepan/Pod2Text.pm

Criterion	Covered	Total	%
statement	31	47	65.9
branch	6	20	30.0
condition	2	10	20.0
subroutine	7	8	87.5
pod	0	2	0.0
total	46	87	52.8

# Copyright (C) 2012, 2014 Rocky Bernstein <[e-mail]>
# -*- coding: utf-8 -*-

=head1 C<Devel::Trepan::Pod2Text>

Devel::Trepan interface to convert POD into a string the debugger
and then present using its output mechanism

=cut

package Devel::Trepan::Pod2Text;

use vars qw(@ISA @EXPORT);
@ISA = qw(Exporter); @EXPORT = qw(pod2string help2podstring);

use warnings; use strict;

use vars qw($HAVE_TEXT_COLOR $HAVE_TEXT);

BEGIN {
    $HAVE_TEXT_COLOR =
        eval {
               require Term::ANSIColor;
               require Pod::Text::Color;
    } ? 1 : 0;

    $HAVE_TEXT   = eval {
        require Pod::Text;
    } ? 1 : 0;
}

sub pod2string($;$$)
{
    my ($input_file, $color, $width) = @_;

    $width = ($ENV{'COLUMNS'} || 80) unless $width;
    $color = 0 unless $color;

    # Figure out what formatter we're going to use.
    my $formatter = 'Pod::Text';
    if ($color && $HAVE_TEXT_COLOR) {
        $formatter = 'Pod::Text::Color';
    } else {
        $formatter = 'Pod::Text';
    }


    my $p2t = $formatter->new(width => $width, indent => 2, utf8=>1);
    my $output_string;
    open(my $out_fh, '>', \$output_string);
    $p2t->parse_from_file($input_file, $out_fh);
    return $output_string;
}

sub help2podstring($;$$)
{
    my ($input_string, $color, $width) = @_;

    $width = ($ENV{'COLUMNS'} || 80) unless $width;
    $color = 0 unless $color;

    # Figure out what formatter we're going to use.
    my $formatter = 'Pod::Text';
    if ($color && $HAVE_TEXT_COLOR) {
        $formatter = 'Pod::Text::Color';
    } else {
        $formatter = 'Pod::Text';
    }

    my $p2t = $formatter->new(width => $width, indent => 2, utf8 => 1);
    my $output_string;
    open(my $out_fh, '>', \$output_string);
    open(my $in_fh, '<', \$input_string);

    $input_string = "=pod\n\n$input_string" unless
        "=pod\n" eq substr($input_string, 0, 4);
    $input_string .= "\n=cut\n" unless
        "\n=cut\n" eq substr($input_string, -6);
    $p2t->parse_from_file($in_fh, $out_fh);
    return $output_string;
}

unless (caller) {
    print pod2string(__FILE__);
    print '-' x 30, "\n";
    print pod2string(__FILE__, 1);
    print '-' x 30, "\n";
    print pod2string(__FILE__, 1, 40);
    print '=' x 30, "\n";
    print help2podstring("Now E<mdash> is the I<time>", 1, 40);
}

1;