NAME
Term::Choose - Choose items from a list.
VERSION
Version 1.056
SYNOPSIS
use 5.10.0;
use Term::Choose qw(choose);
my $array_ref = [ qw( one two three four five ) ];
my $choice = choose( $array_ref ); # single choice
say $choice;
my @choices = choose( [ 1 .. 100 ], { justify => 1 } ); # multiple choice
say "@choices";
choose( [ 'Press ENTER to continue' ], { prompt => '' } ); # no choiceDESCRIPTION
Choose from a list of items.
Based on the choose function from the Term::Clui module - for more details see "MOTIVATION".
EXPORT
Nothing by default.
use Term::Choose qw(choose);SUBROUTINES
choose
$scalar = choose( $array_ref [, \%options] );
@array = choose( $array_ref [, \%options] );
choose( $array_ref [, \%options] );choose expects as a first argument an array reference. The array the reference refers to holds the list items available for selection (in void context no selection can be made).
The array the reference - passed with the first argument - refers to is called in the documentation simply array or list resp. elements (of the array).
Options can be passed with a hash reference as a second (optional) argument.
Usage and return values
If choose is called in a scalar context, the user can choose an item by using the "move-around-keys" and confirming with "Return".
choose then returns the chosen item.
If choose is called in an list context, the user can also mark an item with the "SpaceBar".
choose then returns - when "Return" is pressed - the list of marked items including the highlighted item.
In list context "Ctrl-SpaceBar" inverts the choices: marked items are unmarked and unmarked items are marked.
If choose is called in an void context, the user can move around but mark nothing; the output shown by choose can be closed with "Return".
Called in void context choose returns nothing.
If the items of the list don't fit on the screen, the user can scroll to the next (previous) page(s).
If the window size is changed, then as soon as the user enters a keystroke choose rewrites the screen. In list context marked items are reset.
The "q" key (or Ctrl-D) returns undef or an empty list in list context.
With a mouse mode enabled (and if supported by the terminal) the item can be chosen with the left mouse key, in list context the right mouse key can be used instead the "SpaceBar" key.
Keys to move around:
Arrow keys (or hjkl),
Tab key (or Ctrl-I) to move forward, BackSpace key (or Ctrl-H or Shift-Tab) to move backward,
PageUp key (or Ctrl-B) to go back one page, PageDown key (or Ctrl-F) to go forward one page,
Home key (or Ctrl-A) to jump to the beginning of the list, End key (or Ctrl-E) to jump to the end of the list.
Modifications for the output
For the output on the screen the array elements are modified:
if an element is not defined the value from the option undef is assigned to the element.
if an element holds an empty string the value from the option empty is assigned to the element.
white-spaces in elements are replaced with simple spaces.
$element =~ s/\p{Space}/ /g;non printable characters are replaced with the replacement character (U+FFFD).
$element =~ s/\P{Print}/\x{fffd}/g;if the length of an element is greater than the width of the screen the element is cut.
$element = substr( $element, 0, $allowed_length - 3 ) . '...';** Term::Choose uses its own function to cut strings which uses print columns for the arithmetic.
All these modifications are made on a copy of the original array so choose returns the chosen elements as they were passed to the function without modifications.
Options
Options which expect a number as their value expect integers.
There is a general upper limit of one billion for options which expect a number as their value and where no upper limit is mentioned.
prompt
If prompt is undefined a default prompt-string will be shown.
If the prompt value is an empty string ("") no prompt-line will be shown.
default in list and scalar context: 'Your choice:'
default in void context: 'Close with ENTER'
layout
From broad to narrow: 0 > 1 > 2 > 3
0 - layout off
.----------------------. .----------------------. .----------------------. .----------------------. | .. .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | .. .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | | | .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | | | | | .. .. .. .. .. .. .. | | | | | | | | .. .. .. .. .. .. .. | | | | | | | | .. .. .. .. .. .. .. | '----------------------' '----------------------' '----------------------' '----------------------'1 - layout "H" (default)
.----------------------. .----------------------. .----------------------. .----------------------. | .. .. .. .. .. .. .. | | .. .. .. .. .. | | .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | .. .. .. .. .. | | .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | .. .. | | .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | | | .. .. .. .. .. .. | | .. .. .. .. .. .. .. | | | | | | .. .. .. | | .. .. .. .. .. .. .. | | | | | | | | .. .. .. .. .. .. .. | '----------------------' '----------------------' '----------------------' '----------------------'2 - layout "V"
.----------------------. .----------------------. .----------------------. .----------------------. | .. | | .. .. | | .. .. .. .. | | .. .. .. .. .. .. .. | | .. | | .. .. | | .. .. .. .. | | .. .. .. .. .. .. .. | | .. | | .. .. | | .. .. .. .. | | .. .. .. .. .. .. .. | | .. | | .. | | .. .. .. | | .. .. .. .. .. .. .. | | .. | | | | .. .. .. | | .. .. .. .. .. .. .. | | .. | | | | | | .. .. .. .. .. .. .. | '----------------------' '----------------------' '----------------------' '----------------------'3 - all in a single column
.----------------------. .----------------------. .----------------------. .----------------------. | .. | | .. | | .. | | .. | | .. | | .. | | .. | | .. | | .. | | .. | | .. | | .. | | | | .. | | .. | | .. | | | | | | .. | | .. | | | | | | | | .. | '----------------------' '----------------------' '----------------------' '----------------------'
screen_width
If defined, sets the screen width to screen_width if the screen width is greater than screen_width.
Screen width refers here to the number of print columns.
Allowed values: 1 or greater
(default: undef)
order
If the output has more than one row and more than one column:
0 - elements are ordered horizontally
1 - elements are ordered vertically (default)
Default may change in a future release.
justify
0 - elements ordered in columns are left justified (default)
1 - elements ordered in columns are right justified
2 - elements ordered in columns are centered
pad
Sets the number of whitespaces between columns. (default: 2)
Allowed values: 0 or greater
pad_one_row
Sets the number of whitespaces between elements if we have only one row. (default: value of the option pad)
Allowed values: 0 or greater
clear_screen
0 - off (default)
1 - clears the screen before printing the choices
default
With the option default can be selected an element, which will be highlighted as the default instead of the first element.
default expects a zero indexed value, so e.g. to highlight the third element the value would be 2.
If the passed value is greater than the index of the last array element the first element is highlighted.
Allowed values: 0 or greater
(default: undef)
index
0 - off (default)
1 - return the index of the chosen element instead of the chosen element resp. the indices of the chosen elements instead of the chosen elements.
page
0 - off
1 - print the page number on the bottom of the screen if there is more then one page. (default)
mouse
0 - no mouse mode (default)
1 - mouse mode 1003 enabled
2 - mouse mode 1003 enabled; maxcols/maxrows limited to 223 (mouse mode 1003 doesn't work above 223)
3 - extended mouse mode (1005) - uses utf8
4 - extended SGR mouse mode (1006)
If a mouse mode is enabled layers for STDIN are changed. Then before leaving choose as a cleanup STDIN is marked as UTF-8 with ":encoding(UTF-8)".
keep
keep prevents that prompt lines eat up all the terminal height.
Setting keep ensures that at least keep rows are available for printing list rows.
If the terminal height is less than keep keep is set to the terminal height.
Allowed values: 1 or greater
(default: 5)
beep
0 - off (default)
1 - on
hide_cursor
0 - keep the terminals highlighting of the cursor position
1 - hide the terminals highlighting of the cursor position (default)
limit
Sets the maximal allowed length of the array. (default: 100_000)
Allowed values: 1 or greater
undef
Sets the string displayed on the screen instead an undefined element.
default: '<undef>'
empty
Sets the string displayed on the screen instead an empty string.
default: '<empty>'
lf
If prompt lines are folded the option lf allows to insert spaces at beginning of the folded lines.
The option lf expects a reference to an array with two elements;
- first element (INITIAL_TAB): the number of spaces inserted at beginning of paragraphs
- second element (SUBSEQUENT_TAB): the number of spaces inserted at the beginning of all broken lines apart from the beginning of paragraphs
Allowed values for the two elements are: 0 or greater.
See INITIAL_TAB and SUBSEQUENT_TAB in Text::LineFold.
(default: undef)
ll
If all elements have the same length and this length is known before calling choose it can be passed with this option.
If ll is set, then choose doesn't calculate the length of the longest element itself but uses the value passed with this option.
length refers here to the number of print columns the element will use on the terminal.
A way to determine the number of print columns is the use of columns from Unicode::GCString.
The length of undefined elements and elements with an empty string depends on the value of the option undef resp. on the value of the option empty.
If the option ll is set the elements must be upgraded with utf8::upgrade or with an equivalent tool and not contain any non-printing character.
The upgrade with utf8::upgrade is needed because a limitation of Unicode::GCString (Bug #84661).
If ll is set to a value less than the length of the elements the output will break.
If the value of ll is greater than the screen width the elements will be trimmed to fit into the screen.
Allowed values: 1 or greater
(default: undef)
Error handling
With no arguments choose dies.
With more than two arguments choose dies.
If the first argument is not a array reference choose dies.
If the array referred by the first argument is empty choose returns undef resp. an empty list and issues a warning.
If the array referred by the first argument has more than limit elements (default 100_000) choose warns and uses the first limit array elements.
If the (optional) second argument is defined and not a hash reference choose dies.
If an option does not exist choose warns.
If an option value is not valid choose warns an falls back to the default value.
If after pressing a key Term::ReadKey::ReadKey returns undef choose warns with "EOT: $!" and returns undef resp. an empty list.
REQUIREMENTS
Perl Version
Requires Perl Version 5.10.0 or greater.
Modules
Used modules not provided as core modules:
Decoded strings
choose expects decoded strings as array elements.
Monospaced font
It is needed a terminal that uses a monospaced font.
SIGWINCH
Term::Choose makes use of the Perl signal handling as described in perlipc/Signals. It is needed an operating system which knows the WINCH signal: choose uses SIGWINCH to check if the windows size has changed.
Escape sequences
The Terminal needs to understand the following ANSI escape sequences:
"\e[A" Cursor Up
"\e[C" Cursor Forward
"\e[0J" Clear to End of Screen (Erase Data)
"\e[0m" Normal/Reset
"\e[1m" Bold
"\e[4m" Underline
"\e[7m" InverseIf the option "hide_cursor" is enabled:
"\e[?25l" Hide Cursor
"\e[?25h" Show CursorIf the option "clear_screen" is enabled:
"\e[2J" Clear Screen (Erase Data)
"\e[1;1H" Go to Top Left (Cursor Position)If a "mouse" mode is enabled:
"\e[6n" Get Cursor Position (Device Status Report)Mouse Tracking: The escape sequences
"\e[?1003h", "\e[?1005h", "\e[?1006h"and
"\e[?1003l", "\e[?1005l", "\e[?1006l"are used to enable/disable the different mouse modes.
MOTIVATION
The reason for writing Term::Choose was to get something like Term::Clui::choose but with a nicer output in the case the list doesn't fit in one row.
If the list does not fit in one row, choose from Term::Clui puts the items on the screen without ordering the items in columns. Term::Choose arranges the items in columns which makes it easier for me to find items and easier to navigate on the screen.
- Differences between Term::Clui and Term::Choose
-
Term::Clui's choose expects a question as the first argument, and then the list of items. With Term::Choose the available choices are passed with an array reference as first argument. Options can be passed with a hash reference as an optional second argument. The question can be passed with the option prompt.
As mentioned above choose from Term::Clui does not order the elements in columns if there is more than one row on the screen while Term::Choose arranges the elements in such situations in columns.
Another difference is how lists which don't fit on the screen are handled. Term::Clui::choose asks the user to enter a substring as a clue. As soon as the matching items will fit, they are displayed as normal. choose from Term::Choose skips - when scrolling and reaching the end (resp. the begin) of the screen - to the next (resp. previous) page.
Strings with characters where length(character)* is not equal to the number of print columns of the respective character might break the output from Term::Clui. To make Term::Choose's choose function work with such kind of Unicode strings it uses the method columns from Unicode::GCString to determine the string length.
* Perl builtin function length.
Multiline question/prompt: choose from Term::Clui puts the first line on the top, the subsequent lines are displayed below the list. choose from Term::Choose puts all lines of a multiline prompt on top of the list.
Term::Clui's choose prints and returns the chosen items while choose from Term::Choose only returns the chosen items.
Term::Clui disables the mouse mode if the environment variable CLUI_MOUSE is set to off. In Term::Choose the mouse mode is set with the option mouse.
- Only in Term::Clui
-
Term::Clui provides a speaking interface, offers a bundle of command-line related functions and has a fallback to work when only Perl core modules are available.
The choose function from Term::Clui can remember choices made in scalar context.
These differences refer to Term::Clui version 1.66. For a more precise description of Term::Clui consult its own documentation.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Term::ChooseAUTHOR
Matthäus Kiem <cuer2s@gmail.com>
CREDITS
Based on and inspired by the choose function from the Term::Clui module.
Thanks to the Perl-Community.de and the people form stackoverflow for the help.
LICENSE AND COPYRIGHT
Copyright 2012-2013 Matthäus Kiem.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.