1 # Pod::Text::Termcap -- Convert POD data to ASCII text with format escapes.
3 # Copyright 1999, 2001, 2002, 2004, 2006, 2008 Russ Allbery <rra@stanford.edu>
5 # This program is free software; you may redistribute it and/or modify it
6 # under the same terms as Perl itself.
8 # This is a simple subclass of Pod::Text that overrides a few key methods to
9 # output the right termcap escape sequences for formatted text on the current
12 ##############################################################################
13 # Modules and declarations
14 ##############################################################################
16 package Pod::Text::Termcap;
25 use vars qw(@ISA $VERSION);
31 ##############################################################################
33 ##############################################################################
35 # In the initialization method, grab our terminal characteristics as well as
36 # do all the stuff we normally do.
38 my ($self, @args) = @_;
39 my ($ospeed, $term, $termios);
40 $self = $self->SUPER::new (@args);
42 # $ENV{HOME} is usually not set on Windows. The default Term::Cap path
43 # may not work on Solaris.
44 my $home = exists $ENV{HOME} ? "$ENV{HOME}/.termcap:" : '';
45 $ENV{TERMPATH} = $home . '/etc/termcap:/usr/share/misc/termcap'
46 . ':/usr/share/lib/termcap';
48 # Fall back on a hard-coded terminal speed if POSIX::Termios isn't
49 # available (such as on VMS).
50 eval { $termios = POSIX::Termios->new };
55 $ospeed = $termios->getospeed || 9600;
58 # Fall back on the ANSI escape sequences if Term::Cap doesn't work.
59 eval { $term = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed } };
60 $$self{BOLD} = $$term{_md} || "\e[1m";
61 $$self{UNDL} = $$term{_us} || "\e[4m";
62 $$self{NORM} = $$term{_me} || "\e[m";
64 unless (defined $$self{width}) {
65 $$self{opt_width} = $ENV{COLUMNS} || $$term{_co} || 80;
66 $$self{opt_width} -= 2;
72 # Make level one headings bold.
74 my ($self, $attrs, $text) = @_;
76 $self->SUPER::cmd_head1 ($attrs, "$$self{BOLD}$text$$self{NORM}");
79 # Make level two headings bold.
81 my ($self, $attrs, $text) = @_;
83 $self->SUPER::cmd_head2 ($attrs, "$$self{BOLD}$text$$self{NORM}");
86 # Fix up B<> and I<>. Note that we intentionally don't do F<>.
87 sub cmd_b { my $self = shift; return "$$self{BOLD}$_[1]$$self{NORM}" }
88 sub cmd_i { my $self = shift; return "$$self{UNDL}$_[1]$$self{NORM}" }
90 # Output any included code in bold.
92 my ($self, $code) = @_;
93 $self->output ($$self{BOLD} . $code . $$self{NORM});
96 # Override the wrapping code to igore the special sequences.
101 my $spaces = ' ' x $$self{MARGIN};
102 my $width = $$self{opt_width} - $$self{MARGIN};
104 # $codes matches a single special sequence. $char matches any number of
105 # special sequences preceeding a single character other than a newline.
106 # We have to do $shortchar and $longchar in variables because the
107 # construct ${char}{0,$width} didn't do the right thing until Perl 5.8.x.
108 my $codes = "(?:\Q$$self{BOLD}\E|\Q$$self{UNDL}\E|\Q$$self{NORM}\E)";
109 my $char = "(?:$codes*[^\\n])";
110 my $shortchar = $char . "{0,$width}";
111 my $longchar = $char . "{$width}";
112 while (length > $width) {
113 if (s/^($shortchar)\s+// || s/^($longchar)//) {
114 $output .= $spaces . $1 . "\n";
119 $output .= $spaces . $_;
120 $output =~ s/\s+$/\n\n/;
124 ##############################################################################
125 # Module return value and documentation
126 ##############################################################################
133 Pod::Text::Termcap - Convert POD data to ASCII text with format escapes
136 ECMA-48 VT100 Allbery
140 use Pod::Text::Termcap;
141 my $parser = Pod::Text::Termcap->new (sentence => 0, width => 78);
143 # Read POD from STDIN and write to STDOUT.
144 $parser->parse_from_filehandle;
146 # Read POD from file.pod and write to file.txt.
147 $parser->parse_from_file ('file.pod', 'file.txt');
151 Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
152 text using the correct termcap escape sequences for the current terminal.
153 Apart from the format codes, it in all ways functions like Pod::Text. See
154 L<Pod::Text> for details and available options.
158 This module uses Term::Cap to retrieve the formatting escape sequences for
159 the current terminal, and falls back on the ECMA-48 (the same in this
160 regard as ANSI X3.64 and ISO 6429, the escape codes also used by DEC VT100
161 terminals) if the bold, underline, and reset codes aren't set in the
166 L<Pod::Text>, L<Pod::Simple>, L<Term::Cap>
168 The current version of this module is always available from its web site at
169 L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
170 Perl core distribution as of 5.6.0.
174 Russ Allbery <rra@stanford.edu>.
176 =head1 COPYRIGHT AND LICENSE
178 Copyright 1999, 2001, 2002, 2004, 2006, 2008 Russ Allbery
181 This program is free software; you may redistribute it and/or modify it
182 under the same terms as Perl itself.