The cl-readline Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-readline Reference Manual

This is the cl-readline Reference Manual, version 0.1.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:21:07 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-readline

License GPL 3 Build Status Quicklisp

Common Lisp bindings to GNU Readline library.

The Readline library provides a set of functions for use by applications that allow users to edit command lines as they are typed in. Both Emacs and vi editing modes are available. The Readline library includes additional functions to maintain a list of previously-entered command lines, to recall and perhaps reedit those lines, and perform csh-like history expansion on previous commands.

These bindings provide a Lispy interface to GNU Readline somewhat reducing the pain you are bound to experience when you use it. Some minor features are omitted, they may be added on request. Open an issue if you have any propositions.

Installation

Via Quicklisp (recommended):

(ql:quickload "cl-readline")

If you are using Homebrew on a Mac, please note that GNU Readline has keg-only formula, which means you may need to link the library yourself:

$ brew link readline --force

Documentation

See contents of the directory doc. Documentation is also available online:

https://vindarel.github.io/cl-readline/

See also our cl-readline-example and a list of projects using the library on the wiki.

License

Copyright © 2015–2018 Mark Karpov

Distributed under GNU GPL, version


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-readline

Author

Mark Karpov

License

GNU GPL, version 3

Description

Common Lisp bindings to GNU Readline library

Version

0.1.1

Dependencies
Source

cl-readline.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-readline.asd

Location

cl-readline.asd

Systems

cl-readline (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-readline/package.lisp

Parent

cl-readline (system)

Location

package.lisp

Packages

cl-readline


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-readline/utils.lisp

Dependency

package.lisp (file)

Parent

cl-readline (system)

Location

utils.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-readline/ctypes.lisp

Dependency

utils.lisp (file)

Parent

cl-readline (system)

Location

ctypes.lisp

Internal Definitions

history-entry-tclass (class)


Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-readline/cl-readline.lisp

Dependency

ctypes.lisp (file)

Parent

cl-readline (system)

Location

cl-readline.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-readline

Source

package.lisp (file)

Nickname

rl

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Symbol macros

Symbol Macro: *basic-quote-characters*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*basic-quote-characters*)

Symbol Macro: *basic-word-break-characters*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*basic-word-break-characters*)

Symbol Macro: *catch-signals*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*catch-signals*)

Symbol Macro: *catch-sigwinch*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*catch-sigwinch*)

Symbol Macro: *change-environment*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*change-environment*)

Symbol Macro: *completer-word-break-characters*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*completer-word-break-characters*)

Symbol Macro: *completion-append-character*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*completion-append-character*)

Symbol Macro: *completion-query-items*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*completion-query-items*)

Symbol Macro: *display-prompt*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*display-prompt*)

Symbol Macro: *done*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*done*)

Symbol Macro: *ignore-completion-duplicates*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*ignore-completion-duplicates*)

Symbol Macro: *inhibit-completion*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*inhibit-completion*)

Symbol Macro: *line-buffer*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*line-buffer*)

Symbol Macro: *mark*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*mark*)

Symbol Macro: *point*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*point*)

Symbol Macro: *prefer-env-winsize*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*prefer-env-winsize*)

Symbol Macro: *readline-name*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*readline-name*)

Symbol Macro: *sort-completion-matches*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*sort-completion-matches*)

Symbol Macro: *terminal-name*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*terminal-name*)

Symbol Macro: +binding-keymap+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+binding-keymap+)

Symbol Macro: +completion-type+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+completion-type+)

Symbol Macro: +dispatching+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+dispatching+)

Symbol Macro: +editing-mode+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+editing-mode+)

Symbol Macro: +end+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+end+)

Symbol Macro: +executing-key+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+executing-key+)

Symbol Macro: +executing-keymap+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+executing-keymap+)

Symbol Macro: +executing-keyseq+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+executing-keyseq+)

Symbol Macro: +executing-macro+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+executing-macro+)

Symbol Macro: +explicit-arg+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+explicit-arg+)

Symbol Macro: +gnu-readline-p+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+gnu-readline-p+)

Symbol Macro: +key-sequence-length+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+key-sequence-length+)

Symbol Macro: +library-version+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+library-version+)

Symbol Macro: +numeric-arg+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+numeric-arg+)

Symbol Macro: +prompt+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+prompt+)

Symbol Macro: +readline-state+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+readline-state+)

Symbol Macro: +readline-version+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+readline-version+)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: undo-group &body BODY

All insertion and deletion inside this macro will be grouped together into one undo operation.

Package

cl-readline

Source

cl-readline.lisp (file)

Macro: with-message MESSAGE SAVE-PROMPT &body BODY

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Macro: with-new-keymap FORM &body BODY

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.

Package

cl-readline

Source

cl-readline.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: add-defun NAME FUNCTION &optional KEY

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: add-funmap-entry NAME FUNCTION

Add NAME to the list of bindable Readline command names, and make FUNCTION the function to be called when name is invoked.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: add-undo WHAT START END TEXT

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: bind-key KEY FUNCTION &key KEYMAP IF-UNBOUND

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: bind-keyseq KEYSEQ FUNCTION &key KEYMAP IF-UNBOUND

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: cleanup-after-signal ()

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*’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: clear-history ()

Clear the history list by deleting all of the entries.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: clear-pending-input ()

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’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: clear-signals ()

Remove all of the Readline signal handlers installed by ‘set-signals’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: copy-keymap KEYMAP

Return a new keymap which is a copy of KEYMAP.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: crlf ()

Move the cursor to the start of the next screen line.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: delete-text START END

Delete the text between START and END in the current line. Return the number of characters deleted.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: deprep-terminal ()

Undo the effects of ‘prep-terminal’, leaving the terminal in the state in which it was before the most recent call to ‘prep-terminal’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: ding ()

