3 Term::ReadLine - Perl interface to various C<readline> packages.
4 If no real package is found, substitutes stubs instead of basic functions.
9 my $term = new Term::ReadLine 'Simple Perl calc';
10 my $prompt = "Enter your arithmetic expression: ";
11 my $OUT = $term->OUT || \*STDOUT;
12 while ( defined ($_ = $term->readline($prompt)) ) {
15 print $OUT $res, "\n" unless $@;
16 $term->addhistory($_) if /\S/;
21 This package is just a front end to some other packages. At the moment
22 this description is written, the only such package is Term-ReadLine,
23 available on CPAN near you. The real target of this stub package is to
24 set up a common interface to whatever Readline emerges with time.
26 =head1 Minimal set of supported functions
28 All the supported functions should be called as methods, i.e., either as
30 $term = new Term::ReadLine 'name';
34 $term->addhistory('row');
36 where $term is a return value of Term::ReadLine-E<gt>new().
42 returns the actual package that executes the commands. Among possible
43 values are C<Term::ReadLine::Gnu>, C<Term::ReadLine::Perl>,
44 C<Term::ReadLine::Stub>.
48 returns the handle for subsequent calls to following
49 functions. Argument is the name of the application. Optionally can be
50 followed by two arguments for C<IN> and C<OUT> filehandles. These
51 arguments should be globs.
55 gets an input line, I<possibly> with actual C<readline>
56 support. Trailing newline is removed. Returns C<undef> on C<EOF>.
60 adds the line to the history of input, from where it can be used if
61 the actual C<readline> is present.
65 return the filehandles for input and output or C<undef> if C<readline>
66 input and output cannot be used for Perl.
70 If argument is specified, it is an advice on minimal size of line to
71 be included into history. C<undef> means do not include anything into
72 history. Returns the old value.
76 returns an array with two strings that give most appropriate names for
77 files for input and output using conventions C<"E<lt>$in">, C<"E<gt>out">.
81 returns a reference to a hash which describes internal configuration
82 of the package. Names of keys in this hash conform to standard
83 conventions with the leading C<rl_> stripped.
87 Returns a reference to a hash with keys being features present in
88 current implementation. Several optional features are used in the
89 minimal interface: C<appname> should be present if the first argument
90 to C<new> is recognized, and C<minline> should be present if
91 C<MinLine> method is not dummy. C<autohistory> should be present if
92 lines are put into history automatically (maybe subject to
93 C<MinLine>), and C<addhistory> if C<addhistory> method is not dummy.
95 If C<Features> method reports a feature C<attribs> as present, the
96 method C<Attribs> is not dummy.
100 =head1 Additional supported functions
102 Actually C<Term::ReadLine> can use some other package, that will
103 support reacher set of commands.
105 All these commands are callable via method interface and have names
106 which conform to standard conventions with the leading C<rl_> stripped.
108 The stub package included with the perl distribution allows some
115 makes Tk event loop run when waiting for user input (i.e., during
120 makes the command line stand out by using termcap data. The argument
121 to C<ornaments> should be 0, 1, or a string of a form
122 C<"aa,bb,cc,dd">. Four components of this string should be names of
123 I<terminal capacities>, first two will be issued to make the prompt
124 standout, last two to make the input line standout.
128 takes two arguments which are input filehandle and output filehandle.
129 Switches to use these filehandles.
133 One can check whether the currently loaded ReadLine package supports
134 these methods by checking for corresponding C<Features>.
142 The environment variable C<PERL_RL> governs which ReadLine clone is
143 loaded. If the value is false, a dummy interface is used. If the value
144 is true, it should be tail of the name of the package to use, such as
147 As a special case, if the value of this variable is space-separated,
148 the tail might be used to disable the ornaments by setting the tail to
149 be C<o=0> or C<ornaments=0>. The head should be as described above, say
151 If the variable is not set, or if the head of space-separated list is
152 empty, the best available package is loaded.
154 export "PERL_RL=Perl o=0" # Use Perl ReadLine without ornaments
155 export "PERL_RL= o=0" # Use best available ReadLine without ornaments
157 (Note that processing of C<PERL_RL> for ornaments is in the discretion of the
158 particular used C<Term::ReadLine::*> package).
162 It seems that using Term::ReadLine from Emacs minibuffer doesn't work
163 quite right and one will get an error message like
165 Cannot open /dev/tty for read at ...
167 One possible workaround for this is to explicitly open /dev/tty like this
169 open (FH, "/dev/tty" )
170 or eval 'sub Term::ReadLine::findConsole { ("&STDIN", "&STDERR") }';
174 or you can try using the 4-argument form of Term::ReadLine->new().
180 package Term::ReadLine::Stub;
181 our @ISA = qw'Term::ReadLine::Tk Term::ReadLine::TermCap';
183 $DB::emacs = $DB::emacs; # To peacify -w
185 *rl_term_set = \@Term::ReadLine::TermCap::rl_term_set;
187 sub PERL_UNICODE_STDIN () { 0x0001 }
189 sub ReadLine {'Term::ReadLine::Stub'}
192 my ($in,$out,$str) = @$self;
194 print $out $rl_term_set[0], $prompt, $rl_term_set[1], $rl_term_set[2];
196 if not $Term::ReadLine::registered and $Term::ReadLine::toloop
197 and defined &Tk::DoOneEvent;
198 #$str = scalar <$in>;
199 $str = $self->get_line;
200 $str =~ s/^\s*\Q$prompt\E// if ($^O eq 'MacOS');
202 if (${^UNICODE} & PERL_UNICODE_STDIN || defined ${^ENCODING}) &&
204 print $out $rl_term_set[3];
205 # bug in 5.000: chomping empty string creats length -1:
206 chomp $str if defined $str;
214 if ($^O eq 'MacOS') {
215 $console = "Dev:Console";
216 } elsif (-e "/dev/tty") {
217 $console = "/dev/tty";
218 } elsif (-e "con" or $^O eq 'MSWin32') {
221 $console = "sys\$command";
224 if (($^O eq 'amigaos') || ($^O eq 'beos') || ($^O eq 'epoc')) {
227 elsif ($^O eq 'os2') {
231 $console = "/dev/con";
235 my $consoleOUT = $console;
236 $console = "&STDIN" unless defined $console;
237 if (!defined $consoleOUT) {
238 $consoleOUT = defined fileno(STDERR) ? "&STDERR" : "&STDOUT";
240 ($console,$consoleOUT);
244 die "method new called with wrong number of arguments"
245 unless @_==2 or @_==4;
246 #local (*FIN, *FOUT);
247 my ($FIN, $FOUT, $ret);
249 my($console, $consoleOUT) = $_[0]->findConsole;
251 open(FIN, "<$console");
252 open(FOUT,">$consoleOUT");
253 #OUT->autoflush(1); # Conflicts with debugger?
254 my $sel = select(FOUT);
255 $| = 1; # for DB::OUT
257 $ret = bless [\*FIN, \*FOUT];
258 } else { # Filehandles supplied
259 $FIN = $_[2]; $FOUT = $_[3];
260 #OUT->autoflush(1); # Conflicts with debugger?
261 my $sel = select($FOUT);
262 $| = 1; # for DB::OUT
264 $ret = bless [$FIN, $FOUT];
266 if ($ret->Features->{ornaments}
267 and not ($ENV{PERL_RL} and $ENV{PERL_RL} =~ /\bo\w*=0/)) {
268 local $Term::ReadLine::termcap_nowarn = 1;
275 my ($self, $in, $out) = @_;
278 my $sel = select($out);
279 $| = 1; # for DB::OUT
283 sub IN { shift->[0] }
284 sub OUT { shift->[1] }
285 sub MinLine { undef }
288 my %features = (tkRunning => 1, ornaments => 1, 'newTTY' => 1);
289 sub Features { \%features }
291 package Term::ReadLine; # So late to allow the above code be defined?
293 our $VERSION = '1.01';
295 my ($which) = exists $ENV{PERL_RL} ? split /\s+/, $ENV{PERL_RL} : undef;
297 if ($which =~ /\bgnu\b/i){
298 eval "use Term::ReadLine::Gnu;";
299 } elsif ($which =~ /\bperl\b/i) {
300 eval "use Term::ReadLine::Perl;";
302 eval "use Term::ReadLine::$which;";
304 } elsif (defined $which and $which ne '') { # Defined but false
307 eval "use Term::ReadLine::Gnu; 1" or eval "use Term::ReadLine::Perl; 1";
312 # To make possible switch off RL in debugger: (Not needed, work done
315 if (defined &Term::ReadLine::Gnu::readline) {
316 @ISA = qw(Term::ReadLine::Gnu Term::ReadLine::Stub);
317 } elsif (defined &Term::ReadLine::Perl::readline) {
318 @ISA = qw(Term::ReadLine::Perl Term::ReadLine::Stub);
319 } elsif (defined $which && defined &{"Term::ReadLine::$which\::readline"}) {
320 @ISA = "Term::ReadLine::$which";
322 @ISA = qw(Term::ReadLine::Stub);
325 package Term::ReadLine::TermCap;
327 # Prompt-start, prompt-end, command-line-start, command-line-end
328 # -- zero-width beautifies to emit around prompt and the command line.
329 our @rl_term_set = ("","","","");
331 our $rl_term_set = ',,,';
335 return if defined $terminal;
338 $terminal = Tgetent Term::Cap ({OSPEED => 9600}); # Avoid warning.
343 return $rl_term_set unless @_;
344 $rl_term_set = shift;
345 $rl_term_set ||= ',,,';
346 $rl_term_set = 'us,ue,md,me' if $rl_term_set eq '1';
347 my @ts = split /,/, $rl_term_set, 4;
348 eval { LoadTermCap };
349 unless (defined $terminal) {
350 warn("Cannot find termcap: $@\n") unless $Term::ReadLine::termcap_nowarn;
351 $rl_term_set = ',,,';
354 @rl_term_set = map {$_ ? $terminal->Tputs($_,1) || '' : ''} @ts;
359 package Term::ReadLine::Tk;
361 our($count_handle, $count_DoOne, $count_loop);
362 $count_handle = $count_DoOne = $count_loop = 0;
365 sub handle {$giveup = 1; $count_handle++}
368 # Tk->tkwait('variable',\$giveup); # needs Widget
369 $count_DoOne++, Tk::DoOneEvent(0) until $giveup;
376 $Term::ReadLine::registered++
377 or Tk->fileevent($self->IN,'readable',\&handle);
381 $Term::ReadLine::toloop = $_[1] if @_ > 1;
382 $Term::ReadLine::toloop;
387 $self->Tk_loop if $Term::ReadLine::toloop && defined &Tk::DoOneEvent;
388 return getc $self->IN;
393 $self->Tk_loop if $Term::ReadLine::toloop && defined &Tk::DoOneEvent;