1 # Pod::Text::Color -- Convert POD data to formatted color ASCII text
2 # $Id: Color.pm,v 1.4 2002/07/15 05:46:00 eagle Exp $
4 # Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>
6 # This program is free software; you may redistribute it and/or modify it
7 # under the same terms as Perl itself.
9 # This is just a basic proof of concept. It should later be modified to make
10 # better use of color, take options changing what colors are used for what
13 ##############################################################################
14 # Modules and declarations
15 ##############################################################################
17 package Pod::Text::Color;
22 use Term::ANSIColor qw(colored);
25 use vars qw(@ISA $VERSION);
29 # Don't use the CVS revision as the version, since this module is also in Perl
30 # core and too many things could munge CVS magic revision strings. This
31 # number should ideally be the same as the CVS revision in podlators, however.
35 ##############################################################################
37 ##############################################################################
39 # Make level one headings bold.
44 $self->SUPER::cmd_head1 (colored ($_, 'bold'));
47 # Make level two headings bold.
52 $self->SUPER::cmd_head2 (colored ($_, 'bold'));
55 # Fix the various formatting codes.
56 sub seq_b { return colored ($_[1], 'bold') }
57 sub seq_f { return colored ($_[1], 'cyan') }
58 sub seq_i { return colored ($_[1], 'yellow') }
60 # Output any included code in green.
62 my ($self, $code) = @_;
63 $code = colored ($code, 'green');
64 $self->output ($code);
67 # We unfortunately have to override the wrapping code here, since the normal
68 # wrapping code gets really confused by all the escape sequences.
73 my $spaces = ' ' x $$self{MARGIN};
74 my $width = $$self{width} - $$self{MARGIN};
75 while (length > $width) {
76 if (s/^((?:(?:\e\[[\d;]+m)?[^\n]){0,$width})\s+//
77 || s/^((?:(?:\e\[[\d;]+m)?[^\n]){$width})//) {
78 $output .= $spaces . $1 . "\n";
83 $output .= $spaces . $_;
84 $output =~ s/\s+$/\n\n/;
88 ##############################################################################
89 # Module return value and documentation
90 ##############################################################################
97 Pod::Text::Color - Convert POD data to formatted color ASCII text
101 use Pod::Text::Color;
102 my $parser = Pod::Text::Color->new (sentence => 0, width => 78);
104 # Read POD from STDIN and write to STDOUT.
105 $parser->parse_from_filehandle;
107 # Read POD from file.pod and write to file.txt.
108 $parser->parse_from_file ('file.pod', 'file.txt');
112 Pod::Text::Color is a simple subclass of Pod::Text that highlights output
113 text using ANSI color escape sequences. Apart from the color, it in all
114 ways functions like Pod::Text. See L<Pod::Text> for details and available
117 Term::ANSIColor is used to get colors and therefore must be installed to use
122 This is just a basic proof of concept. It should be seriously expanded to
123 support configurable coloration via options passed to the constructor, and
124 B<pod2text> should be taught about those.
128 L<Pod::Text>, L<Pod::Parser>
130 The current version of this module is always available from its web site at
131 L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
132 Perl core distribution as of 5.6.0.
136 Russ Allbery <rra@stanford.edu>.
138 =head1 COPYRIGHT AND LICENSE
140 Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>.
142 This program is free software; you may redistribute it and/or modify it
143 under the same terms as Perl itself.