Ring the terminal bell, obeying the setting of bell-style.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: do-undo ()

Undo the first thing on the undo list. Returns NIL if there was nothing to undo, T if something was undone.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: echo-signal-char SIG

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: execute-next CHAR

Make CHAR be the next command to be executed when ‘read-key’ is called.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: extend-line-buffer LEN

Ensure that line buffer has enough space to hold LEN characters, possibly reallocating it if necessary.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: forced-update-display ()

Force the line to be updated and redisplayed, whether or not Readline thinks the screen display is correct.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: free-keymap KEYMAP

Free all storage associated with KEYMAP.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: free-line-state ()

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: free-undo-list ()

Free the existing undo list.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: function-dumper READABLE &optional FILENAME APPEND

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: funmap-names ()

Return a list of known function names. The list is sorted.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: get-keymap ()

Return currently active keymap.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: get-keymap-by-name NAME

Return the keymap matching NAME. NAME is one which would be supplied in a set keymap inputrc line.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: get-keymap-name KEYMAP

Return the name matching KEYMAP. Name is one which would be supplied in a set keymap inputrc line.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: get-screen-size ()

Return Readline’s idea of the terminal’s size. The function returns multiple values: number of rows and columns.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: initialize ()

Initialize or re-initialize Readline’s internal state. It’s not strictly necessary to call this; ‘readline’ calls it before reading any input.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: insert-text TEXT

Insert TEXT into the line at the current cursor position. Return the number of characters inserted.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: kill-text START END

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: list-funmap-names &optional FILENAME APPEND

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: macro-dumper READABLE &optional FILENAME APPEND

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: make-keymap &optional BARE

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: modifying START END

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: on-new-line &optional WITH-PROMPT

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’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: parse-and-bind LINE

Parse LINE as if it had been read from the inputrc file and perform any key bindings and variable assignments found.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: prep-terminal EIGHT-BIT-INPUT

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: read-init-file FILENAME

Read keybindings and variable assignments from FILENAME.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: read-key ()

Return the next character available from Readline’s current input stream.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: readline &key PROMPT ALREADY-PROMPTED NUM-CHARS ERASE-EMPTY-LINE ADD-HISTORY NOVELTY-CHECK

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: redisplay ()

Change what’s displayed on the screen to reflect the current contents of ‘*line-buffer*’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: register-function FUNC FUNCTION

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: register-hook HOOK FUNCTION

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).

Package

cl-readline

Source

cl-readline.lisp (file)

Function: replace-line TEXT CLEAR-UNDO

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: reset-after-signal ()

This will reinitialize the terminal and reinstall any Readline signal handlers, depending on the values of ‘*catch-signals*’ and ‘*catch-sigwinch*’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: reset-line-state ()

Reset the display state to a clean state and redisplay the current line starting on a new line.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: reset-screen-size ()

Cause Readline to reobtain the screen size and recalculate its dimensions.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: reset-terminal TERMINAL

Reinitialize Readline’s idea of the terminal settings using TERMINAL as the terminal type (e.g., vt100).

Package

cl-readline

Source

cl-readline.lisp (file)

Function: resize-terminal ()

Update Readline’s internal screen size by reading values from the kernel.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: set-keyboard-input-timeout U

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: set-keymap KEYMAP

Make KEYMAP the currently active keymap.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: set-paren-blink-timeout MICROS

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: set-prompt PROMPT

Make Readline use PROMPT for subsequent redisplay. This calls ‘expand-prompt’ to expand the prompt and sets ‘+prompt+’ to the result.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: set-screen-size ROWS COLS

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: set-signals ()

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*’.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: show-char CHAR

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: stuff-char CHAR

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: tty-set-default-bindings KEYMAP

Read the operating system’s terminal editing characters (as would be displayed by stty) to their Readline equivalents. The bindings are performed in KEYMAP.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: tty-unset-default-bindings 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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: unbind-command COMMAND KEYMAP

Unbind all keys that are bound to COMMAND in KEYMAP.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: unbind-key KEY &optional 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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: variable-bind VARIABLE VALUE

Make the Readline variable VARIABLE have VALUE. This behaves as if the readline command ’set variable value’ had been executed in an inputrc file.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: variable-dumper READABLE &optional FILENAME APPEND

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.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: variable-value VARIABLE

Return a string representing the value of the Readline variable VARIABLE. For Boolean variables, this string is either ’on’ or ’off’.

Package

cl-readline

Source

cl-readline.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: +c-buffer-size+

How many bytes to allocate per Lisp string when converting list of Lisp strings into array of C strings.

Package

cl-readline

Source

utils.lisp (file)

Special Variable: +states+

Possible state values for ‘+readline-state+’.

Package

cl-readline

Source

utils.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Symbol macros

Symbol Macro: *already-prompted*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*already-prompted*)

Symbol Macro: *attempted-completion-function*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*attempted-completion-function*)

Symbol Macro: *attempted-completion-over*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*attempted-completion-over*)

Symbol Macro: *completion-display-matches-hook*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*completion-display-matches-hook*)

Symbol Macro: *deprep-term-function*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*deprep-term-function*)

Symbol Macro: *erase-empty-line*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*erase-empty-line*)

Symbol Macro: *event-hook*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*event-hook*)

Symbol Macro: *getc-function*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*getc-function*)

Symbol Macro: *input-available-hook*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*input-available-hook*)

Symbol Macro: *instream*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*instream*)

Symbol Macro: *last-func*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*last-func*)

Symbol Macro: *num-chars-to-read*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*num-chars-to-read*)

Symbol Macro: *outstream*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*outstream*)

Symbol Macro: *pending-input*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*pending-input*)

