NAME

Term::TablePrint - Print a table to the terminal and browse it interactively.

SYNOPSIS

    use Term::TablePrint :print-table;


    my @table = ( [ 'id', 'name' ],
                  [    1, 'Ruth' ],
                  [    2, 'John' ],
                  [    3, 'Mark' ],
                  [    4, 'Nena' ], );


    # Functional style:

    print-table( @table );


    # or OO style:

    my $pt = Term::TablePrint.new();

    $pt.print-table( @table, :mouse(1) );

DESCRIPTION

print-table shows a table and lets the user interactively browse it. It provides a cursor which highlights the row on which it is located. The user can scroll through the table with the different cursor keys.

KEYS

Keys to move around:

the ArrowDown key (or the j key) to move down and the ArrowUp key (or the k key) to move up.
the PageUp key (or Ctrl-P) to go to the previous page, the PageDown key (or Ctrl-N) to go to the next page.
the Insert key to go back 10 pages, the Delete key to go forward 10 pages.
the Home key (or Ctrl-A) to jump to the first row of the table, the End key (or Ctrl-E) to jump to the last row of the table.

If table-expand is set to 0, the Return key closes the table if the cursor is on the first row.

If table-expand is enabled and the cursor is on the first row, pressing Return three times in succession closes the table. If the cursor is auto-jumped to the first row, it is required only one Return to close the table.

If the cursor is not on the first row:

with the option table-expand disabled the cursor jumps to the table head if Return is pressed.
with the option table-expand enabled each column of the selected row is output in its own line preceded by the column name if Return is pressed. Another Return closes this output and goes back to the table output. If a row is selected twice in succession, the pointer jumps to the first row.

If the size of the window has changed, the screen is rewritten as soon as the user presses a key.

Ctrl-F opens a prompt. A regular expression is expected as input. This enables one to only display rows where at least one column matches the entered pattern. See option /search.

Output

If the option table-expand is enabled and a row is selected with Return, each column of that row is output in its own line preceded by the column name.

If the table has more rows than the terminal, the table is divided up on as many pages as needed automatically. If the cursor reaches the end of a page, the next page is shown automatically until the last page is reached. Also if the cursor reaches the topmost line, the previous page is shown automatically if it is not already the first page.

For the output on the screen the table elements are modified. All the modifications are made on a copy of the original table data.

If an element is not defined the value from the option undef is assigned to that element.
Each character tabulation (\t) is replaces with a space.
Vertical tabulations (\v+) are squashed to two spaces.
Code points from the ranges of control, surrogate and noncharacter are removed.
If the option squash-spaces is enabled leading and trailing spaces are removed and multiple consecutive spaces are squashed to a single space.
If an element looks like a number it is right-justified, else it is left-justified.

If the terminal is too narrow to print the table, the columns are adjusted to the available width automatically.

First, if the option trunc-fract-first is enabled and if there are numbers that have a fraction, the fraction is truncated up to two decimal places.
Then columns wider than min-col-width are trimmed. See option /min-col-width.
If it is still required to lower the row width all columns are trimmed until they fit into the terminal.

CONSTRUCTOR

The constructor method new can be called with named arguments. For the valid options see OPTIONS. Setting the options in new overwrites the default values for the instance.

ROUTINES

print-table

print-table prints the table passed with the first argument.

print-table( @table, *%options );

The first argument is an list of arrays. The first array of these arrays holds the column names. The following arrays are the table rows where the elements are the field values.

The following arguments set the options (key-values pairs).

OPTIONS

Defaults may change in future releases.

prompt

String displayed above the table.

color

If this option is enabled, SRG ANSI escape sequences can be used to color the screen output. Colors are reset to normal after each table cell.

0 - off (default)

1 - on (current selected element not colored)

2 - on (current selected element colored)

decimal-separator

If set, numbers use decimal-separator as the decimal separator instead of the default decimal separator.

Allowed values: a character with a print width of 1. If an invalid values is passed, decimal-separator falls back to the default value.

Default: . (dot)

If set (string), footer is added in the bottom line.

max-rows

Set the maximum number of used table rows. The used table rows are kept in memory.

To disable the automatic limit set max-rows to 0.

If the number of table rows is equal to or higher than max-rows, the last row of the output says REACHED LIMIT "MAX_ROWS": $limit or =LIMIT= $limit if the previous doesn't fit in the row.

Default: 50_000

min-col-width

The columns with a width below or equal min-col-width are only trimmed if it is still required to lower the row width despite all columns wider than min-col-width have been trimmed to min-col-width.

Default: 30

mouse

Set the mouse mode (see option mouse in Term::Choose).

Default: 0

progress-bar

Set the progress bar threshold. If the number of fields (rows x columns) is higher than the threshold, a progress bar is shown while preparing the data for the output. Setting the value to 0 disables the progress bar.

Default: 5_000

save-screen

0 - off (default)

1 - use the alternate screen

search

Set the behavior of Ctrl-F.

0 - off

1 - case-insensitive search (default)

2 - case-sensitive search

squash-spaces

If squash-spaces is enabled, consecutive spaces are squashed to one space and leading and trailing spaces are removed.

Default: 0

tab-width

Set the number of spaces between columns. If format is set to 2 and tab-width is even, the spaces between the columns are tab-width + 1 print columns.

Default: 2

table-expand

If the option table-expand is enabled and Return is pressed, the selected table row is printed with each column in its own line. Exception: if the cursor auto-jumped to the first row, the first row will not be expanded.

0 - off

1 - on (default)

    .----------------------------.        .----------------------------.
    |col1 | col2   | col3 | col3 |        |                            |
    |-----|--------|------|------|        |col1 : ..........           |
    |.... | ...... | .... | .... |        |                            |
    |.... | ...... | .... | .... |        |col2 : .....................|
   >|.... | ...... | .... | .... |        |       ..........           |
    |.... | ...... | .... | .... |        |                            |
    |.... | ...... | .... | .... |        |col3 : .......              |
    |.... | ...... | .... | .... |        |                            |
    |.... | ...... | .... | .... |        |col4 : .............        |
    |.... | ...... | .... | .... |        |                            |
    '----------------------------'        '----------------------------'

If table-expand is set to 0, the cursor jumps to the to first row (if not already there) when Return is pressed.

Default: 1

trunc-fract-first

If the terminal width is not wide enough and this option is enabled, the first step to reduce the width of the columns is to truncate the fraction part of numbers to 2 decimal places.

undef

Set the string that will be shown on the screen instead of an undefined field.

Default: "" (empty string)

ENVIRONMET VARIABLES

multithreading

Term::TablePrint uses multithreading when preparing the list for the output; the number of threads to use can be set with the environment variable TC_NUM_THREADS.

REQUIREMENTS

Escape sequences

The control of the cursor location, the highlighting of the cursor position is done via escape sequences.

By default Term::Choose uses tput to get the appropriate escape sequences. If the environment variable TC_ANSI_ESCAPES is set to a true value, hardcoded ANSI escape sequences are used directly without calling tput.

The escape sequences to enable the mouse mode are always hardcoded.

If the environment variable TERM is not set to a true value, vt100 is used instead as the terminal type for tput.

Monospaced font

It is required a terminal that uses a monospaced font which supports the printed characters.

Restrictions

Term::TablePrint is not installable on Windows.

CREDITS

Thanks to the people from Perl-Community.de, from stackoverflow and from #perl6 on irc.freenode.net for the help.

AUTHOR

Matthäus Kiem cuer2s@gmail.com

LICENSE AND COPYRIGHT

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.