Cap.pm revision 7c478bd95313f5f23a4c958a745db2134aa03244
use Carp;
# Last updated: Thu Dec 14 20:02:42 CST 1995 by sanders@bsdi.com
# TODO:
# support Berkeley DB termcaps
# should probably be a .xs module
# force $FH into callers package?
# keep $FH in object at Tgetent time?
=head1 NAME
Term::Cap - Perl termcap interface
=head1 SYNOPSIS
require Term::Cap;
$terminal = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };
$terminal->Tgoto('cm', $col, $row, $FH);
$terminal->Tputs('dl', $count, $FH);
$terminal->Tpad($string, $count, $FH);
=head1 DESCRIPTION
These are low-level functions to extract and use capabilities from
a terminal capability (termcap) database.
The B<Tgetent> function extracts the entry of the specified terminal
type I<TERM> (defaults to the environment variable I<TERM>) from the
database.
It will look in the environment for a I<TERMCAP> variable. If
found, and the value does not begin with a slash, and the terminal
type name is the same as the environment string I<TERM>, the
I<TERMCAP> string is used instead of reading a termcap file. If
it does begin with a slash, the string is used as a path name of
the termcap file to search. If I<TERMCAP> does not begin with a
slash and name is different from I<TERM>, B<Tgetent> searches the
in that order, unless the environment variable I<TERMPATH> exists,
in which case it specifies a list of file pathnames (separated by
spaces or colons) to be searched B<instead>. Whenever multiple
files are searched and a tc field occurs in the requested entry,
the entry it names must be found in the same file or one of the
succeeding files. If there is a C<:tc=...:> in the I<TERMCAP>
environment variable string it will continue the search in the
files as above.
I<OSPEED> is the terminal output bit rate (often mistakenly called
the baud rate). I<OSPEED> can be specified as either a POSIX
BSD-style speeds (where 13 equals 9600).
B<Tgetent> returns a blessed object reference which the user can
then use to send the control strings to the terminal using B<Tputs>
and B<Tgoto>. It calls C<croak> on failure.
B<Tgoto> decodes a cursor addressing string with the given parameters.
The output strings for B<Tputs> are cached for counts of 1 for performance.
B<Tgoto> and B<Tpad> do not cache. C<$self-E<gt>{_xx}> is the raw termcap
data and C<$self-E<gt>{xx}> is the cached version.
print $terminal->Tpad($self->{_xx}, 1);
B<Tgoto>, B<Tputs>, and B<Tpad> return the string and will also
output the string to $FH if specified.
The extracted termcap entry is available in the object
as C<$self-E<gt>{TERMCAP}>.
=head1 EXAMPLES
# Get terminal output speed
require POSIX;
my $termios = new POSIX::Termios;
$termios->getattr;
my $ospeed = $termios->getospeed;
# Old-style ioctl code to get ospeed:
# require 'ioctl.pl';
# ioctl(TTY,$TIOCGETP,$sgtty);
# ($ispeed,$ospeed) = unpack('cc',$sgtty);
# allocate and initialize a terminal structure
$terminal = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };
# require certain capabilities to be available
# Output Routines, if $FH is undefined these just return the string
# Tgoto does the % expansion stuff with the given args
$terminal->Tgoto('cm', $col, $row, $FH);
# Tputs doesn't do any % expansion.
$terminal->Tputs('dl', $count = 1, $FH);
=cut
# Returns a list of termcap files to check.
sub termcap_path { ## private
my @termcap_path;
# $TERMCAP, if it's a filespec
(($^O eq 'os2' || $^O eq 'MSWin32' || $^O eq 'dos')
# Add the users $TERMPATH
}
else {
# Defaults
push(@termcap_path,
);
}
# return the list of those termcaps that exist
grep(-f, @termcap_path);
}
sub Tgetent { ## public -- static method
my $class = shift;
local $_;
# Compute PADDING factor from OSPEED (to be used by Tpad)
carp "OSPEED was not set, defaulting to 9600";
}
# delays for old style speeds
}
else {
}
# $tmp_term is always the next term (possibly :tc=...:) we are looking for
# protect any pattern metacharacters in $tmp_term
# $entry is the extracted termcap entry
}
my @termcap_path = termcap_path;
# 1 == next file
# 2 == search again
if ($entry) {
# ok, we're starting with $TERMCAP
$first++; # we're the first entry
# do we need to continue?
$tmp_term = $1;
# protect any pattern metacharacters in $tmp_term
}
else {
}
}
# This is eval'ed inside the while loop for each file
$search = q{
while (<TERMCAP>) {
next if /^\\t/ || /^#/;
if ($_ =~ m/(^|\\|)${termpat}[:|]/o) {
chomp;
s/^[^:]*:// if $first++;
$state = 0;
while ($_ =~ s/\\\\$//) {
defined(my $x = <TERMCAP>) or last;
$_ .= $x; chomp;
}
last;
}
}
$entry .= $_;
};
while ($state != 0) {
if ($state == 1) {
# get the next TERMCAP
$TERMCAP = shift @termcap_path
|| croak "failed termcap lookup on $tmp_term";
}
else {
# do the same file again
# prevent endless recursion
$max-- || croak "failed termcap loop at $tmp_term";
}
eval $search;
die $@ if $@;
close TERMCAP;
# If :tc=...: found then search this file again
# protect any pattern metacharacters in $tmp_term
}
$entry =~ s/:+\s*:+/:/g; # cleanup $entry
$entry =~ s/:+/:/g; # cleanup $entry
# print STDERR "DEBUG: $entry = ", $entry, "\n";
# Precompile $entry into the object
$entry =~ s/^[^:]*://;
if ($field =~ /^(\w\w)$/) {
# print STDERR "DEBUG: flag $1\n";
}
elsif ($field =~ /^(\w\w)\@/) {
# print STDERR "DEBUG: unset $1\n";
}
elsif ($field =~ /^(\w\w)#(.*)/) {
# print STDERR "DEBUG: numeric $1 = $2\n";
}
elsif ($field =~ /^(\w\w)=(.*)/) {
# print STDERR "DEBUG: string $1 = $2\n";
$_ = $2;
s/\\E/\033/g;
s/\\n/\n/g;
s/\\r/\r/g;
s/\\t/\t/g;
s/\\b/\b/g;
s/\\f/\f/g;
s/\\\^/\377/g;
s/\^\?/\177/g;
s/\\(.)/$1/g;
s/\377/^/g;
}
# else { carp "junk in $term ignored: $field"; }
}
$self;
}
# $terminal->Tpad($string, $cnt, $FH);
sub Tpad { ## public
my $self = shift;
$ms = $1;
$string = $3;
if ($decr > .1) {
}
}
$string;
}
# $terminal->Tputs($cap, $cnt, $FH);
sub Tputs { ## public
my $self = shift;
my $string;
if ($cnt > 1) {
} else {
# cache result because Tpad can be slow
}
$string;
}
# %% output `%'
# %d output value as in printf %d
# %2 output value as in printf %2d
# %3 output value as in printf %3d
# %. output value as in printf %c
# %+x add x to value, then do %.
#
# %>xy if value > x then add y, no output
# %r reverse order of two parameters, no output
# %i increment by one, no output
# %B BCD (16*(value/10)) + (value%10), no output
#
# %n exclusive-or all parameters with 0140 (Datamedia 2500)
# %D Reverse coding (value - 2*(value%16)), no output (Delta Data)
#
# $terminal->Tgoto($cap, $col, $row, $FH);
sub Tgoto { ## public
my $self = shift;
my $result = '';
my $after = '';
my $online = 0;
while ($string =~ /^([^%]*)%(.)(.*)/) {
$result .= $1;
$code = $2;
$string = $3;
if ($code eq 'd') {
}
elsif ($code eq '.') {
if ($online) {
}
else {
}
}
}
elsif ($code eq '+') {
}
elsif ($code eq 'r') {
}
elsif ($code eq '>') {
}
}
elsif ($code eq '2') {
}
elsif ($code eq '3') {
}
elsif ($code eq 'i') {
}
else {
return "OOPS";
}
}
$string;
}
sub Trequire { ## public
my $self = shift;
foreach $cap (@_) {
}
croak "Terminal does not support: (@undefined)" if @undefined;
}
1;