File Coverage

blib/lib/Pod/Perldoc/ToANSI.pm
Criterion Covered Total %
statement 15 30 50.0
branch 0 6 0.0
condition 0 5 0.0
subroutine 5 16 31.2
pod 0 11 0.0
total 20 68 29.4


line stmt bran cond sub pod time code
1             package Pod::Perldoc::ToANSI;
2 1     1   1254 use strict;
  1         2  
  1         39  
3 1     1   7 use warnings;
  1         2  
  1         40  
4 1     1   5 use parent qw(Pod::Perldoc::BaseTo);
  1         2  
  1         5  
5              
6 1     1   69 use vars qw($VERSION);
  1         2  
  1         82  
7             $VERSION = '3.28';
8              
9 0     0 0   sub is_pageable { 1 }
10 0     0 0   sub write_with_binmode { 0 }
11 0     0 0   sub output_extension { 'txt' }
12              
13 1     1   680 use Pod::Text::Color ();
  1         8535  
  1         400  
14              
15 0     0 0   sub alt { shift->_perldoc_elem('alt' , @_) }
16 0     0 0   sub indent { shift->_perldoc_elem('indent' , @_) }
17 0     0 0   sub loose { shift->_perldoc_elem('loose' , @_) }
18 0     0 0   sub quotes { shift->_perldoc_elem('quotes' , @_) }
19 0     0 0   sub sentence { shift->_perldoc_elem('sentence', @_) }
20 0     0 0   sub width { shift->_perldoc_elem('width' , @_) }
21              
22 0   0 0 0   sub new { return bless {}, ref($_[0]) || $_[0] }
23              
24             sub parse_from_file {
25 0     0 0   my $self = shift;
26              
27             my @options =
28 0           map {; $_, $self->{$_} }
  0            
29             grep !m/^_/s,
30             keys %$self
31             ;
32              
33 0 0 0       defined(&Pod::Perldoc::DEBUG)
    0          
    0          
34             and Pod::Perldoc::DEBUG()
35             and print "About to call new Pod::Text::Color ",
36             $Pod::Text::VERSION ? "(v$Pod::Text::VERSION) " : '',
37             "with options: ",
38             @options ? "[@options]" : "(nil)", "\n";
39             ;
40              
41 0           Pod::Text::Color->new(@options)->parse_from_file(@_);
42             }
43              
44             1;
45              
46             =head1 NAME
47              
48             Pod::Perldoc::ToANSI - render Pod with ANSI color escapes
49              
50             =head1 SYNOPSIS
51              
52             perldoc -o ansi Some::Modulename
53              
54             =head1 DESCRIPTION
55              
56             This is a "plug-in" class that allows Perldoc to use
57             Pod::Text as a formatter class.
58              
59             It supports the following options, which are explained in
60             L: alt, indent, loose, quotes, sentence, width
61              
62             For example:
63              
64             perldoc -o term -w indent:5 Some::Modulename
65              
66             =head1 CAVEAT
67              
68             This module may change to use a different text formatter class in the
69             future, and this may change what options are supported.
70              
71             =head1 SEE ALSO
72              
73             L, L, L
74              
75             =head1 COPYRIGHT AND DISCLAIMERS
76              
77             Copyright (c) 2011 Mark Allen. All rights reserved.
78              
79             This library is free software; you can redistribute it and/or modify it
80             under the same terms as Perl itself.
81              
82             This program is distributed in the hope that it will be useful, but
83             without any warranty; without even the implied warranty of
84             merchantability or fitness for a particular purpose.
85              
86             =head1 AUTHOR
87              
88             Current maintainer: Mark Allen C<< >>
89              
90             Past contributions from:
91             brian d foy C<< >>
92             Adriano R. Ferreira C<< >>,
93             Sean M. Burke C<< >>
94              
95              
96             =cut