NAME

Term::ReadLine::Perl5::Common

DESCRIPTION

A non-OO package which contains commmon routines for the OO (Term::ReadLine::Perl5::OO and non-OO Term::ReadLine::Perl5::readline routines of Term::ReadLine::Common

SUBROUTINES

Key-Binding Functions

F_Ding

Ring the bell.

Should do something with $var_PreferVisibleBel here, but what?

Internal Functions

ctrl

ctrl($ord)

Returns the ordinal number for the corresponding control code.

For example ctrl(ord('a')) returns the ordinal for Ctrl-A or 1. ctrl(ord('A')) does the same thing.

rl_tilde_expand

rl_tilde_expand($prefix) => list of usernames

Returns a list of completions that begin with the given prefix, $prefix. This only works if we have getpwent() available.

unescape

unescape($string) -> List of keys

This internal function that takes $string possibly containing escape sequences, and converts to a series of octal keys.

It has special rules for dealing with readline-specific escape-sequence commands.

New-style key bindings are enclosed in double-quotes. Characters are taken verbatim except the special cases:

\C-x    Control x (for any x)
\M-x    Meta x (for any x)
\e      Escape
\*      Set the keymap default   (JP: added this)
        (must be the last character of the sequence)
\x      x  (unless it fits the above pattern)

Special case "\C-\M-x", should be treated like "\M-\C-x".