datalab-handout/bits.h /* Copyright (C XXXXXXXXXXFree Software Foundation, Inc. This file is part of the GNU C Library. The GNU C Library is free software; you can redistribute it and/or modify it...

71_cpp_91794/Driverhdrs.pm
#
# This file contains configuration variables for drivers.
# It was generated by genhdrs.pl. Do not modify it.
#
package Driverhdrs;
$LAB = "datalab";
$SERVER_NAME = "2467.cs.uno.edu";
$SERVER_PORT = 8081;
$COURSE_NAME = "csapp";
$AUTOGRADE_TIMEOUT = 0;
1;
71_cpp_91794/Driverlib.pm
###############################################################
# Driverlib.pm - A package of helper functions for Perl drivers
#
# Copyright (c) 2005 David R. O'Hallaron, All rights reserved.
###############################################################
package Driverlib;
use Socket;
# Autogenerated header file with lab-specific constants
use lib ".";
use Driverhdrs;
require Exporter;
@ISA = qw(Exporter);
@EXPORT = qw(
     driver_post
     );
use strict;
#####
# Public functions
#
#
# driver_post - This is the routine that a driver calls when
# it needs to transmit an autoresult string to the result server.
#
sub driver_post ($$) {
my $userid = shift; # User id for this submission
my $result = shift; # Autoresult string
my $autograded = shift; # Set if called by an autograder
# Echo the autoresult string to stdout if the driver was called
# by an autograder
if ($autograded) {
print "\n";
print "AUTORESULT_STRING=$result\n";
return;
}    
# If the driver was called with a specific userid, then submit
# the autoresult string to the result server over the Internet.
if ($userid) {
my $status = submitr($Driverhdrs::SERVER_NAME,
$Driverhdrs::SERVER_PORT,
$Driverhdrs::COURSE_NAME,
$userid,
$Driverhdrs::LAB,
$result);

# Print the status of the transfer
if (!($status =~ /OK/)) {
print "$status\n";
print "Did not send autoresult string to the result server.\n";
exit(1);
}
print "Success: Sent autoresult string for $userid to the result server.\n";
}    
}
#####
# Private functions
#
#
# submitr - Sends an autoresult string to the result server
#
sub submitr ($$$$$$) {
my $hostname = shift;
my $port = shift;
my $course = shift;
my $userid = shift;
my $lab = shift;
my $result = shift;
my $internet_addr;
my $enc_result;
my $paddr;
my $line;
my $http_version;
my $errcode;
my $errmsg;
# Establish the connection to the server
socket(SERVER, PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$internet_addr = inet_aton($hostname)
or die "Could not convert $hostname to an internet address: $!\n";
$paddr = sockaddr_in($port, $internet_addr);
connect(SERVER, $paddr)
or die "Could not connect to $hostname:$port:$!\n";
select((select(SERVER), $| = 1)[0]); # enable command buffering
# Send HTTP request to server
$enc_result = url_encode($result);
print SERVER "GET /$course/submitr.pl/?userid=$userid&lab=$lab&result=$enc_result&submit=submit HTTP/1.0\r\n\r\n";
# Get first HTTP response line
$line = ;
chomp($line);
($http_version, $errcode, $errmsg) = split(/\s+/, $line);
if ($errcode != 200) {
return "Error: HTTP request failed with error $errcode: $errmsg";
}
# Read the remaining HTTP response header lines
while ($line = ) {
if ($line =~ /^\r\n/) {
last;
}
}
# Read and return the response from the result server
$line = ;
chomp($line);
close SERVER;
return $line;

}
#
# url_encode - Encode text string so it can be included in URI of GET request
#
sub url_encode ($) {
my $value = shift;
$value =~s/([^a-zA-Z0-9_\-.])/uc sprintf("%%%02x",ord($1))/eg;
return $value;
}
# Always end a module with a 1 so that it returns TRUE
1;
71_cpp_91794/Makefile
#
# Makefile that builds btest and other helper programs for the CS:APP data lab
#
CC = gcc
CFLAGS = -O -g -Wall -m32 -Wno-bool-operation
LIBS = -lm
all: btest fshow ishow
btest: btest.c bits.c decl.c tests.c btest.h bits.h
    $(CC) $(CFLAGS) $(LIBS) -o btest bits.c btest.c decl.c tests.c
fshow: fshow.c
    $(CC) $(CFLAGS) -o fshow fshow.c
ishow: ishow.c
    $(CC) $(CFLAGS) -o ishow ishow.c
# Forces a recompile. Used by the driver program.
btestexplicit:
    $(CC) $(CFLAGS) $(LIBS) -o btest bits.c btest.c decl.c tests.c
clean:
    rm -f *.o btest fshow ishow *~
71_cpp_91794/README
***********************
The CS:APP Data Lab
Directions to Students
***********************
Your goal is to modify your copy of bits.c so that it passes all the
tests in btest without violating any of the coding guidelines.
*********
0. Files:
*********
Makefile    - Makes btest, fshow, and ishow
README        - This file
bits.c        - The file you will be modifying and handing in
bits.h        - Header file
btest.c        - The main btest program
btest.h    - Used to build btest
decl.c    - Used to build btest
tests.c - Used to build btest
tests-header.c- Used to build btest
dlc*        - Rule checking compiler binary (data lab compiler)    
driver.pl*    - Driver program that uses btest and dlc to autograde bits.c
Driverhdrs.pm - Header file for optional "Beat the Prof" contest
fshow.c        - Utility for examining floating-point representations
ishow.c        - Utility for examining integer representations
***********************************************************
1. Modifying bits.c and checking it for compliance with dlc
***********************************************************
IMPORTANT: Carefully read the instructions in the bits.c file before
you start. These give the coding rules that you will need to follow if
you want credit for your work.
Use the dlc compiler (./dlc) to automatically check your version of
bits.c for compliance with the coding guidelines:
unix> ./dlc bits.c
dlc returns silently if there are no problems with your code.
Otherwise it prints messages that flag any problems. Running dlc with
the -e switch:
    unix> ./dlc -e bits.c
causes dlc to print counts of the number of operators used by each function.
Once you have a legal solution, you can test it for correctness using
the ./btest program.
*********************
2. Testing with btest
*********************
The Makefile in this directory compiles your version of bits.c with
additional code to create a program (or test harness) named btest.
To compile and run the btest program, type:
unix> make btest
unix> ./btest [optional cmd line args]
You will need to recompile btest each time you change your bits.c
program. When moving from one platform to another, you will want to
get rid of the old version of btest and generate a new one. Use the
commands:
unix> make clean
unix> make btest
Btest tests your code for correctness by running millions of test
cases on each function. It tests wide swaths around well known corner
cases such as Tmin and zero for integer puzzles, and zero, inf, and
the boundary between denormalized and normalized numbers for floating
point puzzles. When btest detects an error in one of your functions,
it prints out the test that failed, the incorrect result, and the
expected result, and then terminates the testing for that function.
Here are the command line options for btest:
unix> ./btest -h
Usage: ./btest [-hg] [-r ] [-f [-1|-2|-3 ]*] [-T ]
-1 Specify first function argument
-2 Specify second function argument
-3 Specify third function argument
-f Test only the named function
-g Format output for autograding with no error messages
-h Print this message
-r Give uniform weight of n for all problems
-T Set timeout limit to lim
Examples:
Test all functions for correctness and print out error messages:
unix> ./btest
Test all functions in a compact form with no error messages:
unix> ./btest -g
Test function foo for correctness:
unix> ./btest -f foo
Test function foo for correctness with specific arguments:
unix> ./btest -f foo -1 27 -2 0xf
Btest does not check your code for compliance with the coding
guidelines. Use dlc to do that.
*******************
3. Helper Programs
*******************
We have included the ishow and fshow programs to help you decipher
integer and floating point representations respectively. Each takes a
single decimal or hex number as an argument. To build them type:
unix> make
Example usages:
unix> ./ishow 0x27
Hex = 0x00000027,    Signed = 39,    Unsigned = 39
unix> ./ishow 27
Hex = 0x0000001b,    Signed = 27,    Unsigned = 27
unix> ./fshow 0x15213243
Floating point value 3.255334057e-26
Bit Representation 0x15213243, sign = 0, exponent = 0x2a, fraction = 0x213243
Normalized. +1.2593463659 X 2^(-85)
linux> ./fshow 15213243
Floating point value 2.131829405e-38
Bit Representation 0x00e822bb, sign = 0, exponent = 0x01, fraction = 0x6822bb
Normalized. +1.8135598898 X 2^(-126)
71_cpp_91794/Term/ANSIColor.pm
# Term::ANSIColor -- Color screen output using ANSI escape sequences.
#
# Copyright 1996, 1997, 1998, 2000, 2001, 2002, 2005, 2006, 2008, 2009
# Russ Allbery and Zenin
# PUSH/POP support submitted 2007 by openmethods.com voice solutions
#
# This program is free software; you may redistribute it and/or modify it
# under the same terms as Perl itself.
#
# Ah, September, when the sysadmins turn colors and fall off the trees....
# -- Dave Van Domelen
##############################################################################
# Modules and declarations
##############################################################################
package Term::ANSIColor;
require 5.001;
$VERSION = '2.02';
use strict;
use vars qw($AUTOLOAD $AUTOLOCAL $AUTORESET @COLORLIST @COLORSTACK $EACHLINE
@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $VERSION %ATTRIBUTES
%ATTRIBUTES_R);
use Exporter ();
BEGIN {
@COLORLIST = qw(CLEAR RESET BOLD DARK FAINT UNDERLINE UNDERSCORE BLINK
REVERSE CONCEALED BLACK RED GREEN YELLOW BLUE MAGENTA
CYAN WHITE ON_BLACK ON_RED ON_GREEN ON_YELLOW ON_BLUE
ON_MAGENTA ON_CYAN ON_WHITE);
@ISA = qw(Exporter);
@EXPORT = qw(color colored);
@EXPORT_OK = qw(uncolor colorstrip colorvalid);
%EXPORT_TAGS = (constants => \@COLORLIST,
pushpop => [ @COLORLIST,
qw(PUSHCOLOR POPCOLOR LOCALCOLOR) ]);
Exporter::export_ok_tags ('pushpop');
}
##############################################################################
# Internal data structures
##############################################################################
%ATTRIBUTES = ('clear' => 0,
'reset' => 0,
'bold' => 1,
'dark' => 2,
'faint' => 2,
'underline' => 4,
'underscore' => 4,
'blink' => 5,
'reverse' => 7,
'concealed' => 8,
'black' => 30, 'on_black' => 40,
'red' => 31, 'on_red' => 41,
'green' => 32, 'on_green' => 42,
'yellow' => 33, 'on_yellow' => 43,
'blue' => 34, 'on_blue' => 44,
'magenta' => 35, 'on_magenta' => 45,
'cyan' => 36, 'on_cyan' => 46,
'white' => 37, 'on_white' => 47);
# Reverse lookup. Alphabetically first name for a sequence is preferred.
for (reverse sort keys %ATTRIBUTES) {
$ATTRIBUTES_R{$ATTRIBUTES{$_}} = $_;
}
##############################################################################
# Implementation (constant form)
##############################################################################
# Time to have fun! We now want to define the constant subs, which are named
# the same as the attributes above but in all caps. Each constant sub needs
# to act differently depending on whether $AUTORESET is set. Without
# autoreset:
#
# BLUE "text\n" ==> "\e[34mtext\n"
#
# If $AUTORESET is set, we should instead get:
#
# BLUE "text\n" ==> "\e[34mtext\n\e[0m"
#
# The sub also needs to handle the case where it has no arguments correctly.
# Maintaining all of this as separate subs would be a major nightmare, as well
# as duplicate the %ATTRIBUTES hash, so instead we define an AUTOLOAD sub to
# define the constant subs on demand. To do that, we check the name of the
# called sub against the list of attributes, and if it's an all-caps version
# of one of them, we define the sub on the fly and then run it.
#
# If the environment variable ANSI_COLORS_DISABLED is set, just return the
# arguments without adding any escape sequences. This is to make it easier to
# write scripts that also work on systems without any ANSI support, like
# Windows consoles.
sub AUTOLOAD {
if (defined $ENV{ANSI_COLORS_DISABLED}) {
return join ('', @_);
}
if ($AUTOLOAD =~ /^([\w:]*::([A-Z_]+))$/ and defined $ATTRIBUTES{lc $2}) {
$AUTOLOAD = $1;
my $attr = "\e[" . $ATTRIBUTES{lc $2} . 'm';
eval qq {
sub $AUTOLOAD {
if (\$AUTORESET && \@_) {
return '$attr' . join ('', \@_) . "\e[0m";
} elsif (\$AUTOLOCAL && \@_) {
return PUSHCOLOR ('$attr') . join ('', \@_) . POPCOLOR;
} else {
return '$attr' . join ('', \@_);
}
}
};
goto &$AUTOLOAD;
} else {
require Carp;
Carp::croak ("undefined subroutine &$AUTOLOAD called");
}
}
# Append a new color to the top of the color stack and return the top of
# the stack.
sub PUSHCOLOR {
my ($text) = @_;
my ($color) = ($text =~ m/^((?:\e\[[\d;]+m)+)/);
if (@COLORSTACK) {
$color = $COLORSTACK[-1] . $color;
}
push (@COLORSTACK, $color);
return $text;
}
# Pop the color stack and return the new top of the stack (or reset, if
# the stack is empty).
sub POPCOLOR {
pop @COLORSTACK;
if (@COLORSTACK) {
return $COLORSTACK[-1] . join ('', @_);
} else {
return RESET (@_);
}
}
# Surround arguments with a push and a pop.
sub LOCALCOLOR {
return PUSHCOLOR (join ('', @_)) . POPCOLOR ();
}
##############################################################################
# Implementation (attribute string form)
##############################################################################
# Return the escape code for a given set of color attributes.
sub color {
return '' if defined $ENV{ANSI_COLORS_DISABLED};
my @codes = map { split } @_;
my $attribute = '';
foreach (@codes) {
$_ = lc $_;
unless (defined $ATTRIBUTES{$_}) {
require Carp;
Carp::croak ("Invalid attribute name $_");
}
$attribute .= $ATTRIBUTES{$_} . ';';
}
chop $attribute;
return ($attribute ne '') ? "\e[${attribute}m" : undef;
}
# Return a list of named color attributes for a given set of escape codes.
# Escape sequences can be given with or without enclosing "\e[" and "m". The
# empty escape sequence '' or "\e[m" gives an empty list of attrs.
sub uncolor {
my (@nums, @result);
for (@_) {
my $escape = $_;
$escape =~ s/^\e\[//;
$escape =~ s/m$//;
unless ($escape =~ /^((?:\d+;)*\d*)$/) {
require Carp;
Carp::croak ("Bad escape sequence $escape");
}
push (@nums, split (/;/, $1));
}
for (@nums) {
    $_ += 0; # Strip leading zeroes
    my $name = $ATTRIBUTES_R{$_};
    if (!defined $name) {
     require Carp;
     Carp::croak ("No name for escape sequence $_" );
    }
    push (@result, $name);
}
return @result;
}
# Given a string and a set of attributes, returns the string surrounded by
# escape codes to set those attributes and then clear them at the end of the
# string. The attributes can be given either as an array ref as the first
# argument or as a list as the second and subsequent arguments. If $EACHLINE
# is set, insert a reset before each occurrence of the string $EACHLINE and
# the starting attribute code after the string $EACHLINE, so that no attribute
# crosses line delimiters (this is often desirable if the output is to be
# piped to a pager or some other program).
sub colored {
my ($string, @codes);
if (ref $_[0]) {
@codes = @{+shift};
$string = join ('', @_);
} else {
$string = shift;
@codes = @_;
}
return $string if defined $ENV{ANSI_COLORS_DISABLED};
if (defined $EACHLINE) {
my $attr = color (@codes);
return join '',
map { ($_ ne $EACHLINE) ? $attr . $_ . "\e[0m" : $_ }
grep { length ($_) > 0 }
split (/(\Q$EACHLINE\E)/, $string);
} else {
return color (@codes) . $string . "\e[0m";
}
}
# Given a string, strip the ANSI color codes out of that string and return the
# result. This removes only ANSI color codes, not movement codes and other
# escape sequences.
sub colorstrip {
my (@string) = @_;
for my $string (@string) {
$string =~ s/\e\[[\d;]*m//g;
}
return wantarray ? @string : join ('', @string);
}
# Given a list of color attributes (arguments for color, for instance), return
# true if they're all valid or false if any of them are invalid.
sub colorvalid {
my @codes = map { split } @_;
for (@codes) {
unless (defined $ATTRIBUTES{lc $_}) {
return;
}
}
return 1;
}
##############################################################################
# Module return value and documentation
##############################################################################
# Ensure we evaluate to true.
1;
__END__
=head1 NAME
Term::ANSIColor - Color screen output using ANSI escape sequences
=for stopwords
cyan colorize namespace runtime TMTOWTDI cmd.exe 4nt.exe command.com NT
ESC Delvare SSH OpenSSH aixterm ECMA-048 Fraktur overlining Zenin
reimplemented Allbery PUSHCOLOR POPCOLOR LOCALCOLOR openmethods.com
=head1 SYNOPSIS
use Term::ANSIColor;
print color 'bold blue';
print "This text is bold blue.\n";
print color 'reset';
print "This text is normal.\n";
print colored ("Yellow on magenta.", 'yellow on_magenta'), "\n";
print "This text is normal.\n";
print colored ['yellow on_magenta'], 'Yellow on magenta.';
print "\n";
use Term::ANSIColor qw(uncolor);
print uncolor ('01;31'), "\n";
use Term::ANSIColor qw(colorstrip);
print colorstrip '\e[1mThis is bold\e[0m', "\n";
use Term::ANSIColor qw(colorvalid);
my $valid = colorvalid ('blue bold', 'on_magenta');
print "Color string is ", $valid ? "valid\n" : "invalid\n";
use Term::ANSIColor qw(:constants);
print BOLD, BLUE, "This text is in bold blue.\n", RESET;
use Term::ANSIColor qw(:constants);
{
local $Term::ANSIColor::AUTORESET = 1;
print BOLD BLUE "This text is in bold blue.\n";
print "This text is normal.\n";
}
use Term::ANSIColor qw(:pushpop);
print PUSHCOLOR RED ON_GREEN "This text is red on green.\n";
print PUSHCOLOR BLUE "This text is blue on green.\n";
print RESET BLUE "This text is just blue.\n";
print POPCOLOR "Back to red on green.\n";
print LOCALCOLOR GREEN ON_BLUE "This text is green on blue.\n";
print "This text is red on green.\n";
{
local $Term::ANSIColor::AUTOLOCAL = 1;
print ON_BLUE "This text is red on blue.\n";
print "This text is red on green.\n";
}
print POPCOLOR "Back to whatever we started as.\n";
=head1 DESCRIPTION
This module has two interfaces, one through color() and colored() and the
other through constants. It also offers the utility functions uncolor(),
colorstrip(), and colorvalid(), which have to be explicitly imported to be
used (see L).
=head2 Function Interface
color() takes any number of strings as arguments and considers them to be
space-separated lists of attributes. It then forms and returns the escape
sequence to set those attributes. It doesn't print it out, just returns
it, so you'll have to print it yourself if you want to (this is so that
you can save it as a string, pass it to something else, send it to a file
handle, or do anything else with it that you might care to). color()
throws an exception if given an invalid attribute, so you can also use it
to check attribute names for validity (see L).
uncolor() performs the opposite translation, turning escape sequences
into a list of strings.
colorstrip() removes all color escape sequences from the provided strings,
returning the modified strings separately in array context or joined
together in scalar context. Its arguments are not modified.
colorvalid() takes attribute strings the same as color() and returns true
if all attributes are known and false otherwise.
The recognized non-color attributes are clear, reset, bold, dark, faint,
underline, underscore, blink, reverse, and concealed. Clear and reset
(reset to default attributes), dark and faint (dim and saturated), and
underline and underscore are equivalent, so use whichever is the most
intuitive to you. The recognized foreground color attributes are black,
red, green, yellow, blue, magenta, cyan, and white. The recognized
background color attributes are on_black, on_red, on_green, on_yellow,
on_blue, on_magenta, on_cyan, and on_white. Case is not significant.
Note that not all attributes are supported by all terminal types, and some
terminals may not support any of these sequences. Dark and faint, blink,
and concealed in particular are frequently not implemented.
Attributes, once set, last until they are unset (by sending the attribute
C or C). Be careful to do this, or otherwise your attribute
will last after your script is done running, and people get very annoyed
at having their prompt and typing changed to weird colors.
As an aid to help with this, colored() takes a scalar as the first
argument and any number of attribute strings as the second argument and
returns the scalar wrapped in escape codes so that the attributes will be
set as requested before the string and reset to normal after the string.
Alternately, you can pass a reference to an array as the first argument,
and then the contents of that array will be taken as attributes and color
codes and the remainder of the arguments as text to colorize.
Normally, colored() just puts attribute codes at the beginning and end of
the string, but if you set $Term::ANSIColor::EACHLINE to some string, that
string will be considered the line delimiter and the attribute will be set
at the beginning of each line of the passed string and reset at the end of
each line. This is often desirable if the output contains newlines and
you're using background colors, since a background color that persists
across a newline is often interpreted by the terminal as providing the
default background color for the next line. Programs like pagers can also
be confused by attributes that span lines. Normally you'll want to set
$Term::ANSIColor::EACHLINE to C<"\n"> to use this feature.
=head2 Constant Interface
Alternately, if you import C<:constants>, you can use the constants CLEAR,
RESET, BOLD, DARK, FAINT, UNDERLINE, UNDERSCORE, BLINK, REVERSE,
CONCEALED, BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE,
ON_BLACK, ON_RED, ON_GREEN, ON_YELLOW, ON_BLUE, ON_MAGENTA, ON_CYAN, and
ON_WHITE directly. These are the same as color('attribute') and can be
used if you prefer typing:
print BOLD BLUE ON_WHITE "Text", RESET, "\n";
to
print colored ("Text", 'bold blue on_white'), "\n";
(Note that the newline is kept separate to avoid confusing the terminal as
described above since a background color is being used.)
When using the constants, if you don't want to have to remember to add the
C<, RESET> at the end of each print line, you can set
$Term::ANSIColor::AUTORESET to a true value. Then, the display mode will
automatically be reset if there is no comma after the constant. In other
words, with that variable set:
print BOLD BLUE "Text\n";
will reset the display mode afterward, whereas:
print BOLD, BLUE, "Text\n";
will not. If you are using background colors, you will probably want to
print the newline with a separate print statement to avoid confusing the
terminal.
The subroutine interface has the advantage over the constants interface in
that only two subroutines are exported into your namespace, versus
twenty-two in the constants interface. On the flip side, the constants
interface has the advantage of better compile time error checking, since
misspelled names of colors or attributes in calls to color() and colored()
won't be caught until runtime whereas misspelled names of constants will
be caught at compile time. So, pollute your namespace with almost two
dozen subroutines that you may not even use that often, or risk a silly
bug by mistyping an attribute. Your choice, TMTOWTDI after all.
=head2 The Color Stack
As of Term::ANSIColor 2.0, you can import C<:pushpop> and maintain a stack
of colors using PUSHCOLOR, POPCOLOR, and LOCALCOLOR. PUSHCOLOR takes the
attribute string that starts its argument and pushes it onto a stack of
attributes. POPCOLOR removes the top of the stack and restores the
previous attributes set by the argument of a prior PUSHCOLOR. LOCALCOLOR
surrounds its argument in a PUSHCOLOR and POPCOLOR so that the color
resets afterward.
When using PUSHCOLOR, POPCOLOR, and LOCALCOLOR, it's particularly
important to not put commas between the constants.
print PUSHCOLOR BLUE "Text\n";
will correctly push BLUE onto the top of the stack.
print PUSHCOLOR, BLUE, "Text\n"; # wrong!
will not, and a subsequent pop won't restore the correct attributes.
PUSHCOLOR pushes the attributes set by its argument, which is normally a
string of color constants. It can't ask the terminal what the current
attributes are.
=head1 DIAGNOSTICS
=over 4
=item Bad escape sequence %s
(F) You passed an invalid ANSI escape sequence to uncolor().
=item Bareword "%s" not allowed while "strict subs" in use
(F) You probably mistyped a constant color name such as:
$Foobar = FOOBAR . "This line should be blue\n";
or:
@Foobar = FOOBAR, "This line should be blue\n";
This will only show up under use strict (another good reason to run under
use strict).
=item Invalid attribute name %s
(F) You passed an invalid attribute name to either color() or colored().
=item Name "%s" used only once: possible typo
(W) You probably mistyped a constant color name such as:
print FOOBAR "This text is color FOOBAR\n";
It's probably better to always use commas after constant names in order to
force the next error.
=item No comma allowed after filehandle
(F) You probably mistyped a constant color name such as:
print FOOBAR, "This text is color FOOBAR\n";
Generating this fatal compile error is one of the main advantages of using
the constants interface, since you'll immediately know if you mistype a
color name.
=item No name for escape sequence %s
(F) The ANSI escape sequence passed to uncolor() contains escapes which
aren't recognized and can't be translated to names.
=back
=head1 ENVIRONMENT
=over 4
=item ANSI_COLORS_DISABLED
If this environment variable is set, all of the functions defined by this
module (color(), colored(), and all of the constants not previously used
in the program) will not output any escape sequences and instead will just
return the empty string or pass through the original text as appropriate.
This is intended to support easy use of scripts using this module on
platforms that don't support ANSI escape sequences.
For it to have its proper effect, this environment variable must be set
before any color constants are used in the program.
=back
=head1 RESTRICTIONS
It would be nice if one could leave off the commas around the constants
entirely and just say:
print BOLD BLUE ON_WHITE "Text\n" RESET;
but the syntax of Perl doesn't allow this. You need a comma after the
string. (Of course, you may consider it a bug that commas between all the
constants aren't required, in which case you may feel free to insert
commas unless you're using $Term::ANSIColor::AUTORESET or
PUSHCOLOR/POPCOLOR.)
For easier debugging, you may prefer to always use the commas when not
setting $Term::ANSIColor::AUTORESET or PUSHCOLOR/POPCOLOR so that you'll
get a fatal compile error rather than a warning.
=head1 NOTES
The codes generated by this module are standard terminal control codes,
complying with ECMA-048 and ISO 6429 (generally referred to as "ANSI
color" for the color codes). The non-color control codes (bold, dark,
italic, underline, and reverse) are part of the earlier ANSI X3.64
standard for control sequences for video terminals and peripherals.
Note that not all displays are ISO 6429-compliant, or even X3.64-compliant
(or are even attempting to be so). This module will not work as expected
on displays that do not honor these escape sequences, such as cmd.exe,
4nt.exe, and command.com under either Windows NT or Windows 2000. They
may just be ignored, or they may display as an ESC character followed by
some apparent garbage.
Jean Delvare provided the following table of different common terminal
emulators and their support for the various attributes and others have
helped me flesh it out:
clear bold faint under blink reverse conceal
------------------------------------------------------------------------
xterm yes yes no yes yes yes yes
linux yes yes yes bold yes yes no
rxvt yes yes no yes bold/black yes no
dtterm yes yes yes yes reverse yes yes
teraterm yes reverse no yes rev/red yes no
aixterm kinda normal no yes no yes yes
PuTTY yes color no yes no yes no
Windows yes no no no no yes no
Cygwin SSH yes yes no color color color yes
Mac Terminal yes yes no yes yes yes yes
Windows is Windows telnet, Cygwin SSH is the OpenSSH implementation under
Cygwin on Windows NT, and Mac Terminal is the Terminal application in Mac
OS X. Where the entry is other than yes or no, that emulator displays the
given attribute as something else instead. Note that on an aixterm, clear
doesn't reset colors; you have to explicitly set the colors back to what
you want. More entries in this table are welcome.
Note that codes 3 (italic), 6 (rapid blink), and 9 (strike-through) are
specified in ANSI X3.64 and ECMA-048 but are not commonly supported by
most displays and emulators and therefore aren't supported by this module
at the present time. ECMA-048 also specifies a large number of other
attributes, including a sequence of attributes for font changes, Fraktur
characters, double-underlining, framing, circling, and overlining. As
none of these attributes are widely supported or useful, they also aren't
currently supported by this module.
=head1 SEE ALSO
ECMA-048 is available on-line (at least at the time of this writing) at
L.
ISO 6429 is available from ISO for a charge; the author of this module
does not own a copy of it. Since the source material for ISO 6429 was
ECMA-048 and the latter is available for free, there seems little reason
to obtain the ISO standard.
The current version of this module is always available from its web site
at L. It is also part of
the Perl core distribution as of 5.6.0.
=head1 AUTHORS
Original idea (using constants) by Zenin, reimplemented using subs by Russ
Allbery , and then combined with the original idea by
Russ with input from Zenin. Russ Allbery now maintains this module.
=head1 COPYRIGHT AND LICENSE
Copyright 1996, 1997, 1998, 2000, 2001, 2002, 2005, 2006, 2008, 2009 Russ
Allbery and Zenin. This program is free software; you
may redistribute it and/or modify it under the same terms as Perl itself.
PUSHCOLOR, POPCOLOR, and LOCALCOLOR were contributed by openmethods.com
voice solutions.
=cut
71_cpp_91794/Term/Cap.pm
package Term::Cap;
# Since the debugger uses Term::ReadLine which uses Term::Cap, we want
# to load as few modules as possible. This includes Carp.pm.
sub carp
{
require Carp;
goto &Carp::carp;
}
sub croak
{
require Carp;
goto &Carp::croak;
}
use strict;
use vars qw($VERSION $VMS_TERMCAP);
use vars qw($termpat $state $first $entry);
$VERSION = '1.12';
# Version undef: Thu Dec 14 20:02:42 CST 1995 by [email protected]
# Version 1.00: Thu Nov 30 23:34:29 EST 2000 by [email protected]
#    [PATCH] $VERSION crusade, strict, tests, etc... all over lib/
# Version 1.01: Wed May 23 00:00:00 CST 2001 by [email protected]
#    Avoid warnings in Tgetent and Tputs
# Version 1.02: Sat Nov 17 13:50:39 GMT 2001 by [email protected]
# Altered layout of the POD
# Added Test::More to PREREQ_PM in Makefile.PL
# Fixed no argument Tgetent()
# Version 1.03: Wed Nov 28 10:09:38 GMT 2001
# VMS Support from Charles Lane
# Version 1.04: Thu Nov 29 16:22:03 GMT 2001
# Fixed warnings in test
# Version 1.05: Mon Dec 3 15:33:49 GMT 2001
# Don't try to fall back on infocmp if it's not there. From chromatic.
# Version 1.06: Thu Dec 6 18:43:22 GMT 2001
# Preload the default VMS termcap from Charles Lane
# Don't carp at setting OSPEED unless warnings are on.
# Version 1.07: Wed Jan 2 21:35:09 GMT 2002
# Sanity check on infocmp output from Norton Allen
# Repaired INSTALLDIRS thanks to Michael Schwern
# Version 1.08: Sat Sep 28 11:33:15 BST 2002
# Late loading of 'Carp' as per Michael Schwern
# Version 1.09: Tue Apr 20 12:06:51 BST 2004
# Merged in changes from and to Core
# Core (Fri Aug 30 14:15:55 CEST 2002):
# Cope with comments lines from 'infocmp' from Brendan O'Dea
# Allow for EBCDIC in Tgoto magic test.
# Version 1.10: Thu Oct 18 16:52:20 BST 2007
# Don't use try to use $ENV{HOME} if it doesn't exist
# Give Win32 'dumb' if TERM isn't set
# Provide fallback 'dumb' termcap entry as last resort
# Version 1.11: Thu Oct 25 09:33:07 BST 2007
# EBDIC fixes from Chun Bing Ge
# Version 1.12: Sat Dec 8 00:10:21 GMT 2007
# QNX test fix from Matt Kraai
#
# TODO:
# support Berkeley DB termcaps
# 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.
More information on the terminal capabilities will be found in the
termcap manpage on most Unix-like systems.
=head2 METHODS
=over 4
The output strings for B are cached for counts of 1 for performance.
B and B do not cache. C<$self-E{_xx}> is the raw termcap
data and C<$self-E{xx}> is the cached version.
print $terminal->Tpad($self->{_xx}, 1);
B, B, and B return the string and will also
output the string to $FH if specified.
=cut
# Preload the default VMS termcap.
# If a different termcap is required then the text of one can be supplied
# in $Term::Cap::VMS_TERMCAP before Tgetent is called.
if ( $^O eq 'VMS' )
{
chomp( my @entry = );
$VMS_TERMCAP = join '', @entry;
}
# 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,
exists $ENV{'HOME'} ? $ENV{'HOME'} . '/.termcap' : undef,
'/etc/termcap', '/usr/share/misc/termcap', );
}
# return the list of those termcaps that exist
return grep { defined $_ && -f $_ } @termcap_path;
}
=item B
Returns a blessed object reference which the user can
then use to send the control strings to the terminal using B
and B.
The function extracts the entry of the specified terminal
type I (defaults to the environment variable I) from the
database.
It will look in the environment for a I 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, the
I 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 does not begin with a
slash and name is different from I, B searches the
files F<$HOME/.termcap>, F, and F,
in that order, unless the environment variable I exists,
in which case it specifies a list of file pathnames (separated by
spaces or colons) to be searched B. 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
environment variable string it will continue the search in the
files as above.
The extracted termcap entry is available in the object
as C<$self-E{TERMCAP}>.
It takes a hash reference as an argument with two optional keys:
=over 2
=item OSPEED
The terminal output bit rate (often mistakenly called the baud rate)
for this terminal - if not set a warning will be generated
and it will be defaulted to 9600. I can be be specified as
either a POSIX termios/SYSV termio speeds (where 9600 equals 9600) or
an old DSD-style speed ( where 13 equals 9600).
=item TERM
The terminal type whose termcap entry will be used - if not supplied it will
default to $ENV{TERM}: if that is not set then B will croak.
=back
It calls C on failure.
=cut
sub Tgetent
{ ## public -- static method
my $class = shift;
my ($self) = @_;
$self = {} unless defined $self;
bless $self, $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} )
{
if ($^W)
{
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};
}
unless ( $self->{TERM} )
{
if ( $ENV{TERM} )
{
$self->{TERM} = $ENV{TERM} ;
}
else
{
if ( $^O eq 'Win32' )
{
$self->{TERM} = 'dumb';
}
else
{
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();
unless ( @termcap_path || $entry )
{
# last resort--fake up a termcap from terminfo
local $ENV{TERM} = $term;
if ( $^O eq 'VMS' )
{
$entry = $VMS_TERMCAP;
}
else
{
if ( grep { -x "$_/infocmp" } split /:/, $ENV{PATH} )
{
eval {
my $tmp = `infocmp -C 2>/dev/null`;
$tmp =~ s/^#.*\n//gm; # remove comments
if ( ( $tmp !~ m%^/%s )
&& ( $tmp =~ /(^|\|)${termpat}[:|]/s ) )
{
$entry = $tmp;
}
};
}
else
{
# this is getting desperate now
if ( $self->{TERM} eq 'dumb' )
{
$entry = 'dumb|80-column dumb tty::am::co#80::bl=^G:cr=^M:do=^J:sf=^J:';
}
}
}
}
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 () {
     next if /^\\t/ || /^#/;
     if ($_ =~ m/(^|\\|)${termpat}[:|]/o) {
        chomp;
        s/^[^:]*:// if $first++;
        $state = 0;
        while ($_ =~ s/\\\\$//) {
         defined(my $x = ) or last;
         $_ .= $x; chomp;
        }
        last;
     }
    }
    defined $entry or $entry = '';
    $entry .= $_ if $_;
};
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 ( defined $field && $field =~ /^(\w\w)$/ )
{
$self->{ '_' . $field } = 1 unless defined $self->{ '_' . $1 };
# print STDERR "DEBUG: flag $1\n";
}
elsif ( defined $field && $field =~ /^(\w\w)\@/ )
{
$self->{ '_' . $1 } = "";
# print STDERR "DEBUG: unset $1\n";
}
elsif ( defined $field && $field =~ /^(\w\w)#(.*)/ )
{
$self->{ '_' . $1 } = $2 unless defined $self->{ '_' . $1 };
# print STDERR "DEBUG: numeric $1 = $2\n";
}
elsif ( defined $field && $field =~ /^(\w\w)=(.*)/ )
{
# print STDERR "DEBUG: string $1 = $2\n";
next if defined $self->{ '_' . ( $cap = $1 ) };
$_ = $2;
if ( ord('A') == 193 )
{
s/\\E/\047/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/\\\^/\337/g;
s/\^\?/\007/g;
s/\^(.)/pack('c',ord($1) & 31)/eg;
s/\\(.)/$1/g;
s/\337/^/g;
}
else
{
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 } =...