[perl5.git] / lib / Term / Cap.pm

package Term::Cap;
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->Trequire(qw/ce ku kd/);
    $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
files F<$HOME/.termcap>, F</etc/termcap>, and F</usr/share/misc/termcap>,
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
termios/SYSV termio speeds (where 9600 equals 9600) or an old
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
    $terminal->Trequire(qw/ce ku kd/);

    # 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
    push(@termcap_path, $ENV{TERMCAP})
	if ((exists $ENV{TERMCAP}) &&
	    (($^O eq 'os2' || $^O eq 'MSWin32' || $^O eq 'dos')
	     ? $ENV{TERMCAP} =~ /^[a-z]:[\\\/]/is
	     : $ENV{TERMCAP} =~ /^\//s));
    if ((exists $ENV{TERMPATH}) && ($ENV{TERMPATH})) {
	# Add the users $TERMPATH
	push(@termcap_path, split(/(:|\s+)/, $ENV{TERMPATH}))
    }
    else {
	# Defaults
	push(@termcap_path,
	    $ENV{'HOME'} . '/.termcap',
	    '/etc/termcap',
	    '/usr/share/misc/termcap',
	);
    }
    # return the list of those termcaps that exist
    grep(-f, @termcap_path);
}

sub Tgetent { ## public -- static method
    my $class = shift;
    my $self = bless shift, $class;
    my($term,$cap,$search,$field,$max,$tmp_term,$TERMCAP);
    local($termpat,$state,$first,$entry);	# used inside eval
    local $_;

    # Compute PADDING factor from OSPEED (to be used by Tpad)
    if (! $self->{OSPEED}) {
	carp "OSPEED was not set, defaulting to 9600";
	$self->{OSPEED} = 9600;
    }
    if ($self->{OSPEED} < 16) {
	# delays for old style speeds
	my @pad = (0,200,133.3,90.9,74.3,66.7,50,33.3,16.7,8.3,5.5,4.1,2,1,.5,.2);
	$self->{PADDING} = $pad[$self->{OSPEED}];
    }
    else {
	$self->{PADDING} = 10000 / $self->{OSPEED};
    }

    $self->{TERM} = ($self->{TERM} || $ENV{TERM} || croak "TERM not set");
    $term = $self->{TERM};	# $term is the term type we are looking for

    # $tmp_term is always the next term (possibly :tc=...:) we are looking for
    $tmp_term = $self->{TERM};
    # protect any pattern metacharacters in $tmp_term 
    $termpat = $tmp_term; $termpat =~ s/(\W)/\\$1/g;

    my $foo = (exists $ENV{TERMCAP} ? $ENV{TERMCAP} : '');

    # $entry is the extracted termcap entry
    if (($foo !~ m:^/:s) && ($foo =~ m/(^|\|)${termpat}[:|]/s)) {
	$entry = $foo;
    }

    my @termcap_path = termcap_path;
    croak "Can't find a valid termcap file" unless @termcap_path || $entry;

    $state = 1;					# 0 == finished
						# 1 == next file
						# 2 == search again

    $first = 0;					# first entry (keeps term name)

    $max = 32;					# max :tc=...:'s

    if ($entry) {
	# ok, we're starting with $TERMCAP
	$first++;				# we're the first entry
	# do we need to continue?
	if ($entry =~ s/:tc=([^:]+):/:/) {
	    $tmp_term = $1;
	    # protect any pattern metacharacters in $tmp_term 
	    $termpat = $tmp_term; $termpat =~ s/(\W)/\\$1/g;
	}
	else {
	    $state = 0;				# we're already finished
	}
    }

    # 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;
	    }
	}
	defined $entry or $entry = '';
	$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";
	    $state = 1;		# ok, maybe do a new file next time
	}

	open(TERMCAP,"< $TERMCAP\0") || croak "open $TERMCAP: $!";
	eval $search;
	die $@ if $@;
	close TERMCAP;

	# If :tc=...: found then search this file again
	$entry =~ s/:tc=([^:]+):/:/ && ($tmp_term = $1, $state = 2);
	# protect any pattern metacharacters in $tmp_term 
	$termpat = $tmp_term; $termpat =~ s/(\W)/\\$1/g;
    }

    croak "Can't find $term" if $entry eq '';
    $entry =~ s/:+\s*:+/:/g;				# cleanup $entry
    $entry =~ s/:+/:/g;					# cleanup $entry
    $self->{TERMCAP} = $entry;				# save it
    # print STDERR "DEBUG: $entry = ", $entry, "\n";

    # Precompile $entry into the object
    $entry =~ s/^[^:]*://;
    foreach $field (split(/:[\s:\\]*/,$entry)) {
	if ($field =~ /^(\w\w)$/) {
	    $self->{'_' . $field} = 1 unless defined $self->{'_' . $1};
	    # print STDERR "DEBUG: flag $1\n";
	}
	elsif ($field =~ /^(\w\w)\@/) {
	    $self->{'_' . $1} = "";
	    # print STDERR "DEBUG: unset $1\n";
	}
	elsif ($field =~ /^(\w\w)#(.*)/) {
	    $self->{'_' . $1} = $2 unless defined $self->{'_' . $1};
	    # print STDERR "DEBUG: numeric $1 = $2\n";
	}
	elsif ($field =~ /^(\w\w)=(.*)/) {
	    # print STDERR "DEBUG: string $1 = $2\n";
	    next if defined $self->{'_' . ($cap = $1)};
	    $_ = $2;
	    s/\\E/\033/g;
	    s/\\(\d\d\d)/pack('c',oct($1) & 0177)/eg;
	    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/\^(.)/pack('c',ord($1) & 31)/eg;
	    s/\\(.)/$1/g;
	    s/\377/^/g;
	    $self->{'_' . $cap} = $_;
	}
	# else { carp "junk in $term ignored: $field"; }
    }
    $self->{'_pc'} = "\0" unless defined $self->{'_pc'};
    $self->{'_bc'} = "\b" unless defined $self->{'_bc'};
    $self;
}

