|
||||
|
Shell::POSIX::SelectThe POSIX Shell's "select" loop for Perl
Tim Maher
NAMEShell::POSIX::Select - The POSIX Shell's ``select'' loop for Perl
PURPOSEThis module implements the What's so great about this loop? It automates the generation of a numbered menu of choices, prompts for a choice, proofreads that choice and complains if it's invalid (at least in this enhanced implementation), and executes a code-block with a variable set to the chosen value. That saves a lot of coding for interactive programs -- especially if the menu consists of many values! The benefit of bringing this loop to Perl is that it obviates the need for future programmers to reinvent the Choose-From-A-Menu wheel.
SYNOPSISselect [ [ my | local | our ] scalar_var ] ( [LIST] ) { [CODE] } In the above, the enclosing square brackets (not typed) identify optional elements, and vertical bars indicate mutually-exclusive choices: The required elements are the keyword
ELEMENTARY EXAMPLESNOTE: All non-trivial programming examples shown in this document are distributed with this module, in the Scripts directory. ADDITIONAL EXAMPLES, covering more features, are shown below.
ship2me.plxuse Shell::POSIX::Select; select $shipper ( 'UPS', 'FedEx' ) { print "\nYou chose: $shipper\n"; last; } ship ($shipper, $ARGV[0]); # prints confirmation message Screen ship2me.plx '42 hemp toothbrushes' # program invocation 1) UPS 2) FedEx Enter number of choice: 2 You chose: FedEx Your order has been processed. Thanks for your business!
ship2me2.plxThis variation on the preceding example shows how to use a custom menu-heading and interactive prompt. use Shell::POSIX::Select qw($Heading $Prompt); $Heading='Select a Shipper' ; $Prompt='Enter Vendor Number: ' ; select $shipper ( 'UPS', 'FedEx' ) { print "\nYou chose: $shipper\n"; last; } ship ($shipper, $ARGV[0]); # prints confirmation message Screen ship2me2.plx '42 hemp toothbrushes' Select a Shipper 1) UPS 2) FedEx Enter Vendor Number: 2 You chose: FedEx Your order has been processed. Thanks for your business!
SYNTAX
Loop StructureSupported invocation formats include the following: use Shell::POSIX::Select ; select () { } # Form 0 select () { CODE } # Form 1 select (LIST) { CODE } # Form 2 select $var (LIST) { CODE } # Form 3 select my $var (LIST) { CODE } # Form 4 select our $var (LIST) { CODE } # Form 5 select local $var (LIST) { CODE } # Form 6 If the loop variable is omitted (as in Forms 0, 1 and 2 above),
it defaults to The cases shown above are merely examples; all reasonable permutations are permitted, including: select $var ( ) { CODE } select local $var (LIST) { } The only form that's not allowed is one that specifies the loop-variable's declarator without naming the loop variable, as in: select our () { } # WRONG! Must name variable with declarator!
The Loop variableSee SCOPING ISSUES for full details about the implications of different types of declarations for the loop variable.
The $Reply VariableWhen the interactive user responds to the
OVERVIEWThis loop is syntactically similar to Perl's
foreach $var ( LIST ) { CODE } The job of select $var ( LIST ) { CODE } In contrast, the In other words, This module implements the The Bash and Korn shells differ slightly in their handling
of
ENHANCEMENTSAlthough the shell doesn't allow the loop variable to be omitted,
for compliance with Perlish expectations,
the The interface and behavior of the Shell versions has been retained
where deemed desirable,
and sensibly modified along Perlish lines elsewhere.
Accordingly, the (primary) default LIST is @ARGV (paralleling the Shell's ``$@''),
menu prompts can be customized by having the script import and set $Prompt
(paralleling the Shell's $PS3),
and the user's response to the prompt appears in the
variable $Reply (paralleling the Shell's $REPLY),
A deficiency of the shell implementation is the
inability of the user to provide a heading for each A similar deficiency surrounds the handling of a custom prompt string, and the need to automatically display it on moving from an inner loop to an outer one. To address these deficiencies, this implementation provides the option of having a heading and prompt bound
to each Headings and prompts are displayed in reverse video on the terminal, if possible, to make them more visually distinct. Some shell versions simply ignore bad input, such as the entry of a number outside the menu's valid range, or alphabetic input. I can't imagine any argument in favor of this behavior being desirable when input is coming from a terminal, so this implementation gives clear warning messages for such cases by default (see Warnings for details). After a menu's initial prompt is issued, some shell versions don't show it again unless the user enters an empty line. This is desirable in cases where the menu is sufficiently large as to cause preceding output to scroll off the screen, and undesirable otherwise. Accordingly, an option is provided to enable or disable automatic prompting (see Prompts). This implementation always issues a fresh prompt
when a terminal user submits EOF as input to a nested
SCOPING ISSUESIf the loop variable is named and provided with a declarator ( This allows, for example, a variable declared as private above the loop to be accessible from within the loop, and beyond it, and one declared as private for the loop to be confined to it: select my $loopvar ( ) { } print "$loopvar DOES NOT RETAIN last value from loop here\n"; ------------------------------------------------------------- my $loopvar; select $loopvar ( ) { } print "$loopvar RETAINS last value from loop here\n"; With this design,
foreach $othervar ( ) { } # variable localized automatically print "$othervar DOES NOT RETAIN last value from loop here\n"; select $othervar ( ) { } # variable in scope, or global print "$othervar RETAINS last value from loop here\n"; This difference in the treatment of variables is intentional, and appropriate.
That's because the whole point of In contrast, it's usually considered undesirable and unnecessary
for the value of the
Of course, in situations where the
Another deficiency of the Shell versions is that it's difficult for the
programmer to differentiate between a
IMPORTS AND OPTIONS
Syntaxuse Shell::POSIX::Select ( '$Prompt', # to customize per-menu prompt '$Heading', # to customize per-menu heading '$Eof', # T/F for Eof detection # Variables must come first, then key/value options prompt => 'Enter number of choice:', # or 'whatever:' style => 'Bash', # or 'Korn' warnings => 1, # or 0 debug => 0, # or 1-5 logging => 0, # or 1 testmode => <unset>, # or 'make', or 'foreach' ); NOTE: The values shown for options are the defaults, except for
PromptsThere are two ways to customize the prompt used to solicit choices from
The prompt optionThe The prompt string should not end in a whitespace character, because that doesn't look nice when the prompt is highlighted for display (usually in reverse video). To offset the cursor from the prompt's end, one space is inserted automatically after display highlighting has been turned off. If the environment variable The default prompt is ``Enter number of choice:''.
To get the same prompt as provided by the Korn or Bash shell,
use
The $Prompt variableThe programmer may also modify the prompt during execution,
which may be desirable with nested loops that require different user instructions.
This is accomplished by
importing the $Prompt variable, and setting it to the desired prompt string
before entering the loop. Note that imported variables have to be listed
as the initial arguments to the NOTE: If the program's input channel is not connected to a terminal, prompting is automatically disabled (since there's no point in soliciting input from a pipe!).
$HeadingThe programmer has the option of binding a heading to each loop's menu,
by importing
$EofA common concern with the Shell's Therefore, to make EOF detection as convenient and easy as possible,
the programmer may import
StylesThe
WarningsThe If the environment variable
LoggingThe The default setting is If the environment variable
DebugThe This option is primarly intended for the author's use, but
users who find bugs may want to enable it and email the output to
AUTHOR. But before concluding that the problem is truly a bug
in this module, please confirm that the program runs correctly with the option
TestmodeThe If the environment variable With the Note that before you use For instance,
must be rewritten as follows, to explicitly show ``@ARGV'' (assuming it's not in a subroutine) and ``print'':
ADDITIONAL EXAMPLESNOTE: All non-trivial programming examples shown in this document are
distributed with this module, in the Scripts directory.
See ELEMENTARY EXAMPLES
for simpler uses of
pick_file.plxThis program lets the user choose filenames to be sent to the output.
It's sort of like an
interactive Perl use Shell::POSIX::Select ( prompt => 'Pick File(s):' , style => 'Korn' # for automatic prompting ); select ( <*> ) { } Screen lp `pick_file`> # Using UNIX-like OS 1) memo1.txt 2) memo2.txt 3) memo3.txt 4) junk1.txt 5) junk2.txt 6) junk3.txt Pick File(s): 4 Pick File(s): 2 Pick File(s): ^D request id is yumpy(AT)guru+587
browse_images.plxHere's a simple yet highly useful script. It displays a menu of all
the image files in the current directory, and then displays the chosen
ones on-screen using a backgrounded image viewer.
It uses Perl's use Shell::POSIX::Select ; $viewer='xv'; # Popular image viewer select ( grep /\.(jpg|gif|tif|png)$/i, <*> ) { system "$viewer $_ &" ; # run viewer in background }
perl_man.plxBack in the olden days, we only had one Perl man-page. It was voluminous, but at least you knew what argument to give the man command to get the documentaton. Now we have over a hundred Perl man pages, with unpredictable names that are difficult to remember. Here's the program I use that allows me to select the man-page of interest from a menu. use Shell::POSIX::Select ; # Extract man-page names from the TOC portion of the output of "perldoc perl" select $manpage ( sort ( `perldoc perl` =~ /^\s+(perl\w+)\s/mg) ) { system "perldoc '$manpage'" ; } Screen 1) perl5004delta 2) perl5005delta 3) perl561delta 4) perl56delta 5) perl570delta 6) perl571delta . . . (This large menu spans multiple screens, but all parts can be accessed using your normal terminal scrolling facility.) Enter number of choice: 6 PERL571DELTA(1) Perl Programmers Reference Guide NAME perl571delta - what's new for perl v5.7.1 DESCRIPTION This document describes differences between the 5.7.0 release and the 5.7.1 release. . . .
pick.plxThis more general use Shell::POSIX::Select ; BEGIN { if (@ARGV) { @choices=@ARGV ; } else { # if no args, get choices from input @choices=<STDIN> or die "$0: No data\n"; chomp @choices ; # STDIN already returned EOF, so must reopen # for terminal before menu interaction open STDIN, "/dev/tty" or die "$0: Failed to open STDIN, $!" ; # UNIX example } } select ( @choices ) { } # prints selections to output Sample invocations (UNIX-like system) lp `pick *.txt` # same output as shown for "pick_file" find . -name '*.plx' -print | pick | xargs lp # includes sub-dirs who | awk '{ print $1 }' | # isolate user names pick | # select user names Mail -s 'Promote these people!' boss
delete_file.plxIn this program, the user selects a filename
to be deleted. The outer loop is used to refresh the list,
so the file deleted on the previous iteration gets removed from the next menu.
The outer loop is labeled (as use Shell::POSIX::Select ( '$Eof', # for ^D detection prompt=>'Choose file for deletion:' ) ; OUTER: while ( @files=<*.py> ) { # collect serpentine files select ( @files ) { # prompt for deletions print STDERR "Really delete $_? [y/n]: " ; my $answer = <STDIN> ; # ^D sets $Eof below defined $answer or last OUTER ; # exit on ^D $answer eq "y\n" and unlink and last ; } $Eof and last; }
lc_filename.plxThis example shows the benefit of importing Here's how it works.
If the rename succeeds in the inner loop, execution
of use Shell::POSIX::Select ( '$Eof' , prompt => 'Enter number (^D to exit):' style => 'Korn' # for automatic prompting ); # Rename selected files from current dir to lowercase while ( @files=<*[A-Z]*> ) { # refreshes select's menu select ( @files ) { # skip fully lower-case names if (rename $_, "\L$_") { last ; } else { warn "$0: rename failed for $_: $!\n"; } } $Eof and last ; # Handle ^D to menu prompt } Screen lc_filename.plx 1) Abe.memo 2) Zeke.memo Enter number (^D to exit): 1 1) Zeke.memo Enter number (^D to exit): ^D
order.plxThis program sets a custom prompt and heading for each of its two loops, and shows the use of a label on the outer loop. use Shell::POSIX::Select qw($Prompt $Heading); $Heading="\n\nQuantity Menu:"; $Prompt="Choose Quantity:"; OUTER: select my $quantity (1..4) { $Heading="\nSize Menu:" ; $Prompt='Choose Size:' ; select my $size ( qw (L XL) ) { print "You chose $quantity units of size $size\n" ; last OUTER ; # Order is complete } } Screen order.plx Quantity Menu: 1) 1 2) 2 3) 3 4) 4 Choose Quantity: 4 Size Menu: 1) L 2) XL Choose Size: ^D (changed my mind about the quantity) Quantity Menu: 1) 1 2) 2 3) 3 4) 4 Choose Quantity: 2 Size Menu: 1) L 2) XL Choose Size: 2 You chose 2 units of size XL
browse_records.plxThis program shows how you can implement a ``record browser'', that builds a menu from the designated field of each record, and then shows the record associated with the selected field. To use a familiar example, we'll browse the UNIX password file by user-name. use Shell::POSIX::Select ( style => 'Korn' ); if (@ARGV != 2 and @ARGV != 3) { die "Usage: $0 fieldnum filename [delimiter]" ; } # Could also use Getopt:* module for option parsing ( $field, $file, $delim) = @ARGV ; if ( ! defined $delim ) { $delim='[\040\t]+' # SP/TAB sequences } $field-- ; # 2->1, 1->0, etc., for 0-based indexing foreach ( `cat "$file"` ) { # field is the key in the hash, value is entire record $f2r{ (split /$delim/, $_)[ $field ] } = $_ ; } # Show specified fields in menu, and display associated records select $record ( sort keys %f2r ) { print "$f2r{$record}\n" ; } Screen browsrec.plx '1' /etc/passwd ':' 1) at 2) bin 3) contix 4) daemon 5) ftp 6) games 7) lp 8) mail 9) man 10) named 11) news 12) nobody 13) pop 14) postfix 15) root 16) spug 17) sshd 18) tim Enter number of choice: 18 tim:x:213:100:Tim Maher:/home/tim:/bin/bash Enter number of choice: ^D
menu_ls.plxThis program shows a prototype for a menu-oriented front end to a UNIX command, which prompts the user for command-option choices, assembles the requested command, and then runs it. It employs the user's numeric choice,
stored in the use Shell::POSIX::Select qw($Heading $Prompt $Eof) ; # following avoids used-only once warning my ($type, $format) ; # Would be more Perlish to associate choices with options # via a Hash, but this approach demonstrates $Reply variable @formats = ( 'regular', 'long' ) ; @fmt_opt = ( '', '-l' ) ; @types = ( 'only non-hidden', 'all files' ) ; @typ_opt = ( '', '-a' , ) ; print "** LS-Command Composer **\n\n" ; $Heading="\n**** Style Menu ****" ; $Prompt= "Choose listing style:" ; OUTER: select $format ( @formats ) { $user_format=$fmt_opt[ $Reply - 1 ] ; $Heading="\n**** File Menu ****" ; $Prompt="Choose files to list:" ; select $type ( @types ) { # ^D restarts OUTER $user_type=$typ_opt[ $Reply - 1 ] ; last OUTER ; # leave loops once final choice obtained } } $Eof and exit ; # handle ^D to OUTER # Now construct user's command $command="ls $user_format $user_type" ; # Show command, for educational value warn "\nPress <ENTER> to execute \"$command\"\n" ; # Now wait for input, then run command defined <> or print "\n" and exit ; system $command ; # finally, run the command B<Screen> menu_ls.plx ** LS-Command Composer ** 1) regular 2) long Choose listing format: 2 1) only non-hidden 2) all files Choose files to list: 2 Press <ENTER> to execute "ls -l -a" <ENTER> total 13439 -rw-r--r-- 1 yumpy gurus 1083 Feb 4 15:41 README -rw-rw-r-- 6 yumpy gurus 277 Dec 17 14:36 .exrc.mmkeys -rw-rw-r-- 7 yumpy gurus 285 Jan 16 18:45 .exrc.podkeys $
BUGS
UNIX OrientationI've been a UNIX programmer since 1976, and a Linux proponent since 1992, so it's most natural for me to program for those platforms. Accordingly, this early release has some minor features that are only allowed, or perhaps only entirely functional, on UNIX-like systems. I'm open to suggestions on how to implement some of these features in a more portable manner. Some of the programming examples are also UNIX oriented, but it should be easy enough for those specializing on other platforms to make the necessary adapations. 8-}
Terminal Display ModesThese have been tested under UNIX/Linux, and work as expected, using tput. When time permits, I'll convert to a portable implementation that will support other OSs.
Incorrect Line Numbers in WarningsBecause this module inserts new source code into your program,
Perl messages that reference line numbers will refer to a
different source file than you wrote. For this reason,
only messages referring to lines before the first If you're on a UNIX-like system, by enabling the
Comments can Interfere with FilteringBecause of the way Filter::Simple works,
ostensibly ``commented-out'' # select (@ARGV) # { ; } select (@ARGV) { ; } A future version of Filter::Simple (or more precisely Text::Balanced, on which on which it depends) may correct this problem. In any case, there's an easy workaround for the commented-out select loop problem; just change select into eslect when you comment it out, and there'll be no problem. For other problems involving troublesome text within comments, see Failure to Identify select Loops.
Failure to Identify
|
|||
|