/ 
Term-ReadLine-Simple-0.013
River stage zero No dependents
/ Term::ReadLine::Simple

NAME

Term::ReadLine::Simple - Read a line from STDIN.

VERSION

Version 0.013

SYNOPSIS

use Term::ReadLine::Simple;

my $new = Term::ReadLine::Simple->new( 'name' );
my $line = $new->readline( 'Prompt: ', { default => 'abc' } );

DESCRIPTION

readline reads a line from STDIN. As soon as Return is pressed readline returns the read string without the newline character - so no chomp is required.

This module is intended to cope with Unicode (multibyte character/grapheme cluster).

Keys

BackSpace or Strg-H: Delete the character behind the cursor.

Delete or Strg-D: Delete the character at point. Return nothing if the input puffer is empty.

Strg-U: Delete the text backward from the cursor to the beginning of the line.

Strg-K: Delete the text from the cursor to the end of the line.

Right-Arrow or Strg-F: Move forward a character.

Left-Arrow or Strg-B: Move back a character.

Home or Strg-A: Move to the start of the line.

End or Strg-E: Move to the end of the line.

METHODS

new

The new method returns a Term::ReadLine::Simple object.

my $new = Term::ReadLine::Simple->new( 'name' );

The argument is the name of the application.

config

The method config sets the defaults for the current Term::ReadLine::Simple object.

$new->config( \%options );

The available options are:

  • default

    Sets the default default string.

    Allowed values: a decoded string.

    Default: not set.

  • no_echo

    Sets the default value for no_echo.

    Allowed values: 0, 1 or 2.

    Default: 0.

Options not available in the readline method:

  • compat

    If compat is set to 1, the return value of readline is not decoded else the return value of readline is decoded.

    Setting the environment variable READLINE_SIMPLE_COMPAT to a true value has the same effect as setting compat to 1 unless compat is defined. If compat is defined, READLINE_SIMPLE_COMPAT has no meaning.

    Allowed values: 0 or 1.

    Default: no set

  • reinit_encoding

    To get the right encoding Term::ReadLine::Simple uses Encode::Locale. Passing an encoding to reinit_encoding changes the encoding reported by Encode::Locale. See "reinit-encoding" in Encode::Locale for more details.

    Allowed values: an encoding which is recognized by the Encode module.

    Default: not set.

readline

readline reads a line from STDIN.

$line = $new->readline( $prompt, [ \%options ] );

The fist argument is the prompt string. The optional second argument is the default string if it is not a reference. If the second argument is a hash-reference, the hash is used to set the different options. The keys/options are

  • default

    Sets a initial value of input.

  • no_echo

    If no_echo is set to 1, "*" are displayed instead of the characters.

    If no_echo is set to 2, no output is shown apart from the prompt string.

See "config" for the default and allowed values.

REQUIREMENTS

Perl version

Requires Perl version 5.8.0 or greater.

Terminal

It is required a terminal which uses a monospaced font.

Unless the OS is MSWin32 the terminal has to understands ANSI escape sequences.

Encoding layer

It is required to use appropriate I/O encoding layers. If the encoding layer for STDIN doesn't match the terminal's character set, readline will break if a non ascii character is entered.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Term::ReadLine::Simple

AUTHOR

Matthäus Kiem <cuer2s@gmail.com>

CREDITS

Thanks to the Perl-Community.de and the people form stackoverflow for the help.

LICENSE AND COPYRIGHT

Copyright 2014 Matthäus Kiem.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For details, see the full text of the licenses in the file LICENSE.