# $terminal->Tpad($string, $cnt, $FH);
sub Tpad { ## public
    my $self = shift;
    my($string, $cnt, $FH) = @_;
    my($decr, $ms);

    if ($string =~ /(^[\d.]+)(\*?)(.*)$/) {
	$ms = $1;
	$ms *= $cnt if $2;
	$string = $3;
	$decr = $self->{PADDING};
	if ($decr > .1) {
	    $ms += $decr / 2;
	    $string .= $self->{'_pc'} x ($ms / $decr);
	}
    }
    print $FH $string if $FH;
    $string;
}

# $terminal->Tputs($cap, $cnt, $FH);
sub Tputs { ## public
    my $self = shift;
    my($cap, $cnt, $FH) = @_;
    my $string;

    if ($cnt > 1) {
	$string = Tpad($self, $self->{'_' . $cap}, $cnt);
    } else {
	# cache result because Tpad can be slow
	$string = defined $self->{$cap} ? $self->{$cap} :
	    ($self->{$cap} = Tpad($self, $self->{'_' . $cap}, 1));
    }
    print $FH $string if $FH;
    $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($cap, $code, $tmp, $FH) = @_;
    my $string = $self->{'_' . $cap};
    my $result = '';
    my $after = '';
    my $online = 0;
    my @tmp = ($tmp,$code);
    my $cnt = $code;

    while ($string =~ /^([^%]*)%(.)(.*)/) {
	$result .= $1;
	$code = $2;
	$string = $3;
	if ($code eq 'd') {
	    $result .= sprintf("%d",shift(@tmp));
	}
	elsif ($code eq '.') {
	    $tmp = shift(@tmp);
	    if ($tmp == 0 || $tmp == 4 || $tmp == 10) {
		if ($online) {
		    ++$tmp, $after .= $self->{'_up'} if $self->{'_up'};
		}
		else {
		    ++$tmp, $after .= $self->{'_bc'};
		}
	    }
	    $result .= sprintf("%c",$tmp);
	    $online = !$online;
	}
	elsif ($code eq '+') {
	    $result .= sprintf("%c",shift(@tmp)+ord($string));
	    $string = substr($string,1,99);
	    $online = !$online;
	}
	elsif ($code eq 'r') {
	    ($code,$tmp) = @tmp;
	    @tmp = ($tmp,$code);
	    $online = !$online;
	}
	elsif ($code eq '>') {
	    ($code,$tmp,$string) = unpack("CCa99",$string);
	    if ($tmp[$[] > $code) {
		$tmp[$[] += $tmp;
	    }
	}
	elsif ($code eq '2') {
	    $result .= sprintf("%02d",shift(@tmp));
	    $online = !$online;
	}
	elsif ($code eq '3') {
	    $result .= sprintf("%03d",shift(@tmp));
	    $online = !$online;
	}
	elsif ($code eq 'i') {
	    ($code,$tmp) = @tmp;
	    @tmp = ($code+1,$tmp+1);
	}
	else {
	    return "OOPS";
	}
    }
    $string = Tpad($self, $result . $string . $after, $cnt);
    print $FH $string if $FH;
    $string;
}

# $terminal->Trequire(qw/ce ku kd/);
sub Trequire { ## public
    my $self = shift;
    my($cap,@undefined);
    foreach $cap (@_) {
	push(@undefined, $cap)
	    unless defined $self->{'_' . $cap} && $self->{'_' . $cap};
    }
    croak "Terminal does not support: (@undefined)" if @undefined;
}

1;
Commit	Line	Data
a0d0e21e	1	package Term::Cap;
cb1a09d0	2	use Carp;
85e6fe83	3
cb1a09d0	4	# Last updated: Thu Dec 14 20:02:42 CST 1995 by sanders@bsdi.com
a687059c	5
cb1a09d0 AD	6	# TODO:
	7	# support Berkeley DB termcaps
	8	# should probably be a .xs module
	9	# force $FH into callers package?
	10	# keep $FH in object at Tgetent time?
	11
	12	=head1 NAME
	13
	14	Term::Cap - Perl termcap interface
	15
	16	=head1 SYNOPSIS
	17
	18	require Term::Cap;
	19	$terminal = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };
	20	$terminal->Trequire(qw/ce ku kd/);
	21	$terminal->Tgoto('cm', $col, $row, $FH);
	22	$terminal->Tputs('dl', $count, $FH);
	23	$terminal->Tpad($string, $count, $FH);
	24
	25	=head1 DESCRIPTION
	26
	27	These are low-level functions to extract and use capabilities from
	28	a terminal capability (termcap) database.
	29
	30	The B<Tgetent> function extracts the entry of the specified terminal
	31	type I<TERM> (defaults to the environment variable I<TERM>) from the
	32	database.
	33
	34	It will look in the environment for a I<TERMCAP> variable. If
	35	found, and the value does not begin with a slash, and the terminal
	36	type name is the same as the environment string I<TERM>, the
	37	I<TERMCAP> string is used instead of reading a termcap file. If
	38	it does begin with a slash, the string is used as a path name of
	39	the termcap file to search. If I<TERMCAP> does not begin with a
	40	slash and name is different from I<TERM>, B<Tgetent> searches the
	41	files F<$HOME/.termcap>, F</etc/termcap>, and F</usr/share/misc/termcap>,
	42	in that order, unless the environment variable I<TERMPATH> exists,
	43	in which case it specifies a list of file pathnames (separated by
	44	spaces or colons) to be searched B<instead>. Whenever multiple
	45	files are searched and a tc field occurs in the requested entry,
	46	the entry it names must be found in the same file or one of the
	47	succeeding files. If there is a C<:tc=...:> in the I<TERMCAP>
	48	environment variable string it will continue the search in the
	49	files as above.
	50
	51	I<OSPEED> is the terminal output bit rate (often mistakenly called
	52	the baud rate). I<OSPEED> can be specified as either a POSIX
	53	termios/SYSV termio speeds (where 9600 equals 9600) or an old
	54	BSD-style speeds (where 13 equals 9600).
	55
	56	B<Tgetent> returns a blessed object reference which the user can
	57	then use to send the control strings to the terminal using B<Tputs>
	58	and B<Tgoto>. It calls C<croak> on failure.
	59
	60	B<Tgoto> decodes a cursor addressing string with the given parameters.
	61
	62	The output strings for B<Tputs> are cached for counts of 1 for performance.
	63	B<Tgoto> and B<Tpad> do not cache. C<$self-E<gt>{_xx}> is the raw termcap
	64	data and C<$self-E<gt>{xx}> is the cached version.
	65
	66	print $terminal->Tpad($self->{_xx}, 1);
	67
	68	B<Tgoto>, B<Tputs>, and B<Tpad> return the string and will also
	69	output the string to $FH if specified.
70
71	The extracted termcap entry is available in the object
72	as C<$self-E<gt>{TERMCAP}>.
73
74	=head1 EXAMPLES
75
76	# Get terminal output speed
77	require POSIX;
78	my $termios = new POSIX::Termios;
79	$termios->getattr;
80	my $ospeed = $termios->getospeed;
81
82	# Old-style ioctl code to get ospeed:
83	# require 'ioctl.pl';
84	# ioctl(TTY,$TIOCGETP,$sgtty);
85	# ($ispeed,$ospeed) = unpack('cc',$sgtty);
86
87	# allocate and initialize a terminal structure
88	$terminal = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };
89
90	# require certain capabilities to be available
91	$terminal->Trequire(qw/ce ku kd/);
92
93	# Output Routines, if $FH is undefined these just return the string
94
95	# Tgoto does the % expansion stuff with the given args
96	$terminal->Tgoto('cm', $col, $row, $FH);
97
98	# Tputs doesn't do any % expansion.
99	$terminal->Tputs('dl', $count = 1, $FH);
100
101	=cut
102
103	# Returns a list of termcap files to check.
104	sub termcap_path { ## private
105	my @termcap_path;
106	# $TERMCAP, if it's a filespec
7a2e2cd6	107	push(@termcap_path, $ENV{TERMCAP})
7a2e2cd6	108	if ((exists $ENV{TERMCAP}) &&
39e571d4	109	(($^O eq 'os2' \|\| $^O eq 'MSWin32' \|\| $^O eq 'dos')
fe6f1558 GS	110	? $ENV{TERMCAP} =~ /^[a-z]:[\\\/]/is
fe6f1558 GS	111	: $ENV{TERMCAP} =~ /^\//s));
c07a80fd	112	if ((exists $ENV{TERMPATH}) && ($ENV{TERMPATH})) {
cb1a09d0 AD	113	# Add the users $TERMPATH
	114	push(@termcap_path, split(/(:\|\s+)/, $ENV{TERMPATH}))
	115	}
	116	else {
	117	# Defaults
	118	push(@termcap_path,
	119	$ENV{'HOME'} . '/.termcap',
	120	'/etc/termcap',
	121	'/usr/share/misc/termcap',
	122	);
a687059c	123	}
cb1a09d0	124	# return the list of those termcaps that exist
748a9306 LW	125	grep(-f, @termcap_path);
	126	}
	127
cb1a09d0 AD	128	sub Tgetent { ## public -- static method
	129	my $class = shift;
	130	my $self = bless shift, $class;
	131	my($term,$cap,$search,$field,$max,$tmp_term,$TERMCAP);
	132	local($termpat,$state,$first,$entry); # used inside eval
	133	local $_;
	134
	135	# Compute PADDING factor from OSPEED (to be used by Tpad)
	136	if (! $self->{OSPEED}) {
	137	carp "OSPEED was not set, defaulting to 9600";
	138	$self->{OSPEED} = 9600;
	139	}
	140	if ($self->{OSPEED} < 16) {
	141	# delays for old style speeds
	142	my @pad = (0,200,133.3,90.9,74.3,66.7,50,33.3,16.7,8.3,5.5,4.1,2,1,.5,.2);
	143	$self->{PADDING} = $pad[$self->{OSPEED}];
	144	}
	145	else {
	146	$self->{PADDING} = 10000 / $self->{OSPEED};
	147	}
	148
	149	$self->{TERM} = ($self->{TERM} \|\| $ENV{TERM} \|\| croak "TERM not set");
	150	$term = $self->{TERM}; # $term is the term type we are looking for
	151
	152	# $tmp_term is always the next term (possibly :tc=...:) we are looking for
	153	$tmp_term = $self->{TERM};
	154	# protect any pattern metacharacters in $tmp_term
	155	$termpat = $tmp_term; $termpat =~ s/(\W)/\\$1/g;
	156
c07a80fd	157	my $foo = (exists $ENV{TERMCAP} ? $ENV{TERMCAP} : '');
cb1a09d0 AD	158
cb1a09d0 AD	159	# $entry is the extracted termcap entry
fe6f1558	160	if (($foo !~ m:^/:s) && ($foo =~ m/(^\|\\|)${termpat}[:\|]/s)) {
cb1a09d0 AD	161	$entry = $foo;
	162	}
	163
	164	my @termcap_path = termcap_path;
	165	croak "Can't find a valid termcap file" unless @termcap_path \|\| $entry;
	166
	167	$state = 1; # 0 == finished
	168	# 1 == next file
	169	# 2 == search again
	170
	171	$first = 0; # first entry (keeps term name)
	172
	173	$max = 32; # max :tc=...:'s
	174
	175	if ($entry) {
	176	# ok, we're starting with $TERMCAP
	177	$first++; # we're the first entry
	178	# do we need to continue?
	179	if ($entry =~ s/:tc=([^:]+):/:/) {
	180	$tmp_term = $1;
	181	# protect any pattern metacharacters in $tmp_term
	182	$termpat = $tmp_term; $termpat =~ s/(\W)/\\$1/g;
	183	}
	184	else {
	185	$state = 0; # we're already finished
	186	}
	187	}
	188
	189	# This is eval'ed inside the while loop for each file
	190	$search = q{
54310121	191	while (<TERMCAP>) {
cb1a09d0 AD	192	next if /^\\t/ \|\| /^#/;
	193	if ($_ =~ m/(^\|\\\|)${termpat}[:\|]/o) {
	194	chomp;
	195	s/^[^:]*:// if $first++;
	196	$state = 0;
54310121	197	while ($_ =~ s/\\\\$//) {
	198	defined(my $x = <TERMCAP>) or last;
	199	$_ .= $x; chomp;
	200	}
cb1a09d0	201	last;
748a9306	202	}
cb1a09d0	203	}
55497cff	204	defined $entry or $entry = '';
55497cff	205	$entry .= $_;
cb1a09d0	206	};
748a9306	207
cb1a09d0 AD	208	while ($state != 0) {
	209	if ($state == 1) {
	210	# get the next TERMCAP
	211	$TERMCAP = shift @termcap_path
	212	\|\| croak "failed termcap lookup on $tmp_term";
	213	}
	214	else {
	215	# do the same file again
	216	# prevent endless recursion
	217	$max-- \|\| croak "failed termcap loop at $tmp_term";
	218	$state = 1; # ok, maybe do a new file next time
	219	}
	220
	221	open(TERMCAP,"< $TERMCAP\0") \|\| croak "open $TERMCAP: $!";
	222	eval $search;
	223	die $@ if $@;
	224	close TERMCAP;
	225
	226	# If :tc=...: found then search this file again
	227	$entry =~ s/:tc=([^:]+):/:/ && ($tmp_term = $1, $state = 2);
	228	# protect any pattern metacharacters in $tmp_term
	229	$termpat = $tmp_term; $termpat =~ s/(\W)/\\$1/g;
a687059c	230	}
cb1a09d0 AD	231
	232	croak "Can't find $term" if $entry eq '';
	233	$entry =~ s/:+\s*:+/:/g; # cleanup $entry
	234	$entry =~ s/:+/:/g; # cleanup $entry
	235	$self->{TERMCAP} = $entry; # save it
	236	# print STDERR "DEBUG: $entry = ", $entry, "\n";
a687059c	237
748a9306	238	# Precompile $entry into the object
cb1a09d0	239	$entry =~ s/^[^:]*://;
748a9306	240	foreach $field (split(/:[\s:\\]*/,$entry)) {
cb1a09d0 AD	241	if ($field =~ /^(\w\w)$/) {
	242	$self->{'_' . $field} = 1 unless defined $self->{'_' . $1};
	243	# print STDERR "DEBUG: flag $1\n";
748a9306 LW	244	}
748a9306 LW	245	elsif ($field =~ /^(\w\w)\@/) {
cb1a09d0 AD	246	$self->{'_' . $1} = "";
cb1a09d0 AD	247	# print STDERR "DEBUG: unset $1\n";
a687059c LW	248	}
a687059c LW	249	elsif ($field =~ /^(\w\w)#(.*)/) {
cb1a09d0 AD	250	$self->{'_' . $1} = $2 unless defined $self->{'_' . $1};
cb1a09d0 AD	251	# print STDERR "DEBUG: numeric $1 = $2\n";
a687059c LW	252	}
a687059c LW	253	elsif ($field =~ /^(\w\w)=(.*)/) {
cb1a09d0 AD	254	# print STDERR "DEBUG: string $1 = $2\n";
cb1a09d0 AD	255	next if defined $self->{'_' . ($cap = $1)};
a687059c LW	256	$_ = $2;
a687059c LW	257	s/\\E/\033/g;
ecfc5424	258	s/\\(\d\d\d)/pack('c',oct($1) & 0177)/eg;
a687059c LW	259	s/\\n/\n/g;
	260	s/\\r/\r/g;
	261	s/\\t/\t/g;
	262	s/\\b/\b/g;
	263	s/\\f/\f/g;
	264	s/\\\^/\377/g;
	265	s/\^\?/\177/g;
63f2c1e1	266	s/\^(.)/pack('c',ord($1) & 31)/eg;
a687059c LW	267	s/\\(.)/$1/g;
a687059c LW	268	s/\377/^/g;
cb1a09d0	269	$self->{'_' . $cap} = $_;
a687059c	270	}
cb1a09d0	271	# else { carp "junk in $term ignored: $field"; }
a687059c	272	}
cb1a09d0 AD	273	$self->{'_pc'} = "\0" unless defined $self->{'_pc'};
	274	$self->{'_bc'} = "\b" unless defined $self->{'_bc'};
	275	$self;
a687059c LW	276	}
a687059c LW	277
cb1a09d0 AD	278	# $terminal->Tpad($string, $cnt, $FH);
	279	sub Tpad { ## public
	280	my $self = shift;
	281	my($string, $cnt, $FH) = @_;
	282	my($decr, $ms);
a687059c	283
a687059c LW	284	if ($string =~ /(^[\d.]+)(\?)(.)$/) {
a687059c LW	285	$ms = $1;
748a9306	286	$ms *= $cnt if $2;
a687059c	287	$string = $3;
cb1a09d0	288	$decr = $self->{PADDING};
a687059c LW	289	if ($decr > .1) {
a687059c LW	290	$ms += $decr / 2;
cb1a09d0	291	$string .= $self->{'_pc'} x ($ms / $decr);
a687059c LW	292	}
	293	}
	294	print $FH $string if $FH;
	295	$string;
	296	}
	297
cb1a09d0 AD	298	# $terminal->Tputs($cap, $cnt, $FH);
	299	sub Tputs { ## public
	300	my $self = shift;
	301	my($cap, $cnt, $FH) = @_;
	302	my $string;
748a9306 LW	303
748a9306 LW	304	if ($cnt > 1) {
cb1a09d0	305	$string = Tpad($self, $self->{'_' . $cap}, $cnt);
748a9306	306	} else {
cb1a09d0 AD	307	# cache result because Tpad can be slow
	308	$string = defined $self->{$cap} ? $self->{$cap} :
	309	($self->{$cap} = Tpad($self, $self->{'_' . $cap}, 1));
748a9306 LW	310	}
	311	print $FH $string if $FH;
	312	$string;
	313	}
	314
	315	# %% output `%'
	316	# %d output value as in printf %d
	317	# %2 output value as in printf %2d
	318	# %3 output value as in printf %3d
	319	# %. output value as in printf %c
	320	# %+x add x to value, then do %.
	321	#
	322	# %>xy if value > x then add y, no output
	323	# %r reverse order of two parameters, no output
	324	# %i increment by one, no output
	325	# %B BCD (16*(value/10)) + (value%10), no output
	326	#
	327	# %n exclusive-or all parameters with 0140 (Datamedia 2500)
	328	# %D Reverse coding (value - 2*(value%16)), no output (Delta Data)
	329	#
cb1a09d0 AD	330	# $terminal->Tgoto($cap, $col, $row, $FH);
	331	sub Tgoto { ## public
	332	my $self = shift;
	333	my($cap, $code, $tmp, $FH) = @_;
	334	my $string = $self->{'_' . $cap};
	335	my $result = '';
	336	my $after = '';
	337	my $online = 0;
	338	my @tmp = ($tmp,$code);
	339	my $cnt = $code;
748a9306	340
a687059c LW	341	while ($string =~ /^([^%])%(.)(.)/) {
	342	$result .= $1;
	343	$code = $2;
	344	$string = $3;
	345	if ($code eq 'd') {
9f68db38	346	$result .= sprintf("%d",shift(@tmp));
a687059c LW	347	}
a687059c LW	348	elsif ($code eq '.') {
9f68db38	349	$tmp = shift(@tmp);
a687059c LW	350	if ($tmp == 0 \|\| $tmp == 4 \|\| $tmp == 10) {
a687059c LW	351	if ($online) {
cb1a09d0	352	++$tmp, $after .= $self->{'_up'} if $self->{'_up'};
a687059c LW	353	}
a687059c LW	354	else {
cb1a09d0	355	++$tmp, $after .= $self->{'_bc'};
a687059c LW	356	}
	357	}
	358	$result .= sprintf("%c",$tmp);
	359	$online = !$online;
	360	}
	361	elsif ($code eq '+') {
9f68db38	362	$result .= sprintf("%c",shift(@tmp)+ord($string));
a687059c LW	363	$string = substr($string,1,99);
	364	$online = !$online;
	365	}
	366	elsif ($code eq 'r') {
9f68db38 LW	367	($code,$tmp) = @tmp;
9f68db38 LW	368	@tmp = ($tmp,$code);
a687059c LW	369	$online = !$online;
	370	}
	371	elsif ($code eq '>') {
	372	($code,$tmp,$string) = unpack("CCa99",$string);
9f68db38 LW	373	if ($tmp[$[] > $code) {
9f68db38 LW	374	$tmp[$[] += $tmp;
a687059c LW	375	}
	376	}
	377	elsif ($code eq '2') {
9f68db38	378	$result .= sprintf("%02d",shift(@tmp));
a687059c LW	379	$online = !$online;
	380	}
	381	elsif ($code eq '3') {
9f68db38	382	$result .= sprintf("%03d",shift(@tmp));
a687059c LW	383	$online = !$online;
	384	}
	385	elsif ($code eq 'i') {
9f68db38 LW	386	($code,$tmp) = @tmp;
9f68db38 LW	387	@tmp = ($code+1,$tmp+1);
a687059c LW	388	}
	389	else {
	390	return "OOPS";
	391	}
	392	}
cb1a09d0	393	$string = Tpad($self, $result . $string . $after, $cnt);
748a9306 LW	394	print $FH $string if $FH;
	395	$string;
	396	}
	397
cb1a09d0 AD	398	# $terminal->Trequire(qw/ce ku kd/);
	399	sub Trequire { ## public
	400	my $self = shift;
	401	my($cap,@undefined);
	402	foreach $cap (@_) {
	403	push(@undefined, $cap)
	404	unless defined $self->{'_' . $cap} && $self->{'_' . $cap};
748a9306	405	}
cb1a09d0	406	croak "Terminal does not support: (@undefined)" if @undefined;
a687059c LW	407	}
	408
	409	1;
cb1a09d0	410