This is the cl-readline Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:37:06 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-readlineCommon Lisp bindings to GNU Readline library
Mark Karpov
GNU GPL, version 3
0.1.1
alexandria (system).
cffi (system).
package.lisp (file).
utils.lisp (file).
ctypes.lisp (file).
cl-readline.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-readline/cl-readline.asdcl-readline/package.lispcl-readline/utils.lispcl-readline/ctypes.lispcl-readline/cl-readline.lispcl-readline/utils.lisppackage.lisp (file).
cl-readline (system).
+c-buffer-size+ (special variable).
+states+ (special variable).
decode-state (function).
decode-version (function).
produce-callback (macro).
produce-callback* (function).
to-array-of-strings (function).
to-list-of-strings (function).
cl-readline/ctypes.lisputils.lisp (file).
cl-readline (system).
history-entry-tclass (class).
cl-readline/cl-readline.lispctypes.lisp (file).
cl-readline (system).
*basic-quote-characters* (symbol macro).
*basic-word-break-characters* (symbol macro).
*blink-matching-paren* (symbol macro).
*catch-signals* (symbol macro).
*catch-sigwinch* (symbol macro).
*change-environment* (symbol macro).
*completer-word-break-characters* (symbol macro).
*completion-append-character* (symbol macro).
*completion-query-items* (symbol macro).
*display-prompt* (symbol macro).
*done* (symbol macro).
*ignore-completion-duplicates* (symbol macro).
*inhibit-completion* (symbol macro).
*line-buffer* (symbol macro).
*mark* (symbol macro).
*point* (symbol macro).
*prefer-env-winsize* (symbol macro).
*readline-name* (symbol macro).
*sort-completion-matches* (symbol macro).
*terminal-name* (symbol macro).
+binding-keymap+ (symbol macro).
+completion-type+ (symbol macro).
+dispatching+ (symbol macro).
+editing-mode+ (symbol macro).
+end+ (symbol macro).
+executing-key+ (symbol macro).
+executing-keymap+ (symbol macro).
+executing-keyseq+ (symbol macro).
+executing-macro+ (symbol macro).
+explicit-arg+ (symbol macro).
+gnu-readline-p+ (symbol macro).
+key-sequence-length+ (symbol macro).
+library-version+ (symbol macro).
+numeric-arg+ (symbol macro).
+prompt+ (symbol macro).
+readline-state+ (symbol macro).
+readline-version+ (symbol macro).
add-defun (function).
add-funmap-entry (function).
add-undo (function).
bind-key (function).
bind-keyseq (function).
cleanup-after-signal (function).
clear-history (function).
clear-pending-input (function).
clear-signals (function).
copy-keymap (function).
crlf (function).
delete-text (function).
deprep-terminal (function).
ding (function).
do-undo (function).
echo-signal-char (function).
execute-next (function).
extend-line-buffer (function).
forced-update-display (function).
free-keymap (function).
free-line-state (function).
free-undo-list (function).
function-dumper (function).
funmap-names (function).
get-keymap (function).
get-keymap-by-name (function).
get-keymap-name (function).
get-screen-size (function).
initialize (function).
insert-text (function).
kill-text (function).
list-funmap-names (function).
macro-dumper (function).
make-keymap (function).
modifying (function).
on-new-line (function).
parse-and-bind (function).
prep-terminal (function).
read-history (function).
read-init-file (function).
read-key (function).
readline (function).
redisplay (function).
register-function (function).
register-hook (function).
replace-line (function).
reset-after-signal (function).
reset-line-state (function).
reset-screen-size (function).
reset-terminal (function).
resize-terminal (function).
set-keyboard-input-timeout (function).
set-keymap (function).
set-paren-blink-timeout (function).
set-prompt (function).
set-screen-size (function).
set-signals (function).
show-char (function).
stuff-char (function).
tty-set-default-bindings (function).
tty-unset-default-bindings (function).
unbind-command (function).
unbind-key (function).
undo-group (macro).
variable-bind (function).
variable-dumper (function).
variable-value (function).
with-message (macro).
with-new-keymap (macro).
write-history (function).
%var-accessor-*already-prompted* (function).
(setf %var-accessor-*already-prompted*) (function).
%var-accessor-*attempted-completion-function* (function).
(setf %var-accessor-*attempted-completion-function*) (function).
%var-accessor-*attempted-completion-over* (function).
(setf %var-accessor-*attempted-completion-over*) (function).
%var-accessor-*basic-quote-characters* (function).
(setf %var-accessor-*basic-quote-characters*) (function).
%var-accessor-*basic-word-break-characters* (function).
(setf %var-accessor-*basic-word-break-characters*) (function).
%var-accessor-*blink-matching-paren* (function).
(setf %var-accessor-*blink-matching-paren*) (function).
%var-accessor-*catch-signals* (function).
(setf %var-accessor-*catch-signals*) (function).
%var-accessor-*catch-sigwinch* (function).
(setf %var-accessor-*catch-sigwinch*) (function).
%var-accessor-*change-environment* (function).
(setf %var-accessor-*change-environment*) (function).
%var-accessor-*completer-word-break-characters* (function).
(setf %var-accessor-*completer-word-break-characters*) (function).
%var-accessor-*completion-append-character* (function).
(setf %var-accessor-*completion-append-character*) (function).
%var-accessor-*completion-display-matches-hook* (function).
(setf %var-accessor-*completion-display-matches-hook*) (function).
%var-accessor-*completion-query-items* (function).
(setf %var-accessor-*completion-query-items*) (function).
%var-accessor-*deprep-term-function* (function).
(setf %var-accessor-*deprep-term-function*) (function).
%var-accessor-*display-prompt* (function).
(setf %var-accessor-*display-prompt*) (function).
%var-accessor-*done* (function).
(setf %var-accessor-*done*) (function).
%var-accessor-*erase-empty-line* (function).
(setf %var-accessor-*erase-empty-line*) (function).
%var-accessor-*event-hook* (function).
(setf %var-accessor-*event-hook*) (function).
%var-accessor-*getc-function* (function).
(setf %var-accessor-*getc-function*) (function).
%var-accessor-*ignore-completion-duplicates* (function).
(setf %var-accessor-*ignore-completion-duplicates*) (function).
%var-accessor-*inhibit-completion* (function).
(setf %var-accessor-*inhibit-completion*) (function).
%var-accessor-*input-available-hook* (function).
(setf %var-accessor-*input-available-hook*) (function).
%var-accessor-*instream* (function).
(setf %var-accessor-*instream*) (function).
%var-accessor-*last-func* (function).
(setf %var-accessor-*last-func*) (function).
%var-accessor-*line-buffer* (function).
(setf %var-accessor-*line-buffer*) (function).
%var-accessor-*mark* (function).
(setf %var-accessor-*mark*) (function).
%var-accessor-*num-chars-to-read* (function).
(setf %var-accessor-*num-chars-to-read*) (function).
%var-accessor-*outstream* (function).
(setf %var-accessor-*outstream*) (function).
%var-accessor-*pending-input* (function).
(setf %var-accessor-*pending-input*) (function).
%var-accessor-*point* (function).
(setf %var-accessor-*point*) (function).
%var-accessor-*pre-input-hook* (function).
(setf %var-accessor-*pre-input-hook*) (function).
%var-accessor-*prefer-env-winsize* (function).
(setf %var-accessor-*prefer-env-winsize*) (function).
%var-accessor-*prep-term-function* (function).
(setf %var-accessor-*prep-term-function*) (function).
%var-accessor-*readline-name* (function).
(setf %var-accessor-*readline-name*) (function).
%var-accessor-*redisplay-function* (function).
(setf %var-accessor-*redisplay-function*) (function).
%var-accessor-*signal-event-hook* (function).
(setf %var-accessor-*signal-event-hook*) (function).
%var-accessor-*sort-completion-matches* (function).
(setf %var-accessor-*sort-completion-matches*) (function).
%var-accessor-*startup-hook* (function).
(setf %var-accessor-*startup-hook*) (function).
%var-accessor-*terminal-name* (function).
(setf %var-accessor-*terminal-name*) (function).
%var-accessor-+binding-keymap+ (function).
(setf %var-accessor-+binding-keymap+) (function).
%var-accessor-+completion-type+ (function).
(setf %var-accessor-+completion-type+) (function).
%var-accessor-+dispatching+ (function).
(setf %var-accessor-+dispatching+) (function).
%var-accessor-+editing-mode+ (function).
(setf %var-accessor-+editing-mode+) (function).
%var-accessor-+end+ (function).
(setf %var-accessor-+end+) (function).
%var-accessor-+executing-key+ (function).
(setf %var-accessor-+executing-key+) (function).
%var-accessor-+executing-keymap+ (function).
(setf %var-accessor-+executing-keymap+) (function).
%var-accessor-+executing-keyseq+ (function).
(setf %var-accessor-+executing-keyseq+) (function).
%var-accessor-+executing-macro+ (function).
(setf %var-accessor-+executing-macro+) (function).
%var-accessor-+explicit-arg+ (function).
(setf %var-accessor-+explicit-arg+) (function).
%var-accessor-+gnu-readline-p+ (function).
(setf %var-accessor-+gnu-readline-p+) (function).
%var-accessor-+history-base+ (function).
(setf %var-accessor-+history-base+) (function).
%var-accessor-+history-length+ (function).
(setf %var-accessor-+history-length+) (function).
%var-accessor-+key-sequence-length+ (function).
(setf %var-accessor-+key-sequence-length+) (function).
%var-accessor-+library-version+ (function).
(setf %var-accessor-+library-version+) (function).
%var-accessor-+numeric-arg+ (function).
(setf %var-accessor-+numeric-arg+) (function).
%var-accessor-+prompt+ (function).
(setf %var-accessor-+prompt+) (function).
%var-accessor-+readline-state+ (function).
(setf %var-accessor-+readline-state+) (function).
%var-accessor-+readline-version+ (function).
(setf %var-accessor-+readline-version+) (function).
*already-prompted* (symbol macro).
*attempted-completion-function* (symbol macro).
*attempted-completion-over* (symbol macro).
*completion-display-matches-hook* (symbol macro).
*deprep-term-function* (symbol macro).
*erase-empty-line* (symbol macro).
*event-hook* (symbol macro).
*getc-function* (symbol macro).
*input-available-hook* (symbol macro).
*instream* (symbol macro).
*last-func* (symbol macro).
*num-chars-to-read* (symbol macro).
*outstream* (symbol macro).
*pending-input* (symbol macro).
*pre-input-hook* (symbol macro).
*prep-term-function* (symbol macro).
*redisplay-function* (symbol macro).
*signal-event-hook* (symbol macro).
*startup-hook* (symbol macro).
+history-base+ (symbol macro).
+history-length+ (symbol macro).
ensure-initialization (function).
recent-history-line-satisfies-p (function).
with-possible-redirection (macro).
Packages are listed by definition order.
cl-readlinerl
alexandria.
cffi.
common-lisp.
*basic-quote-characters* (symbol macro).
*basic-word-break-characters* (symbol macro).
*blink-matching-paren* (symbol macro).
*catch-signals* (symbol macro).
*catch-sigwinch* (symbol macro).
*change-environment* (symbol macro).
*completer-word-break-characters* (symbol macro).
*completion-append-character* (symbol macro).
*completion-query-items* (symbol macro).
*display-prompt* (symbol macro).
*done* (symbol macro).
*ignore-completion-duplicates* (symbol macro).
*inhibit-completion* (symbol macro).
*line-buffer* (symbol macro).
*mark* (symbol macro).
*point* (symbol macro).
*prefer-env-winsize* (symbol macro).
*readline-name* (symbol macro).
*sort-completion-matches* (symbol macro).
*terminal-name* (symbol macro).
+binding-keymap+ (symbol macro).
+completion-type+ (symbol macro).
+dispatching+ (symbol macro).
+editing-mode+ (symbol macro).
+end+ (symbol macro).
+executing-key+ (symbol macro).
+executing-keymap+ (symbol macro).
+executing-keyseq+ (symbol macro).
+executing-macro+ (symbol macro).
+explicit-arg+ (symbol macro).
+gnu-readline-p+ (symbol macro).
+key-sequence-length+ (symbol macro).
+library-version+ (symbol macro).
+numeric-arg+ (symbol macro).
+prompt+ (symbol macro).
+readline-state+ (symbol macro).
+readline-version+ (symbol macro).
add-defun (function).
add-funmap-entry (function).
add-undo (function).
bind-key (function).
bind-keyseq (function).
cleanup-after-signal (function).
clear-history (function).
clear-pending-input (function).
clear-signals (function).
copy-keymap (function).
crlf (function).
delete-text (function).
deprep-terminal (function).
ding (function).
do-undo (function).
echo-signal-char (function).
execute-next (function).
extend-line-buffer (function).
forced-update-display (function).
free-keymap (function).
free-line-state (function).
free-undo-list (function).
function-dumper (function).
funmap-names (function).
get-keymap (function).
get-keymap-by-name (function).
get-keymap-name (function).
get-screen-size (function).
initialize (function).
insert-text (function).
kill-text (function).
list-funmap-names (function).
macro-dumper (function).
make-keymap (function).
modifying (function).
on-new-line (function).
parse-and-bind (function).
prep-terminal (function).
read-history (function).
read-init-file (function).
read-key (function).
readline (function).
redisplay (function).
register-function (function).
register-hook (function).
replace-line (function).
reset-after-signal (function).
reset-line-state (function).
reset-screen-size (function).
reset-terminal (function).
resize-terminal (function).
set-keyboard-input-timeout (function).
set-keymap (function).
set-paren-blink-timeout (function).
set-prompt (function).
set-screen-size (function).
set-signals (function).
show-char (function).
stuff-char (function).
tty-set-default-bindings (function).
tty-unset-default-bindings (function).
unbind-command (function).
unbind-key (function).
undo-group (macro).
variable-bind (function).
variable-dumper (function).
variable-value (function).
with-message (macro).
with-new-keymap (macro).
write-history (function).
%var-accessor-*already-prompted* (function).
(setf %var-accessor-*already-prompted*) (function).
%var-accessor-*attempted-completion-function* (function).
(setf %var-accessor-*attempted-completion-function*) (function).
%var-accessor-*attempted-completion-over* (function).
(setf %var-accessor-*attempted-completion-over*) (function).
%var-accessor-*basic-quote-characters* (function).
(setf %var-accessor-*basic-quote-characters*) (function).
%var-accessor-*basic-word-break-characters* (function).
(setf %var-accessor-*basic-word-break-characters*) (function).
%var-accessor-*blink-matching-paren* (function).
(setf %var-accessor-*blink-matching-paren*) (function).
%var-accessor-*catch-signals* (function).
(setf %var-accessor-*catch-signals*) (function).
%var-accessor-*catch-sigwinch* (function).
(setf %var-accessor-*catch-sigwinch*) (function).
%var-accessor-*change-environment* (function).
(setf %var-accessor-*change-environment*) (function).
%var-accessor-*completer-word-break-characters* (function).
(setf %var-accessor-*completer-word-break-characters*) (function).
%var-accessor-*completion-append-character* (function).
(setf %var-accessor-*completion-append-character*) (function).
%var-accessor-*completion-display-matches-hook* (function).
(setf %var-accessor-*completion-display-matches-hook*) (function).
%var-accessor-*completion-query-items* (function).
(setf %var-accessor-*completion-query-items*) (function).
%var-accessor-*deprep-term-function* (function).
(setf %var-accessor-*deprep-term-function*) (function).
%var-accessor-*display-prompt* (function).
(setf %var-accessor-*display-prompt*) (function).
%var-accessor-*done* (function).
(setf %var-accessor-*done*) (function).
%var-accessor-*erase-empty-line* (function).
(setf %var-accessor-*erase-empty-line*) (function).
%var-accessor-*event-hook* (function).
(setf %var-accessor-*event-hook*) (function).
%var-accessor-*getc-function* (function).
(setf %var-accessor-*getc-function*) (function).
%var-accessor-*ignore-completion-duplicates* (function).
(setf %var-accessor-*ignore-completion-duplicates*) (function).
%var-accessor-*inhibit-completion* (function).
(setf %var-accessor-*inhibit-completion*) (function).
%var-accessor-*input-available-hook* (function).
(setf %var-accessor-*input-available-hook*) (function).
%var-accessor-*instream* (function).
(setf %var-accessor-*instream*) (function).
%var-accessor-*last-func* (function).
(setf %var-accessor-*last-func*) (function).
%var-accessor-*line-buffer* (function).
(setf %var-accessor-*line-buffer*) (function).
%var-accessor-*mark* (function).
(setf %var-accessor-*mark*) (function).
%var-accessor-*num-chars-to-read* (function).
(setf %var-accessor-*num-chars-to-read*) (function).
%var-accessor-*outstream* (function).
(setf %var-accessor-*outstream*) (function).
%var-accessor-*pending-input* (function).
(setf %var-accessor-*pending-input*) (function).
%var-accessor-*point* (function).
(setf %var-accessor-*point*) (function).
%var-accessor-*pre-input-hook* (function).
(setf %var-accessor-*pre-input-hook*) (function).
%var-accessor-*prefer-env-winsize* (function).
(setf %var-accessor-*prefer-env-winsize*) (function).
%var-accessor-*prep-term-function* (function).
(setf %var-accessor-*prep-term-function*) (function).
%var-accessor-*readline-name* (function).
(setf %var-accessor-*readline-name*) (function).
%var-accessor-*redisplay-function* (function).
(setf %var-accessor-*redisplay-function*) (function).
%var-accessor-*signal-event-hook* (function).
(setf %var-accessor-*signal-event-hook*) (function).
%var-accessor-*sort-completion-matches* (function).
(setf %var-accessor-*sort-completion-matches*) (function).
%var-accessor-*startup-hook* (function).
(setf %var-accessor-*startup-hook*) (function).
%var-accessor-*terminal-name* (function).
(setf %var-accessor-*terminal-name*) (function).
%var-accessor-+binding-keymap+ (function).
(setf %var-accessor-+binding-keymap+) (function).
%var-accessor-+completion-type+ (function).
(setf %var-accessor-+completion-type+) (function).
%var-accessor-+dispatching+ (function).
(setf %var-accessor-+dispatching+) (function).
%var-accessor-+editing-mode+ (function).
(setf %var-accessor-+editing-mode+) (function).
%var-accessor-+end+ (function).
(setf %var-accessor-+end+) (function).
%var-accessor-+executing-key+ (function).
(setf %var-accessor-+executing-key+) (function).
%var-accessor-+executing-keymap+ (function).
(setf %var-accessor-+executing-keymap+) (function).
%var-accessor-+executing-keyseq+ (function).
(setf %var-accessor-+executing-keyseq+) (function).
%var-accessor-+executing-macro+ (function).
(setf %var-accessor-+executing-macro+) (function).
%var-accessor-+explicit-arg+ (function).
(setf %var-accessor-+explicit-arg+) (function).
%var-accessor-+gnu-readline-p+ (function).
(setf %var-accessor-+gnu-readline-p+) (function).
%var-accessor-+history-base+ (function).
(setf %var-accessor-+history-base+) (function).
%var-accessor-+history-length+ (function).
(setf %var-accessor-+history-length+) (function).
%var-accessor-+key-sequence-length+ (function).
(setf %var-accessor-+key-sequence-length+) (function).
%var-accessor-+library-version+ (function).
(setf %var-accessor-+library-version+) (function).
%var-accessor-+numeric-arg+ (function).
(setf %var-accessor-+numeric-arg+) (function).
%var-accessor-+prompt+ (function).
(setf %var-accessor-+prompt+) (function).
%var-accessor-+readline-state+ (function).
(setf %var-accessor-+readline-state+) (function).
%var-accessor-+readline-version+ (function).
(setf %var-accessor-+readline-version+) (function).
*already-prompted* (symbol macro).
*attempted-completion-function* (symbol macro).
*attempted-completion-over* (symbol macro).
*completion-display-matches-hook* (symbol macro).
*deprep-term-function* (symbol macro).
*erase-empty-line* (symbol macro).
*event-hook* (symbol macro).
*getc-function* (symbol macro).
*input-available-hook* (symbol macro).
*instream* (symbol macro).
*last-func* (symbol macro).
*num-chars-to-read* (symbol macro).
*outstream* (symbol macro).
*pending-input* (symbol macro).
*pre-input-hook* (symbol macro).
*prep-term-function* (symbol macro).
*redisplay-function* (symbol macro).
*signal-event-hook* (symbol macro).
*startup-hook* (symbol macro).
+c-buffer-size+ (special variable).
+history-base+ (symbol macro).
+history-length+ (symbol macro).
+states+ (special variable).
decode-state (function).
decode-version (function).
ensure-initialization (function).
history-entry-tclass (class).
produce-callback (macro).
produce-callback* (function).
recent-history-line-satisfies-p (function).
to-array-of-strings (function).
to-list-of-strings (function).
with-possible-redirection (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
All insertion and deletion inside this macro will be grouped together into one undo operation.
Show message MESSAGE in the echo area while executing BODY. If SAVE-PROMPT is not NIL, save prompt before showing the message and restore it before clearing the message.
Create new keymap evaluating FORM, bind symbol ‘keymap’ to the result, then free it when control flow leaves BODY. ‘make-keymap’ and ‘copy-keymap’ can be used to produce new keymap.
Add NAME to the list of named functions. Make FUNCTION be the function that gets called. If KEY is not NIL and it’s a character, then bind it to function using ‘bind-key’. FUNCTION must be able to take two arguments: integer representing its argument and character representing key that has invoked it.
Add NAME to the list of bindable Readline command names, and make FUNCTION the function to be called when name is invoked.
Remember how to undo an event (according to WHAT). The affected text runs from START to END, and encompasses TEXT. Possible values of WHAT include: :UNDO-DELETE, :UNDO-INSERT, :UNDO-BEGIN, and :UNDO-END.
Bind KEY to FUNCTION in the currently active keymap. If KEYMAP argument supplied, binding takes place in specified keymap. If IF-UNBOUND is supplied and it’s not NIL, KEY will be bound to FUNCTION only if it’s not already bound.
Bind the key sequence represented by the string KEYSEQ to the function FUNCTION, beginning in the current keymap. This makes new keymaps as necessary. If KEYMAP is supplied and it’s not NIL, initial bindings are performed in KEYMAP. If IF-UNBOUND is supplied and it’s not NIL, KEYSEQ will be bound to FUNCTION only if it’s not already bound. The return value is T if KEYSEQ is invalid and NIL otherwise.
This function will reset the state of the terminal to what it was before ‘readline’ was called, and remove the Readline signal handlers for all signals, depending on the values of ‘*catch-signals*’ and ‘*catch-sigwinch*’.
Clear the history list by deleting all of the entries.
Negate the effect of any previous call to ‘execute-next’. This works only if the pending input has not already been read with ‘read-key’.
Remove all of the Readline signal handlers installed by ‘set-signals’.
Return a new keymap which is a copy of KEYMAP.
Move the cursor to the start of the next screen line.
Delete the text between START and END in the current line. Return the number of characters deleted.
Undo the effects of ‘prep-terminal’, leaving the terminal in the state in which it was before the most recent call to ‘prep-terminal’.
Ring the terminal bell, obeying the setting of bell-style.
Undo the first thing on the undo list. Returns NIL if there was nothing to undo, T if something was undone.
If an application wishes to install its own signal handlers, but still have readline display characters that generate signals, calling this function with SIG set to :SIGINT, :SIGQUIT, or :SIGTSTP will display the character generating that signal.
Make CHAR be the next command to be executed when ‘read-key’ is called.
Ensure that line buffer has enough space to hold LEN characters, possibly reallocating it if necessary.
Force the line to be updated and redisplayed, whether or not Readline thinks the screen display is correct.
Free all storage associated with KEYMAP.
This will free any partial state associated with the current input
line (undo information, any partial history entry, any partially-entered
keyboard macro, and any partially-entered numeric argument). This should be
called before ‘cleanup-after-signal.’ The Readline signal handler for SIGINT
calls this to abort the current input line.
Free the existing undo list.
Print the Readline function names and the key sequences currently bound to them to stdout. If READABLE is non-NIL, the list is formatted in such a way that it can be made part of an inputrc file and re-read. If FILENAME is supplied and it’s a string or path, output will be redirected to the file. APPEND allows to append text to the file instead of overwriting it.
Return a list of known function names. The list is sorted.
Return currently active keymap.
Return the keymap matching NAME. NAME is one which would be supplied in a set keymap inputrc line.
Return the name matching KEYMAP. Name is one which would be supplied in a set keymap inputrc line.
Return Readline’s idea of the terminal’s size. The function returns multiple values: number of rows and columns.
Initialize or re-initialize Readline’s internal state. It’s not strictly necessary to call this; ‘readline’ calls it before reading any input.
Insert TEXT into the line at the current cursor position. Return the number of characters inserted.
Copy the text between START and END in the current line to the kill ring, appending or prepending to the last kill if the last command was a kill command. The text is deleted. If START is less than END, the text is appended, otherwise prepended. If the last command was not a kill, a new kill ring slot is used.
Print the names of all bindable Readline functions to stdout. If FILENAME is supplied and it’s a string or path, output will be redirected to the file. APPEND allows append text to the file instead of overwriting it.
Print the key sequences bound to macros and their values, using the current keymap to stdout. If READABLE is non-NIL, the list is formatted in such a way that it can be made part of an inputrc file and re-read. If FILENAME is supplied and it’s a string or path, output will be redirected to the file. APPEND allows to append text to the file instead of overwriting it.
Return a new keymap with self-inserting printing characters, the lowercase Meta characters bound to run their equivalents, and the Meta digits bound to produce numeric arguments. If BARE is supplied and it’s not NIL, empty keymap will be returned.
Tell Readline to save the text between START and END as a single undo unit. It is assumed that you will subsequently modify that text.
Tell the update functions that we have moved onto a new (empty) line, usually after outputting a newline. When WITH-PROMPT is not NIL, Readline will think that prompt is already displayed. This could be used by applications that want to output the prompt string themselves, but still need Readline to know the prompt string length for redisplay. This should be used together with :ALREADY-PROMPTED keyword argument of ‘readline’.
Parse LINE as if it had been read from the inputrc file and perform any key bindings and variable assignments found.
Modify the terminal settings for Readline’s use, so ‘readline’ can read a single character at a time from the keyboard. The EIGHT-BIT-INPUT argument should be non-NIL if Readline should read eight-bit input.
Add the contents of filename to the history list, a line at a time.
Read keybindings and variable assignments from FILENAME.
Return the next character available from Readline’s current input stream.
Get a line from user with editing. PROMPT, if supplied, is printed before
reading of input. Non-NIL value of ALREADY-PROMPTED will tell Readline that
the application has printed prompt already. However, PROMPT must be supplied
in this case too, so redisplay functions can update the display properly. If
NUM-CHARS argument is a positive number, Readline will return after
accepting that many characters. If ERASE-EMPTY-LINE is not NIL, ‘readline’
will completely erase the current line, including any prompt, any time a
newline is typed as the only character on an otherwise-empty line. The
cursor is moved to the beginning of the newly-blank line. Supplying
ADD-HISTORY tells Readline that user’s input should be added to
history. However, blank lines don’t get into history anyway. NOVELTY-CHECK,
if given, must be a predicate that takes two strings: the actual line and
the most recent history line. Only when the predicate evaluates to non-NIL
value new line will be added to the history. Return value on success is the
actual string and NIL on failure.
Change what’s displayed on the screen to reflect the current contents of ‘*line-buffer*’.
Register a function. FUNC should be a keyword, one of the following:
:GETC function is used to get a character from the input stream, thus
FUNCTION should take pointer to C stream and return a character if this
function is desired to be registered. In general, an application that
registers :GETC function should consider registering :INPUTP hook as
well (see REGISTER-HOOK).
:REDISPLAY function is used to update the display with the current contents
of the editing buffer, thus FUNCTION should take no arguments and return NIL
on success and non-NIL of failure. By default, it is set to REDISPLAY, the
default Readline redisplay function.
:PREP-TERM function is used to initialize the terminal, so FUNCTION must be
able to take one argument, a flag that says whether or not to use eight-bit
characters. By default, PREP-TERMINAL is used.
:DEPREP-TERM function is used to reset the terminal. This function should
undo the effects of :PREP-TERM function.
:COMPLETE function is used to generate list of possible completions for
given partially entered word. The function must be able to take three
arguments: partially entered word, start index of the word in *LINE-BUFFER*
and end index of the word in the buffer. The function must return a list
where first element is the actual completion (or part of completion if two
or more completions share common prefix) and the rest arguments are possible
completions.
Other values of FUNC will be ignored.
FUNCTION must be a function, if FUNCTION is NIL, result is unpredictable.
Register a hook. HOOK should be a keyword, one of the following:
:STARTUP hook is called just before READLINE prints the prompt.
:PRE-INPUT hook is called after prompt has been printed and just before
READLINE starts reading input characters.
:EVENT hook is called periodically when waiting for terminal input. By
default, this will be called at most ten times a second if there is no
keyboard input.
:SIGNAL hook is called when a read system call is interrupted when
READLINE is reading terminal input.
:INPUTP hook is called when Readline need to determine whether or not there
is available input on the current input source. If FUNCTION returns NIL, it
means that there is no available input.
:LSMATCHES hook is called to display list of completions. FUNCTION must be
able to take three arguments: list of completions, length of the list, and
length of the longest completion in the list. It’s up to the function how to
display these completions.
Other values of HOOK will be ignored.
FUNCTION must be a function that takes no arguments and returns NIL on success and T on failure. If FUNCTION is NIL, hook will be removed (or default function will be used).
Replace the contents of ‘*line-buffer*’ with TEXT. The point and mark are preserved, if possible. If CLEAR-UNDO is non-NIL, the undo list associated with the current line is cleared.
This will reinitialize the terminal and reinstall any Readline signal handlers, depending on the values of ‘*catch-signals*’ and ‘*catch-sigwinch*’.
Reset the display state to a clean state and redisplay the current line starting on a new line.
Cause Readline to reobtain the screen size and recalculate its dimensions.
Reinitialize Readline’s idea of the terminal settings using TERMINAL as the terminal type (e.g., vt100).
Update Readline’s internal screen size by reading values from the kernel.
While waiting for keyboard input in ‘read-key’, Readline will wait for U microseconds for input before calling any function assigned to ‘event-hook’. U must be greater than or equal to zero (a zero-length timeout is equivalent to a poll). The default waiting period is one-tenth of a second. Return the old timeout value.
Make KEYMAP the currently active keymap.
Set the time interval (in microseconds) that Readline waits when showing a balancing character when ’blink-matching-paren’ has been enabled. The function returns previous value of the parameter.
Make Readline use PROMPT for subsequent redisplay. This calls ‘expand-prompt’ to expand the prompt and sets ‘+prompt+’ to the result.
Set Readline’s idea of the terminal size to ROWS rows and COLS columns. If either rows or columns is less than or equal to 0, Readline’s idea of that terminal dimension is unchanged.
Install Readline’s signal handler for SIGINT, SIGQUIT, SIGTERM, SIGHUP, SIGALRM, SIGTSTP, SIGTTIN, SIGTTOU, and SIGWINCH, depending on the values of ‘*catch-signals*’ and ‘*catch-sigwinch*’.
Display character CHAR on outstream. If Readline has not been set to display meta characters directly, this will convert meta characters to a meta-prefixed key sequence. This is intended for use by applications which wish to do their own redisplay.
Insert CHAR into the Readline input stream. It will be «read» before Readline attempts to read characters from the terminal with ‘read-key’. Up to 512 characters may be pushed back. ‘stuff-char’ returns T if the character was successfully inserted; NIL otherwise.
Read the operating system’s terminal editing characters (as would be displayed by stty) to their Readline equivalents. The bindings are performed in KEYMAP.
Reset the bindings manipulated by ‘tty-set-default-bindings’ so that the terminal editing characters are bound to ‘insert’. The bindings are performed in KEYMAP.
Unbind all keys that are bound to COMMAND in KEYMAP.
Unbind KEY in KEYMAP. If KEYMAP is not supplied or it’s NIL, KEY will be unbound in currently active keymap. The function returns NIL on success and T on failure.
Make the Readline variable VARIABLE have VALUE. This behaves as if the readline command ’set variable value’ had been executed in an inputrc file.
Print the readline variable names and their current values to stdout. If readable is not NIL, the list is formatted in such a way that it can be made part of an inputrc file and re-read. If FILENAME is supplied and it’s a string or path, output will be redirected to the file. APPEND allows to append text to the file instead of overwriting it.
Return a string representing the value of the Readline variable VARIABLE. For Boolean variables, this string is either ’on’ or ’off’.
Write the current history to filename, overwriting filename if necessary.
How many bytes to allocate per Lisp string when converting list of Lisp strings into array of C strings.
Possible state values for ‘+readline-state+’.
Return pointer to callback that calls FUNCTION. RETURN-TYPE specifies return type of the function and FUNC-ARG-LIST is list of argument types (it can be ommited if FUNCTION doesn’t take any arguments).
If FILENAME is not NIL, try to create C file named FILENAME,
temporarily reassign ‘*outstream*’ to pointer to this file, perform BODY,
then close the file and assign ‘*outstream*’ the old value. If APPEND is not
NIL, output will be appended to the file. Returns NIL on success and T on
failure.
Transform Readline state STATE into list of keywords. See ‘+states+’ for list of components that can appear in result list.
Transform VERSION into two values representing major and minor numbers of Readline library version.
Make sure that Readline is initialized. If it’s not initialized yet, initialize it.
Variant of PRODUCE-CALLBACK that should hopefully be more portable.
This avoids using a GENSYM as the name of a callback, and is also funcallable.
Check if the most recent history line satisfies given predicate PREDICATE. Return T if there is no history saved.
Convert a list of Lisp strings LIST into null-terminated array of C strings. Memory for every string and the array itself should be freed with ‘free’ (C function). If LIST is NIL, null pointer will be returned.
Convert a null-terminated array of pointers to chars that POINTER points to into list of Lisp strings.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
A B C D E F G I K L M O P R S T U V W |
|---|
| Jump to: | %
(
A B C D E F G I K L M O P R S T U V W |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | C F H P S U |
|---|
| Jump to: | C F H P S U |
|---|