Enable using editline on the standard user streams if user_input
is connected to a terminal. This is the high level predicate used for
most purposes. The remainder of the library interface deals with low
level predicates that allows for applying and programming libedit in
non-standard situations.
The library is registered with ProgName set to swipl
(see
el_wrap/4).
Invoke the libedit bind command with the given arguments.
The example below lists the current key bindings.
?- el_bind(user_input, ['-a']).
The predicate el_bind/2 is
typically used to bind commands defined using el_addfn/4.
Note that the C proxy function has only the last character of the
command as context to find the Prolog binding. This implies we cannot
both bind e.g., "^[?" *and "?" to a Prolog function.
- See also
editrc(5) for more information.
Add a new command to the command line editor associated with Input.
Command is the name of the command, Help is the
help string printed with e.g. bind -a (see el_bind/2)
and Goal is called of the associated key-binding is
activated. Goal is called as
call(:Goal, +Input, +Char, -Continue)
where Input is the input stream providing access to the
editor, Char the activating character and Continue must be instantated
with one of the known continuation codes as defined by libedit: norm,
newline, eof, arghack, refresh, refresh_beep, cursor,
redisplay, error or fatal. In
addition, the following Continue code is provided.
- electric(Move, TimeOut, Continue)
- Show electric caret at Move positions to the left of
the normal cursor positions for the given TimeOut. Continue
as defined by the Continue value.
The registered Goal typically used el_line/2
to fetch the input line and el_cursor/2, el_insertstr/2
and/or el_deletestr/2 to
manipulate the input line.
Normally el_bind/2 is used to
associate the defined command with a keyboard sequence.
- See also
el_set(3) EL_ADDFN for details.
