143 lines
4.0 KiB
Perl
143 lines
4.0 KiB
Perl
# Pod::Text::Termcap -- Convert POD data to ASCII text with format escapes.
|
|
# $Id: Termcap.pm,v 0.4 1999/09/20 10:17:45 eagle Exp $
|
|
#
|
|
# Copyright 1999 by Russ Allbery <rra@stanford.edu>
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify it
|
|
# under the same terms as Perl itself.
|
|
#
|
|
# This is a simple subclass of Pod::Text that overrides a few key methods to
|
|
# output the right termcap escape sequences for formatted text on the
|
|
# current terminal type.
|
|
|
|
############################################################################
|
|
# Modules and declarations
|
|
############################################################################
|
|
|
|
package Pod::Text::Termcap;
|
|
|
|
require 5.004;
|
|
|
|
use Pod::Text ();
|
|
use POSIX ();
|
|
use Term::Cap;
|
|
|
|
use strict;
|
|
use vars qw(@ISA $VERSION);
|
|
|
|
@ISA = qw(Pod::Text);
|
|
|
|
# Use the CVS revision of this file as its version number.
|
|
($VERSION = (split (' ', q$Revision: 0.4 $ ))[1]) =~ s/\.(\d)$/.0$1/;
|
|
|
|
|
|
############################################################################
|
|
# Overrides
|
|
############################################################################
|
|
|
|
# In the initialization method, grab our terminal characteristics as well as
|
|
# do all the stuff we normally do.
|
|
sub initialize {
|
|
my $self = shift;
|
|
|
|
# The default Term::Cap path won't work on Solaris.
|
|
$ENV{TERMPATH} = "$ENV{HOME}/.termcap:/etc/termcap"
|
|
. ":/usr/share/misc/termcap:/usr/share/lib/termcap";
|
|
|
|
my $termios = POSIX::Termios->new;
|
|
$termios->getattr;
|
|
my $ospeed = $termios->getospeed;
|
|
my $term = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };
|
|
$$self{BOLD} = $$term{_md} or die 'BOLD';
|
|
$$self{UNDL} = $$term{_us} or die 'UNDL';
|
|
$$self{NORM} = $$term{_me} or die 'NORM';
|
|
|
|
unless (defined $$self{width}) {
|
|
$$self{width} = $ENV{COLUMNS} || $$term{_co} || 78;
|
|
$$self{width} -= 2;
|
|
}
|
|
|
|
$self->SUPER::initialize;
|
|
}
|
|
|
|
# Make level one headings bold.
|
|
sub cmd_head1 {
|
|
my $self = shift;
|
|
local $_ = shift;
|
|
s/\s+$//;
|
|
$self->SUPER::cmd_head1 ("$$self{BOLD}$_$$self{NORM}");
|
|
}
|
|
|
|
# Make level two headings bold.
|
|
sub cmd_head2 {
|
|
my $self = shift;
|
|
local $_ = shift;
|
|
s/\s+$//;
|
|
$self->SUPER::cmd_head2 ("$$self{BOLD}$_$$self{NORM}");
|
|
}
|
|
|
|
# Fix up B<> and I<>. Note that we intentionally don't do F<>.
|
|
sub seq_b { my $self = shift; return "$$self{BOLD}$_[0]$$self{NORM}" }
|
|
sub seq_i { my $self = shift; return "$$self{UNDL}$_[0]$$self{NORM}" }
|
|
|
|
# Override the wrapping code to igore the special sequences.
|
|
sub wrap {
|
|
my $self = shift;
|
|
local $_ = shift;
|
|
my $output = '';
|
|
my $spaces = ' ' x $$self{MARGIN};
|
|
my $width = $$self{width} - $$self{MARGIN};
|
|
my $code = "(?:\Q$$self{BOLD}\E|\Q$$self{UNDL}\E|\Q$$self{NORM}\E)";
|
|
while (length > $width) {
|
|
if (s/^((?:$code?[^\n]){0,$width})\s+//
|
|
|| s/^((?:$code?[^\n]){$width})//) {
|
|
$output .= $spaces . $1 . "\n";
|
|
} else {
|
|
last;
|
|
}
|
|
}
|
|
$output .= $spaces . $_;
|
|
$output =~ s/\s+$/\n\n/;
|
|
$output;
|
|
}
|
|
|
|
|
|
############################################################################
|
|
# Module return value and documentation
|
|
############################################################################
|
|
|
|
1;
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
Pod::Text::Color - Convert POD data to ASCII text with format escapes
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use Pod::Text::Termcap;
|
|
my $parser = Pod::Text::Termcap->new (sentence => 0, width => 78);
|
|
|
|
# Read POD from STDIN and write to STDOUT.
|
|
$parser->parse_from_filehandle;
|
|
|
|
# Read POD from file.pod and write to file.txt.
|
|
$parser->parse_from_file ('file.pod', 'file.txt');
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
|
|
text using the correct termcap escape sequences for the current terminal.
|
|
Apart from the format codes, it in all ways functions like Pod::Text. See
|
|
L<Pod::Text> for details and available options.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<Pod::Text|Pod::Text>, L<Pod::Parser|Pod::Parser>
|
|
|
|
=head1 AUTHOR
|
|
|
|
Russ Allbery E<lt>rra@stanford.eduE<gt>.
|
|
|
|
=cut
|