Symbol Macro: *pre-input-hook*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*pre-input-hook*)

Symbol Macro: *prep-term-function*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*prep-term-function*)

Symbol Macro: *redisplay-function*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*redisplay-function*)

Symbol Macro: *signal-event-hook*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*signal-event-hook*)

Symbol Macro: *startup-hook*
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-*startup-hook*)

Symbol Macro: +history-base+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+history-base+)

Symbol Macro: +history-length+
Package

cl-readline

Source

cl-readline.lisp (file)

Expansion

(cl-readline::%var-accessor-+history-length+)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: produce-callback FUNCTION RETURN-TYPE &optional FUNC-ARG-LIST

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).

Package

cl-readline

Source

utils.lisp (file)

Macro: with-possible-redirection FILENAME APPEND &body BODY

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.

Package

cl-readline

Source

cl-readline.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: %var-accessor-*already-prompted* ()
Function: (setf %var-accessor-*already-prompted*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*attempted-completion-function* ()
Function: (setf %var-accessor-*attempted-completion-function*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*attempted-completion-over* ()
Function: (setf %var-accessor-*attempted-completion-over*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*basic-quote-characters* ()
Function: (setf %var-accessor-*basic-quote-characters*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*basic-word-break-characters* ()
Function: (setf %var-accessor-*basic-word-break-characters*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*catch-signals* ()
Function: (setf %var-accessor-*catch-signals*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*catch-sigwinch* ()
Function: (setf %var-accessor-*catch-sigwinch*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*change-environment* ()
Function: (setf %var-accessor-*change-environment*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*completer-word-break-characters* ()
Function: (setf %var-accessor-*completer-word-break-characters*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*completion-append-character* ()
Function: (setf %var-accessor-*completion-append-character*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*completion-display-matches-hook* ()
Function: (setf %var-accessor-*completion-display-matches-hook*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*completion-query-items* ()
Function: (setf %var-accessor-*completion-query-items*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*deprep-term-function* ()
Function: (setf %var-accessor-*deprep-term-function*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*display-prompt* ()
Function: (setf %var-accessor-*display-prompt*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*done* ()
Function: (setf %var-accessor-*done*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*erase-empty-line* ()
Function: (setf %var-accessor-*erase-empty-line*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*event-hook* ()
Function: (setf %var-accessor-*event-hook*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*getc-function* ()
Function: (setf %var-accessor-*getc-function*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*ignore-completion-duplicates* ()
Function: (setf %var-accessor-*ignore-completion-duplicates*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*inhibit-completion* ()
Function: (setf %var-accessor-*inhibit-completion*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*input-available-hook* ()
Function: (setf %var-accessor-*input-available-hook*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*instream* ()
Function: (setf %var-accessor-*instream*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*last-func* ()
Function: (setf %var-accessor-*last-func*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*line-buffer* ()
Function: (setf %var-accessor-*line-buffer*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*mark* ()
Function: (setf %var-accessor-*mark*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*num-chars-to-read* ()
Function: (setf %var-accessor-*num-chars-to-read*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*outstream* ()
Function: (setf %var-accessor-*outstream*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*pending-input* ()
Function: (setf %var-accessor-*pending-input*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*point* ()
Function: (setf %var-accessor-*point*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*pre-input-hook* ()
Function: (setf %var-accessor-*pre-input-hook*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*prefer-env-winsize* ()
Function: (setf %var-accessor-*prefer-env-winsize*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*prep-term-function* ()
Function: (setf %var-accessor-*prep-term-function*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*readline-name* ()
Function: (setf %var-accessor-*readline-name*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*redisplay-function* ()
Function: (setf %var-accessor-*redisplay-function*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*signal-event-hook* ()
Function: (setf %var-accessor-*signal-event-hook*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*sort-completion-matches* ()
Function: (setf %var-accessor-*sort-completion-matches*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*startup-hook* ()
Function: (setf %var-accessor-*startup-hook*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-*terminal-name* ()
Function: (setf %var-accessor-*terminal-name*) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+binding-keymap+ ()
Function: (setf %var-accessor-+binding-keymap+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+completion-type+ ()
Function: (setf %var-accessor-+completion-type+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+dispatching+ ()
Function: (setf %var-accessor-+dispatching+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+editing-mode+ ()
Function: (setf %var-accessor-+editing-mode+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+end+ ()
Function: (setf %var-accessor-+end+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+executing-key+ ()
Function: (setf %var-accessor-+executing-key+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+executing-keymap+ ()
Function: (setf %var-accessor-+executing-keymap+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+executing-keyseq+ ()
Function: (setf %var-accessor-+executing-keyseq+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+executing-macro+ ()
Function: (setf %var-accessor-+executing-macro+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+explicit-arg+ ()
Function: (setf %var-accessor-+explicit-arg+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+gnu-readline-p+ ()
Function: (setf %var-accessor-+gnu-readline-p+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+history-base+ ()
Function: (setf %var-accessor-+history-base+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+history-length+ ()
Function: (setf %var-accessor-+history-length+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+key-sequence-length+ ()
Function: (setf %var-accessor-+key-sequence-length+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+library-version+ ()
Function: (setf %var-accessor-+library-version+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+numeric-arg+ ()
Function: (setf %var-accessor-+numeric-arg+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+prompt+ ()
Function: (setf %var-accessor-+prompt+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+readline-state+ ()
Function: (setf %var-accessor-+readline-state+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: %var-accessor-+readline-version+ ()
Function: (setf %var-accessor-+readline-version+) VALUE
Package

cl-readline

Source

cl-readline.lisp (file)

Function: decode-state STATE

Transform Readline state STATE into list of keywords. See ‘+states+’ for list of components that can appear in result list.

Package

cl-readline

Source

utils.lisp (file)

Function: decode-version VERSION

Transform VERSION into two values representing major and minor numbers of Readline library version.

Package

cl-readline

Source

utils.lisp (file)

Function: ensure-initialization ()

Make sure that Readline is initialized. If it’s not initialized yet, initialize it.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: recent-history-line-satisfies-p PREDICATE

Check if the most recent history line satisfies given predicate PREDICATE. Return T if there is no history saved.

Package

cl-readline

Source

cl-readline.lisp (file)

Function: to-array-of-strings LIST

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.

Package

cl-readline

Source

utils.lisp (file)

Function: to-list-of-strings POINTER

Convert a null-terminated array of pointers to chars that POINTER points to into list of Lisp strings.

Package

cl-readline

Source

utils.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

Class: history-entry-tclass ()
Package

cl-readline

Source

ctypes.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-readline.asd: The cl-readline<dot>asd file
cl-readline/cl-readline.lisp: The cl-readline/cl-readline<dot>lisp file
cl-readline/ctypes.lisp: The cl-readline/ctypes<dot>lisp file
cl-readline/package.lisp: The cl-readline/package<dot>lisp file
cl-readline/utils.lisp: The cl-readline/utils<dot>lisp file

F
File, Lisp, cl-readline.asd: The cl-readline<dot>asd file
File, Lisp, cl-readline/cl-readline.lisp: The cl-readline/cl-readline<dot>lisp file
File, Lisp, cl-readline/ctypes.lisp: The cl-readline/ctypes<dot>lisp file
File, Lisp, cl-readline/package.lisp: The cl-readline/package<dot>lisp file
File, Lisp, cl-readline/utils.lisp: The cl-readline/utils<dot>lisp file

L
Lisp File, cl-readline.asd: The cl-readline<dot>asd file
Lisp File, cl-readline/cl-readline.lisp: The cl-readline/cl-readline<dot>lisp file
Lisp File, cl-readline/ctypes.lisp: The cl-readline/ctypes<dot>lisp file
Lisp File, cl-readline/package.lisp: The cl-readline/package<dot>lisp file
Lisp File, cl-readline/utils.lisp: The cl-readline/utils<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   I   K   L   M   O   P   R   S   T   U   V   W  
Index Entry  Section

%
%var-accessor-*already-prompted*: Internal functions
%var-accessor-*attempted-completion-function*: Internal functions
%var-accessor-*attempted-completion-over*: Internal functions
%var-accessor-*basic-quote-characters*: Internal functions
%var-accessor-*basic-word-break-characters*: Internal functions
%var-accessor-*catch-signals*: Internal functions
%var-accessor-*catch-sigwinch*: Internal functions
%var-accessor-*change-environment*: Internal functions
%var-accessor-*completer-word-break-characters*: Internal functions
%var-accessor-*completion-append-character*: Internal functions
%var-accessor-*completion-display-matches-hook*: Internal functions
%var-accessor-*completion-query-items*: Internal functions
%var-accessor-*deprep-term-function*: Internal functions
%var-accessor-*display-prompt*: Internal functions
%var-accessor-*done*: Internal functions
%var-accessor-*erase-empty-line*: Internal functions
%var-accessor-*event-hook*: Internal functions
%var-accessor-*getc-function*: Internal functions
%var-accessor-*ignore-completion-duplicates*: Internal functions
%var-accessor-*inhibit-completion*: Internal functions
%var-accessor-*input-available-hook*: Internal functions
%var-accessor-*instream*: Internal functions
%var-accessor-*last-func*: Internal functions
%var-accessor-*line-buffer*: Internal functions
%var-accessor-*mark*: Internal functions
%var-accessor-*num-chars-to-read*: Internal functions
%var-accessor-*outstream*: Internal functions
%var-accessor-*pending-input*: Internal functions
%var-accessor-*point*: Internal functions
%var-accessor-*pre-input-hook*: Internal functions
%var-accessor-*prefer-env-winsize*: Internal functions
%var-accessor-*prep-term-function*: Internal functions
%var-accessor-*readline-name*: Internal functions
%var-accessor-*redisplay-function*: Internal functions
%var-accessor-*signal-event-hook*: Internal functions
%var-accessor-*sort-completion-matches*: Internal functions
%var-accessor-*startup-hook*: Internal functions
%var-accessor-*terminal-name*: Internal functions
%var-accessor-+binding-keymap+: Internal functions
%var-accessor-+completion-type+: Internal functions
%var-accessor-+dispatching+: Internal functions
%var-accessor-+editing-mode+: Internal functions
%var-accessor-+end+: Internal functions
%var-accessor-+executing-key+: Internal functions
%var-accessor-+executing-keymap+: Internal functions
%var-accessor-+executing-keyseq+: Internal functions
%var-accessor-+executing-macro+: Internal functions
%var-accessor-+explicit-arg+: Internal functions
%var-accessor-+gnu-readline-p+: Internal functions
%var-accessor-+history-base+: Internal functions
%var-accessor-+history-length+: Internal functions
%var-accessor-+key-sequence-length+: Internal functions
%var-accessor-+library-version+: Internal functions
%var-accessor-+numeric-arg+: Internal functions
%var-accessor-+prompt+: Internal functions
%var-accessor-+readline-state+: Internal functions
%var-accessor-+readline-version+: Internal functions

(
(setf %var-accessor-*already-prompted*): Internal functions
(setf %var-accessor-*attempted-completion-function*): Internal functions
(setf %var-accessor-*attempted-completion-over*): Internal functions
(setf %var-accessor-*basic-quote-characters*): Internal functions
(setf %var-accessor-*basic-word-break-characters*): Internal functions
(setf %var-accessor-*catch-signals*): Internal functions
(setf %var-accessor-*catch-sigwinch*): Internal functions
(setf %var-accessor-*change-environment*): Internal functions
(setf %var-accessor-*completer-word-break-characters*): Internal functions
(setf %var-accessor-*completion-append-character*): Internal functions
(setf %var-accessor-*completion-display-matches-hook*): Internal functions
(setf %var-accessor-*completion-query-items*): Internal functions
(setf %var-accessor-*deprep-term-function*): Internal functions
(setf %var-accessor-*display-prompt*): Internal functions
(setf %var-accessor-*done*): Internal functions
(setf %var-accessor-*erase-empty-line*): Internal functions
(setf %var-accessor-*event-hook*): Internal functions
(setf %var-accessor-*getc-function*): Internal functions
(setf %var-accessor-*ignore-completion-duplicates*): Internal functions
(setf %var-accessor-*inhibit-completion*): Internal functions
(setf %var-accessor-*input-available-hook*): Internal functions
(setf %var-accessor-*instream*): Internal functions
(setf %var-accessor-*last-func*): Internal functions
(setf %var-accessor-*line-buffer*): Internal functions
(setf %var-accessor-*mark*): Internal functions
(setf %var-accessor-*num-chars-to-read*): Internal functions
(setf %var-accessor-*outstream*): Internal functions
(setf %var-accessor-*pending-input*): Internal functions
(setf %var-accessor-*point*): Internal functions
(setf %var-accessor-*pre-input-hook*): Internal functions
(setf %var-accessor-*prefer-env-winsize*): Internal functions
(setf %var-accessor-*prep-term-function*): Internal functions
(setf %var-accessor-*readline-name*): Internal functions
(setf %var-accessor-*redisplay-function*): Internal functions
(setf %var-accessor-*signal-event-hook*): Internal functions
(setf %var-accessor-*sort-completion-matches*): Internal functions
(setf %var-accessor-*startup-hook*): Internal functions
(setf %var-accessor-*terminal-name*): Internal functions
(setf %var-accessor-+binding-keymap+): Internal functions
(setf %var-accessor-+completion-type+): Internal functions
(setf %var-accessor-+dispatching+): Internal functions
(setf %var-accessor-+editing-mode+): Internal functions
(setf %var-accessor-+end+): Internal functions
(setf %var-accessor-+executing-key+): Internal functions
(setf %var-accessor-+executing-keymap+): Internal functions
(setf %var-accessor-+executing-keyseq+): Internal functions
(setf %var-accessor-+executing-macro+): Internal functions
(setf %var-accessor-+explicit-arg+): Internal functions
(setf %var-accessor-+gnu-readline-p+): Internal functions
(setf %var-accessor-+history-base+): Internal functions
(setf %var-accessor-+history-length+): Internal functions
(setf %var-accessor-+key-sequence-length+): Internal functions
(setf %var-accessor-+library-version+): Internal functions
(setf %var-accessor-+numeric-arg+): Internal functions
(setf %var-accessor-+prompt+): Internal functions
(setf %var-accessor-+readline-state+): Internal functions
(setf %var-accessor-+readline-version+): Internal functions

A
add-defun: Exported functions
add-funmap-entry: Exported functions
add-undo: Exported functions

B
bind-key: Exported functions
bind-keyseq: Exported functions

C
cleanup-after-signal: Exported functions
clear-history: Exported functions
clear-pending-input: Exported functions
clear-signals: Exported functions
copy-keymap: Exported functions
crlf: Exported functions

D
decode-state: Internal functions
decode-version: Internal functions
delete-text: Exported functions
deprep-terminal: Exported functions
ding: Exported functions
do-undo: Exported functions

E
echo-signal-char: Exported functions
ensure-initialization: Internal functions
execute-next: Exported functions
extend-line-buffer: Exported functions

F
forced-update-display: Exported functions
free-keymap: Exported functions
free-line-state: Exported functions
free-undo-list: Exported functions
Function, %var-accessor-*already-prompted*: Internal functions
Function, %var-accessor-*attempted-completion-function*: Internal functions
Function, %var-accessor-*attempted-completion-over*: Internal functions
Function, %var-accessor-*basic-quote-characters*: Internal functions
Function, %var-accessor-*basic-word-break-characters*: Internal functions
Function, %var-accessor-*catch-signals*: Internal functions
Function, %var-accessor-*catch-sigwinch*: Internal functions
Function, %var-accessor-*change-environment*: Internal functions
Function, %var-accessor-*completer-word-break-characters*: Internal functions
Function, %var-accessor-*completion-append-character*: Internal functions
Function, %var-accessor-*completion-display-matches-hook*: Internal functions
Function, %var-accessor-*completion-query-items*: Internal functions
Function, %var-accessor-*deprep-term-function*: Internal functions
Function, %var-accessor-*display-prompt*: Internal functions
Function, %var-accessor-*done*: Internal functions
Function, %var-accessor-*erase-empty-line*: Internal functions
Function, %var-accessor-*event-hook*: Internal functions
Function, %var-accessor-*getc-function*: Internal functions
Function, %var-accessor-*ignore-completion-duplicates*: Internal functions
Function, %var-accessor-*inhibit-completion*: Internal functions
Function, %var-accessor-*input-available-hook*: Internal functions
Function, %var-accessor-*instream*: Internal functions
Function, %var-accessor-*last-func*: Internal functions
Function, %var-accessor-*line-buffer*: Internal functions
Function, %var-accessor-*mark*: Internal functions
Function, %var-accessor-*num-chars-to-read*: Internal functions
Function, %var-accessor-*outstream*: Internal functions
Function, %var-accessor-*pending-input*: Internal functions
Function, %var-accessor-*point*: Internal functions
Function, %var-accessor-*pre-input-hook*: Internal functions
Function, %var-accessor-*prefer-env-winsize*: Internal functions
Function, %var-accessor-*prep-term-function*: Internal functions
Function, %var-accessor-*readline-name*: Internal functions
Function, %var-accessor-*redisplay-function*: Internal functions
Function, %var-accessor-*signal-event-hook*: Internal functions
Function, %var-accessor-*sort-completion-matches*: Internal functions
Function, %var-accessor-*startup-hook*: Internal functions
Function, %var-accessor-*terminal-name*: Internal functions
Function, %var-accessor-+binding-keymap+: Internal functions
Function, %var-accessor-+completion-type+: Internal functions
Function, %var-accessor-+dispatching+: Internal functions
Function, %var-accessor-+editing-mode+: Internal functions
Function, %var-accessor-+end+: Internal functions
Function, %var-accessor-+executing-key+: Internal functions
Function, %var-accessor-+executing-keymap+: Internal functions
Function, %var-accessor-+executing-keyseq+: Internal functions
Function, %var-accessor-+executing-macro+: Internal functions
Function, %var-accessor-+explicit-arg+: Internal functions
Function, %var-accessor-+gnu-readline-p+: Internal functions
Function, %var-accessor-+history-base+: Internal functions
Function, %var-accessor-+history-length+: Internal functions
Function, %var-accessor-+key-sequence-length+: Internal functions
Function, %var-accessor-+library-version+: Internal functions
Function, %var-accessor-+numeric-arg+: Internal functions
Function, %var-accessor-+prompt+: Internal functions
Function, %var-accessor-+readline-state+: Internal functions
Function, %var-accessor-+readline-version+: Internal functions
Function, (setf %var-accessor-*already-prompted*): Internal functions
Function, (setf %var-accessor-*attempted-completion-function*): Internal functions
Function, (setf %var-accessor-*attempted-completion-over*): Internal functions
Function, (setf %var-accessor-*basic-quote-characters*): Internal functions
Function, (setf %var-accessor-*basic-word-break-characters*): Internal functions
Function, (setf %var-accessor-*catch-signals*): Internal functions
Function, (setf %var-accessor-*catch-sigwinch*): Internal functions
Function, (setf %var-accessor-*change-environment*): Internal functions
Function, (setf %var-accessor-*completer-word-break-characters*): Internal functions
Function, (setf %var-accessor-*completion-append-character*): Internal functions
Function, (setf %var-accessor-*completion-display-matches-hook*): Internal functions
Function, (setf %var-accessor-*completion-query-items*): Internal functions
Function, (setf %var-accessor-*deprep-term-function*): Internal functions
Function, (setf %var-accessor-*display-prompt*): Internal functions
Function, (setf %var-accessor-*done*): Internal functions
Function, (setf %var-accessor-*erase-empty-line*): Internal functions
Function, (setf %var-accessor-*event-hook*): Internal functions
Function, (setf %var-accessor-*getc-function*): Internal functions
Function, (setf %var-accessor-*ignore-completion-duplicates*): Internal functions
Function, (setf %var-accessor-*inhibit-completion*): Internal functions
Function, (setf %var-accessor-*input-available-hook*): Internal functions
Function, (setf %var-accessor-*instream*): Internal functions
Function, (setf %var-accessor-*last-func*): Internal functions
Function, (setf %var-accessor-*line-buffer*): Internal functions
Function, (setf %var-accessor-*mark*): Internal functions
Function, (setf %var-accessor-*num-chars-to-read*): Internal functions
Function, (setf %var-accessor-*outstream*): Internal functions
Function, (setf %var-accessor-*pending-input*): Internal functions
Function, (setf %var-accessor-*point*): Internal functions
Function, (setf %var-accessor-*pre-input-hook*): Internal functions
Function, (setf %var-accessor-*prefer-env-winsize*): Internal functions
Function, (setf %var-accessor-*prep-term-function*): Internal functions
Function, (setf %var-accessor-*readline-name*): Internal functions
Function, (setf %var-accessor-*redisplay-function*): Internal functions
Function, (setf %var-accessor-*signal-event-hook*): Internal functions
Function, (setf %var-accessor-*sort-completion-matches*): Internal functions
Function, (setf %var-accessor-*startup-hook*): Internal functions
Function, (setf %var-accessor-*terminal-name*): Internal functions
Function, (setf %var-accessor-+binding-keymap+): Internal functions
Function, (setf %var-accessor-+completion-type+): Internal functions
Function, (setf %var-accessor-+dispatching+): Internal functions
Function, (setf %var-accessor-+editing-mode+): Internal functions
Function, (setf %var-accessor-+end+): Internal functions
Function, (setf %var-accessor-+executing-key+): Internal functions
Function, (setf %var-accessor-+executing-keymap+): Internal functions
Function, (setf %var-accessor-+executing-keyseq+): Internal functions
Function, (setf %var-accessor-+executing-macro+): Internal functions
Function, (setf %var-accessor-+explicit-arg+): Internal functions
Function, (setf %var-accessor-+gnu-readline-p+): Internal functions
Function, (setf %var-accessor-+history-base+): Internal functions
Function, (setf %var-accessor-+history-length+): Internal functions
Function, (setf %var-accessor-+key-sequence-length+): Internal functions
Function, (setf %var-accessor-+library-version+): Internal functions
Function, (setf %var-accessor-+numeric-arg+): Internal functions
Function, (setf %var-accessor-+prompt+): Internal functions
Function, (setf %var-accessor-+readline-state+): Internal functions
Function, (setf %var-accessor-+readline-version+): Internal functions
Function, add-defun: Exported functions
Function, add-funmap-entry: Exported functions
Function, add-undo: Exported functions
Function, bind-key: Exported functions
Function, bind-keyseq: Exported functions
Function, cleanup-after-signal: Exported functions
Function, clear-history: Exported functions
Function, clear-pending-input: Exported functions
Function, clear-signals: Exported functions
Function, copy-keymap: Exported functions
Function, crlf: Exported functions
Function, decode-state: Internal functions
Function, decode-version: Internal functions
Function, delete-text: Exported functions
Function, deprep-terminal: Exported functions
Function, ding: Exported functions
Function, do-undo: Exported functions
Function, echo-signal-char: Exported functions
Function, ensure-initialization: Internal functions
Function, execute-next: Exported functions
Function, extend-line-buffer: Exported functions
Function, forced-update-display: Exported functions
Function, free-keymap: Exported functions
Function, free-line-state: Exported functions
Function, free-undo-list: Exported functions
Function, function-dumper: Exported functions
Function, funmap-names: Exported functions
Function, get-keymap: Exported functions
Function, get-keymap-by-name: Exported functions
Function, get-keymap-name: Exported functions
Function, get-screen-size: Exported functions
Function, initialize: Exported functions
Function, insert-text: Exported functions
Function, kill-text: Exported functions
Function, list-funmap-names: Exported functions
Function, macro-dumper: Exported functions
Function, make-keymap: Exported functions
Function, modifying: Exported functions
Function, on-new-line: Exported functions
Function, parse-and-bind: Exported functions
Function, prep-terminal: Exported functions
Function, read-init-file: Exported functions
Function, read-key: Exported functions
Function, readline: Exported functions
Function, recent-history-line-satisfies-p: Internal functions
Function, redisplay: Exported functions
Function, register-function: Exported functions
Function, register-hook: Exported functions
Function, replace-line: Exported functions
Function, reset-after-signal: Exported functions
Function, reset-line-state: Exported functions
Function, reset-screen-size: Exported functions
Function, reset-terminal: Exported functions
Function, resize-terminal: Exported functions
Function, set-keyboard-input-timeout: Exported functions
Function, set-keymap: Exported functions
Function, set-paren-blink-timeout: Exported functions
Function, set-prompt: Exported functions
Function, set-screen-size: Exported functions
Function, set-signals: Exported functions
Function, show-char: Exported functions
Function, stuff-char: Exported functions
Function, to-array-of-strings: Internal functions
Function, to-list-of-strings: Internal functions
Function, tty-set-default-bindings: Exported functions
Function, tty-unset-default-bindings: Exported functions
Function, unbind-command: Exported functions
Function, unbind-key: Exported functions
Function, variable-bind: Exported functions
Function, variable-dumper: Exported functions
Function, variable-value: Exported functions
function-dumper: Exported functions
funmap-names: Exported functions

G
get-keymap: Exported functions
get-keymap-by-name: Exported functions
get-keymap-name: Exported functions
get-screen-size: Exported functions

I
initialize: Exported functions
insert-text: Exported functions

K
kill-text: Exported functions

L
list-funmap-names: Exported functions

M
Macro, produce-callback: Internal macros
Macro, undo-group: Exported macros
Macro, with-message: Exported macros
Macro, with-new-keymap: Exported macros
Macro, with-possible-redirection: Internal macros
macro-dumper: Exported functions
make-keymap: Exported functions
modifying: Exported functions

O
on-new-line: Exported functions

P
parse-and-bind: Exported functions
prep-terminal: Exported functions
produce-callback: Internal macros

R
read-init-file: Exported functions
read-key: Exported functions
readline: Exported functions
recent-history-line-satisfies-p: Internal functions
redisplay: Exported functions
register-function: Exported functions
register-hook: Exported functions
replace-line: Exported functions
reset-after-signal: Exported functions
reset-line-state: Exported functions
reset-screen-size: Exported functions
reset-terminal: Exported functions
resize-terminal: Exported functions

S
set-keyboard-input-timeout: Exported functions
set-keymap: Exported functions
set-paren-blink-timeout: Exported functions
set-prompt: Exported functions
set-screen-size: Exported functions
set-signals: Exported functions
show-char: Exported functions
stuff-char: Exported functions

T
to-array-of-strings: Internal functions
to-list-of-strings: Internal functions
tty-set-default-bindings: Exported functions
tty-unset-default-bindings: Exported functions

U
unbind-command: Exported functions
unbind-key: Exported functions
undo-group: Exported macros

V
variable-bind: Exported functions
variable-dumper: Exported functions
variable-value: Exported functions

W
with-message: Exported macros
with-new-keymap: Exported macros
with-possible-redirection: Internal macros

Jump to:   %   (  
A   B   C   D   E   F   G   I   K   L   M   O   P   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
S  
Index Entry  Section

*
*already-prompted*: Internal symbol macros
*attempted-completion-function*: Internal symbol macros
*attempted-completion-over*: Internal symbol macros
*basic-quote-characters*: Exported symbol macros
*basic-word-break-characters*: Exported symbol macros
*catch-signals*: Exported symbol macros
*catch-sigwinch*: Exported symbol macros
*change-environment*: Exported symbol macros
*completer-word-break-characters*: Exported symbol macros
*completion-append-character*: Exported symbol macros
*completion-display-matches-hook*: Internal symbol macros
*completion-query-items*: Exported symbol macros
*deprep-term-function*: Internal symbol macros
*display-prompt*: Exported symbol macros
*done*: Exported symbol macros
*erase-empty-line*: Internal symbol macros
*event-hook*: Internal symbol macros
*getc-function*: Internal symbol macros
*ignore-completion-duplicates*: Exported symbol macros
*inhibit-completion*: Exported symbol macros
*input-available-hook*: Internal symbol macros
*instream*: Internal symbol macros
*last-func*: Internal symbol macros
*line-buffer*: Exported symbol macros
*mark*: Exported symbol macros
*num-chars-to-read*: Internal symbol macros
*outstream*: Internal symbol macros
*pending-input*: Internal symbol macros
*point*: Exported symbol macros
*pre-input-hook*: Internal symbol macros
*prefer-env-winsize*: Exported symbol macros
*prep-term-function*: Internal symbol macros
*readline-name*: Exported symbol macros
*redisplay-function*: Internal symbol macros
*signal-event-hook*: Internal symbol macros
*sort-completion-matches*: Exported symbol macros
*startup-hook*: Internal symbol macros
*terminal-name*: Exported symbol macros

+
+binding-keymap+: Exported symbol macros
+c-buffer-size+: Internal special variables
+completion-type+: Exported symbol macros
+dispatching+: Exported symbol macros
+editing-mode+: Exported symbol macros
+end+: Exported symbol macros
+executing-key+: Exported symbol macros
+executing-keymap+: Exported symbol macros
+executing-keyseq+: Exported symbol macros
+executing-macro+: Exported symbol macros
+explicit-arg+: Exported symbol macros
+gnu-readline-p+: Exported symbol macros
+history-base+: Internal symbol macros
+history-length+: Internal symbol macros
+key-sequence-length+: Exported symbol macros
+library-version+: Exported symbol macros
+numeric-arg+: Exported symbol macros
+prompt+: Exported symbol macros
+readline-state+: Exported symbol macros
+readline-version+: Exported symbol macros
+states+: Internal special variables

S
Special Variable, +c-buffer-size+: Internal special variables
Special Variable, +states+: Internal special variables
Symbol Macro, *already-prompted*: Internal symbol macros
Symbol Macro, *attempted-completion-function*: Internal symbol macros
Symbol Macro, *attempted-completion-over*: Internal symbol macros
Symbol Macro, *basic-quote-characters*: Exported symbol macros
Symbol Macro, *basic-word-break-characters*: Exported symbol macros
Symbol Macro, *catch-signals*: Exported symbol macros
Symbol Macro, *catch-sigwinch*: Exported symbol macros
Symbol Macro, *change-environment*: Exported symbol macros
Symbol Macro, *completer-word-break-characters*: Exported symbol macros
Symbol Macro, *completion-append-character*: Exported symbol macros
Symbol Macro, *completion-display-matches-hook*: Internal symbol macros
Symbol Macro, *completion-query-items*: Exported symbol macros
Symbol Macro, *deprep-term-function*: Internal symbol macros
Symbol Macro, *display-prompt*: Exported symbol macros
Symbol Macro, *done*: Exported symbol macros
Symbol Macro, *erase-empty-line*: Internal symbol macros
Symbol Macro, *event-hook*: Internal symbol macros
Symbol Macro, *getc-function*: Internal symbol macros
Symbol Macro, *ignore-completion-duplicates*: Exported symbol macros
Symbol Macro, *inhibit-completion*: Exported symbol macros
Symbol Macro, *input-available-hook*: Internal symbol macros
Symbol Macro, *instream*: Internal symbol macros
Symbol Macro, *last-func*: Internal symbol macros
Symbol Macro, *line-buffer*: Exported symbol macros
Symbol Macro, *mark*: Exported symbol macros
Symbol Macro, *num-chars-to-read*: Internal symbol macros
Symbol Macro, *outstream*: Internal symbol macros
Symbol Macro, *pending-input*: Internal symbol macros
Symbol Macro, *point*: Exported symbol macros
Symbol Macro, *pre-input-hook*: Internal symbol macros
Symbol Macro, *prefer-env-winsize*: Exported symbol macros
Symbol Macro, *prep-term-function*: Internal symbol macros
Symbol Macro, *readline-name*: Exported symbol macros
Symbol Macro, *redisplay-function*: Internal symbol macros
Symbol Macro, *signal-event-hook*: Internal symbol macros
Symbol Macro, *sort-completion-matches*: Exported symbol macros
Symbol Macro, *startup-hook*: Internal symbol macros
Symbol Macro, *terminal-name*: Exported symbol macros
Symbol Macro, +binding-keymap+: Exported symbol macros
Symbol Macro, +completion-type+: Exported symbol macros
Symbol Macro, +dispatching+: Exported symbol macros
Symbol Macro, +editing-mode+: Exported symbol macros
Symbol Macro, +end+: Exported symbol macros
Symbol Macro, +executing-key+: Exported symbol macros
Symbol Macro, +executing-keymap+: Exported symbol macros
Symbol Macro, +executing-keyseq+: Exported symbol macros
Symbol Macro, +executing-macro+: Exported symbol macros
Symbol Macro, +explicit-arg+: Exported symbol macros
Symbol Macro, +gnu-readline-p+: Exported symbol macros
Symbol Macro, +history-base+: Internal symbol macros
Symbol Macro, +history-length+: Internal symbol macros
Symbol Macro, +key-sequence-length+: Exported symbol macros
Symbol Macro, +library-version+: Exported symbol macros
Symbol Macro, +numeric-arg+: Exported symbol macros
Symbol Macro, +prompt+: Exported symbol macros
Symbol Macro, +readline-state+: Exported symbol macros
Symbol Macro, +readline-version+: Exported symbol macros

Jump to:   *   +  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   H   P   S  
Index Entry  Section

C
cl-readline: The cl-readline system
cl-readline: The cl-readline package
Class, history-entry-tclass: Internal classes

H
history-entry-tclass: Internal classes

P
Package, cl-readline: The cl-readline package

S
System, cl-readline: The cl-readline system

Jump to:   C   H   P   S