The linedit Reference Manual

Table of Contents

The linedit Reference Manual

This is the linedit Reference Manual, version 0.17.6, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:05:37 2018 GMT+0.

1 Introduction

Linedit is a readline-style library written in Common Lisp that provides customizable line-editing for Common Lisp programs.

Linedit is basically portable between implementations, but most development and testing has so far been carried out on SBCL - but CCL at least is expected to work as well.

The canonical place to get linedit is

https://github.com/sharplispers/linedit

but unless you want to hack on linedit you should take the Quicklisp version! To report a bug submit a GitHub issue at the above URL. For patches please submit a pull request from a topic-branch.

Features

• single-line text reader
• multi-line form reader
• completions on packages and symbols in current image
• completions on directories and filenames
• apropos-word and describe-word
• unlimited undo
• unlimited kill-ring
• unlimited history
• paren matching (not across lines)
• multiple histories
• use in REPL on SBCL and Clozure CL
• paging
• fully customizable in CL
• works on Linux, FreeBSD, macOS

Usage

> (ql:quickload "linedit")

> (linedit:linedit :prompt "-> ")

> (linedit:formedit :prompt1 "=> " :prompt2 "|   ")

Meta-H in the prompt displays help. (Try ESC-H if your terminal misbehaves with meta-proper.)

Linedit in the REPL

SBCL and CCL only for now:

(linedit:install-repl :wrap-current t :eof-quits t)

in e.g. your Lisp initialization file (~/.sbclrc for SBCL). If you don't want to preserve your current input handler you can omit the WRAP-CURRENT keyword.

Documentation

function INSTALL-REPL &key wrap-current eof-quits

Installs Linedit REPL input handler. (SBCL and CCL only.)

function UNINSTALL-REPL

Removes Linedit REPL input handler. (SBCL and CCL only.)

function LINEDIT &rest keys &key prompt

Reads a single line of input with line-editing from standard input of the process and returns it as a string.

Results are unspecified if *STANDARD-INPUT* has been bound or altered.

:PROMPT specifies the string to print to *STANDARD-OUTPUT* before starting to accept input.

Further keyword arguments to LINEDIT are an advanced and undocumented topic, but if you're willing to dive into sources you can e.g. use multiple kill-rings not shared between different invocations of LINEDIT, or change the function responsible for providing input completion.

function FORMEDIT &rest keys &key prompt1 prompt2

Reads a single form (s-expession) of input with line-editing from standard input of the process and returns it as a string.

Results are unspecified if *STANDARD-INPUT* has been bound or altered, or if READTABLE is not the standard one.

:PROMPT1 specifies the string to print to *STANDARD-OUTPUT* before starting to accept input.

:PROMPT2 specified the string to print to *STANDARD-OUTPUT* when input spans multiple lines (prefixing every but first line of input from the user perspective.)

Further keyword arguments to FORMEDIT are an advanced and undocumented topic, but if you're willing to dive into sources you can e.g. use multiple kill-rings not shared between different invocations of FORMEDIT, or change the function responsible for providing input completion.

2 Systems

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

2.1 linedit

Maintainer

Anmol Khirbat <anmol@khirbat.net>

Author

Nikodemus Siivola <nikodemus@random-state.net>

Home Page

https://github.com/sharplispers/linedit

License

MIT

Description

Readline-style library.

Version

0.17.6

Dependencies

• cffi
• terminfo
• osicat
• alexandria

Source

linedit.asd (file)

Components

• packages.lisp (file)
• utility-functions.lisp (file)
• utility-macros.lisp (file)
• matcher.lisp (file)
• backend.lisp (file)
• terminal-glue.lisp (file)
• terminal-translations.lisp (file)
• terminal.lisp (file)
• smart-terminal.lisp (file)
• dumb-terminal.lisp (file)
• rewindable.lisp (file)
• line.lisp (file)
• buffer.lisp (file)
• command-keys.lisp (file)
• editor.lisp (file)
• main.lisp (file)
• complete.lisp (file)
• command-functions.lisp (file)
• ports (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 linedit/ports

Dependency

main.lisp (file)

Parent

linedit (system)

Location

ports/

Components

• sbcl.lisp (file)
• ccl.lisp (file)
• generic.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 linedit.asd

Location

linedit.asd

Systems

linedit (system)

Packages

linedit-system

4.1.2 linedit/packages.lisp

Parent

linedit (system)

Location

packages.lisp

Packages

linedit

4.1.3 linedit/utility-functions.lisp

Dependency

packages.lisp (file)

Parent

linedit (system)

Location

utility-functions.lisp

Exported Definitions

• end-debug (function)
• start-debug (function)

Internal Definitions

• *debug* (special variable)
• *word-delimiters* (special variable)
• at-delimiter-p (function)
• concat (function)
• dbg (function)
• eof-handler (function)
• make-whitespace (function)
• min* (function)
• required (function)
• whitespacep (function)
• word-delimiter-p (function)
• yes-or-no (function)

4.1.4 linedit/utility-macros.lisp

Dependencies

• packages.lisp (file)
• utility-functions.lisp (file)

Parent

linedit (system)

Location

utility-macros.lisp

Internal Definitions

• acase (macro)
• aif (macro)
• awhen (macro)
• dbg-values (macro)
• do-internal-symbols (macro)
• ensure (macro)
• invariant (macro)
• with-unique-names (macro)

4.1.5 linedit/matcher.lisp

Dependency

packages.lisp (file)

Parent

linedit (system)

Location

matcher.lisp

Internal Definitions

• after-close-p (function)
• at-open-p (function)
• dwim-mark-parens (function)
• dwim-match-parens (function)
• find-close-paren (function)
• find-close-quote (function)
• find-open-paren (function)
• find-open-quote (function)
• paren-count-delta (function)
• quoted-p (function)

4.1.6 linedit/backend.lisp

Dependency

utility-macros.lisp (file)

Parent

linedit (system)

Location

backend.lisp

Exported Definitions

• *default-columns* (special variable)
• *default-lines* (special variable)
• *highlight-color* (special variable)

Internal Definitions

• backend (class)
• backend-ready-p (method)
• (setf backend-ready-p) (method)
• backend-translations (method)
• display (generic function)
• get-start (method)
• (setf get-start) (method)
• with-backend (macro)
• without-backend (macro)

4.1.7 linedit/terminal-glue.lisp

Parent

linedit (system)

Location

terminal-glue.lisp

Internal Definitions

• +linedit-attr-error+ (special variable)
• +linedit-memory-error+ (special variable)
• +linedit-no-attr-error+ (special variable)
• +linedit-not-atty+ (special variable)
• +linedit-ok+ (special variable)
• +linedit-tcgetattr-error+ (special variable)
• +linedit-tcsetattr-error+ (special variable)
• c-terminal-close (function)
• c-terminal-columns (function)
• c-terminal-init (function)
• c-terminal-lines (function)
• c-terminal-winsize (function)

4.1.8 linedit/terminal-translations.lisp

Dependency

packages.lisp (file)

Parent

linedit (system)

Location

terminal-translations.lisp

Internal Definitions

• *terminal-translations* (special variable)
• deftrans (macro)

4.1.9 linedit/terminal.lisp

Dependencies

• terminal-translations.lisp (file)
• backend.lisp (file)
• terminal-glue.lisp (file)

Parent

linedit (system)

Location

terminal.lisp

Internal Definitions

• +terminal-bell+ (constant)
• backend-close (method)
• backend-columns (method)
• backend-init (method)
• backend-lines (method)
• beep (method)
• dirty-p (method)
• (setf dirty-p) (method)
• newline (method)
• page (method)
• print-in-columns (method)
• print-in-lines (method)
• read-chord (method)
• terminal (class)

4.1.10 linedit/smart-terminal.lisp

Dependencies

• terminal.lisp (file)
• matcher.lisp (file)

Parent

linedit (system)

Location

smart-terminal.lisp

Internal Definitions

• backend-init (method)
• display (method)
• find-col (function)
• find-row (function)
• fix-wraparound (function)
• move-in-column (function)
• old-markup (method)
• (setf old-markup) (method)
• old-point (method)
• (setf old-point) (method)
• old-string (method)
• (setf old-string) (method)
• paren-style (function)
• place-point (function)
• set-column-address (function)
• smart-terminal (class)
• smart-terminal-p (function)

4.1.11 linedit/dumb-terminal.lisp

Dependency

terminal.lisp (file)

Parent

linedit (system)

Location

dumb-terminal.lisp

Internal Definitions

• display (method)
• dumb-terminal (class)

4.1.12 linedit/rewindable.lisp

Dependency

utility-macros.lisp (file)

Parent

linedit (system)

Location

rewindable.lisp

Internal Definitions

• %rewind-count (function)
• %rewind-index (method)
• (setf %rewind-index) (method)
• %rewind-store (method)
• last-state (function)
• rewind-state (method)
• rewindable (class)
• save-rewindable-state (function)

4.1.13 linedit/line.lisp

Dependency

utility-macros.lisp (file)

Parent

linedit (system)

Location

line.lisp

Internal Definitions

• get-point (method)
• (setf get-point) (method)
• (setf get-point) (method)
• get-string (method)
• (setf get-string) (method)
• (setf get-string) (method)
• line (class)

4.1.14 linedit/buffer.lisp

Dependency

utility-macros.lisp (file)

Parent

linedit (system)

Location

buffer.lisp

Internal Definitions

• %buffer-list (method)
• (setf %buffer-list) (method)
• %buffer-next (method)
• (setf %buffer-next) (method)
• %buffer-pathname (method)
• (setf %buffer-pathname) (method)
• %buffer-prev (method)
• (setf %buffer-prev) (method)
• buffer (class)
• buffer-cycle (function)
• buffer-find-next-if (function)
• buffer-find-previous-if (function)
• buffer-next (function)
• buffer-peek (function)
• buffer-previous (function)
• buffer-push (function)
• copy-buffer (function)
• ensure-buffer (function)

4.1.15 linedit/command-keys.lisp

Dependency

packages.lisp (file)

Parent

linedit (system)

Location

command-keys.lisp

Internal Definitions

• *commands* (special variable)
• defcommand (macro)

4.1.16 linedit/editor.lisp

Dependencies

• backend.lisp (file)
• rewindable.lisp (file)
• line.lisp (file)
• buffer.lisp (file)
• command-keys.lisp (file)

Parent

linedit (system)

Location

editor.lisp

Internal Definitions

• *announced* (special variable)
• *aux-prompt* (special variable)
• *debug-info* (special variable)
• *history* (special variable)
• *killring* (special variable)
• *last-command* (special variable)
• *version* (special variable)
• dumb-editor (class)
• editor (class)
• editor-commands (method)
• editor-complete (function)
• editor-completer (method)
• editor-history (method)
• (setf editor-history) (method)
• editor-insert-mode (method)
• (setf editor-insert-mode) (method)
• editor-interrupt (function)
• editor-killring (method)
• (setf editor-killring) (method)
• editor-last-yank (method)
• (setf editor-last-yank) (method)
• editor-mark (method)
• (setf editor-mark) (method)
• editor-next-word-end (function)
• editor-previous-word-start (function)
• editor-prompt (method)
• (setf editor-prompt) (method)
• editor-replace-word (function)
• editor-sexp-end (function)
• editor-sexp-start (function)
• editor-stop (function)
• editor-word (function)
• editor-word-end (function)
• editor-word-start (function)
• editor-yank (method)
• (setf editor-yank) (method)
• forget-yank (function)
• get-finished-string (function)
• in-quoted-string-p (function)
• make-editor (function)
• next-chord (function)
• redraw-line (function)
• remember-yank (function)
• rewind-state (method)
• save-state (function)
• smart-editor (class)
• try-yank (function)
• with-editor-point-and-string (macro)

4.1.17 linedit/main.lisp

Dependency

editor.lisp (file)

Parent

linedit (system)

Location

main.lisp

Exported Definitions

• formedit (function)
• linedit (function)

Internal Definitions

• *editor* (special variable)
• *level* (special variable)
• colon-reader (function)
• semicolon-reader (function)

4.1.18 linedit/complete.lisp

Dependency

utility-macros.lisp (file)

Parent

linedit (system)

Location

complete.lisp

Internal Definitions

• directory-complete (function)
• lisp-complete (function)
• logical-pathname-complete (function)
• logical-pathname-p (function)
• tilde-expand-string (function)
• underlying-directory-p (function)

4.1.19 linedit/command-functions.lisp

Dependency

editor.lisp (file)

Parent

linedit (system)

Location

command-functions.lisp

Internal Definitions

• %yank (function)
• *history-needle* (special variable)
• *history-search* (special variable)
• add-char (function)
• apropos-word (function)
• backward-sexp (function)
• close-all-sexp (function)
• complete (function)
• copy-region (function)
• cut-region (function)
• delete-char-backwards (function)
• delete-char-forwards (function)
• delete-char-forwards-or-eof (function)
• delete-word-backwards (function)
• delete-word-forwards (function)
• describe-word (function)
• downcase-word (function)
• finish-input (function)
• forward-sexp (function)
• help (function)
• history-next (function)
• history-previous (function)
• history-search (function)
• history-search-needle (function)
• interrupt-lisp (function)
• kill-sexp (function)
• kill-to-bol (function)
• kill-to-eol (function)
• move-char-left (function)
• move-char-right (function)
• move-to-bol (function)
• move-to-eol (function)
• move-word-backwards (function)
• move-word-forwards (function)
• search-history-backwards (function)
• search-history-forwards (function)
• set-mark (function)
• stop-lisp (function)
• toggle-insert (function)
• undo (function)
• unknown-command (function)
• upcase-word (function)
• yank (function)
• yank-cycle (function)

4.1.20 linedit/ports/sbcl.lisp

If Feature

sbcl

Parent

ports (module)

Location

ports/sbcl.lisp

Exported Definitions

• install-repl (function)
• uninstall-repl (function)

4.1.21 linedit/ports/ccl.lisp

If Feature

ccl

Dependency

sbcl.lisp (file)

Parent

ports (module)

Location

ports/ccl.lisp

4.1.22 linedit/ports/generic.lisp

If Feature

(not (or sbcl ccl))

Dependency

ccl.lisp (file)

Parent

ports (module)

Location

ports/generic.lisp

5 Packages

Packages are listed by definition order.

5.1 linedit-system

Source

linedit.asd

Use List

• asdf/interface
• common-lisp

5.2 linedit

Source

packages.lisp (file)

Use List

• osicat
• common-lisp

Exported Definitions

• *default-columns* (special variable)
• *default-lines* (special variable)
• *highlight-color* (special variable)
• end-debug (function)
• formedit (function)
• install-repl (function)
• linedit (function)
• start-debug (function)
• uninstall-repl (function)

Internal Definitions

• %buffer-list (generic function)
• %buffer-list (method)
• (setf %buffer-list) (method)
• (setf %buffer-list) (generic function)
• %buffer-next (generic function)
• %buffer-next (method)
• (setf %buffer-next) (method)
• (setf %buffer-next) (generic function)
• %buffer-pathname (generic function)
• %buffer-pathname (method)
• (setf %buffer-pathname) (method)
• (setf %buffer-pathname) (generic function)
• %buffer-prev (generic function)
• %buffer-prev (method)
• (setf %buffer-prev) (method)
• (setf %buffer-prev) (generic function)
• %rewind-count (function)
• %rewind-index (generic function)
• %rewind-index (method)
• (setf %rewind-index) (method)
• (setf %rewind-index) (generic function)
• %rewind-store (generic function)
• %rewind-store (method)
• %yank (function)
• *announced* (special variable)
• *aux-prompt* (special variable)
• *commands* (special variable)
• *debug* (special variable)
• *debug-info* (special variable)
• *editor* (special variable)
• *history* (special variable)
• *history-needle* (special variable)
• *history-search* (special variable)
• *killring* (special variable)
• *last-command* (special variable)
• *level* (special variable)
• *terminal-translations* (special variable)
• *version* (special variable)
• *word-delimiters* (special variable)
• +linedit-attr-error+ (special variable)
• +linedit-memory-error+ (special variable)
• +linedit-no-attr-error+ (special variable)
• +linedit-not-atty+ (special variable)
• +linedit-ok+ (special variable)
• +linedit-tcgetattr-error+ (special variable)
• +linedit-tcsetattr-error+ (special variable)
• +terminal-bell+ (constant)
• acase (macro)
• add-char (function)
• after-close-p (function)
• aif (macro)
• apropos-word (function)
• at-delimiter-p (function)
• at-open-p (function)
• awhen (macro)
• backend (class)
• backend-close (generic function)
• backend-close (method)
• backend-columns (generic function)
• backend-columns (method)
• backend-init (generic function)
• backend-init (method)
• backend-init (method)
• backend-lines (generic function)
• backend-lines (method)
• backend-ready-p (generic function)
• backend-ready-p (method)
• (setf backend-ready-p) (method)
• (setf backend-ready-p) (generic function)
• backend-translations (generic function)
• backend-translations (method)
• backward-sexp (function)
• beep (generic function)
• beep (method)
• buffer (class)
• buffer-cycle (function)
• buffer-find-next-if (function)
• buffer-find-previous-if (function)
• buffer-next (function)
• buffer-peek (function)
• buffer-previous (function)
• buffer-push (function)
• c-terminal-close (function)
• c-terminal-columns (function)
• c-terminal-init (function)
• c-terminal-lines (function)
• c-terminal-winsize (function)
• close-all-sexp (function)
• colon-reader (function)
• complete (function)
• concat (function)
• copy-buffer (function)
• copy-region (function)
• cut-region (function)
• dbg (function)
• dbg-values (macro)
• defcommand (macro)
• deftrans (macro)
• delete-char-backwards (function)
• delete-char-forwards (function)
• delete-char-forwards-or-eof (function)
• delete-word-backwards (function)
• delete-word-forwards (function)
• describe-word (function)
• directory-complete (function)
• dirty-p (generic function)
• dirty-p (method)
• (setf dirty-p) (method)
• (setf dirty-p) (generic function)
• display (generic function)
• display (method)
• display (method)
• do-internal-symbols (macro)
• downcase-word (function)
• dumb-editor (class)
• dumb-terminal (class)
• dwim-mark-parens (function)
• dwim-match-parens (function)
• editor (class)
• editor-commands (generic function)
• editor-commands (method)
• editor-complete (function)
• editor-completer (generic function)
• editor-completer (method)
• editor-history (generic function)
• editor-history (method)
• (setf editor-history) (method)
• (setf editor-history) (generic function)
• editor-insert-mode (generic function)
• editor-insert-mode (method)
• (setf editor-insert-mode) (method)
• (setf editor-insert-mode) (generic function)
• editor-interrupt (function)
• editor-killring (generic function)
• editor-killring (method)
• (setf editor-killring) (method)
• (setf editor-killring) (generic function)
• editor-last-yank (generic function)
• editor-last-yank (method)
• (setf editor-last-yank) (method)
• (setf editor-last-yank) (generic function)
• editor-mark (generic function)
• editor-mark (method)
• (setf editor-mark) (method)
• (setf editor-mark) (generic function)
• editor-next-word-end (function)
• editor-previous-word-start (function)
• editor-prompt (generic function)
• editor-prompt (method)
• (setf editor-prompt) (method)
• (setf editor-prompt) (generic function)
• editor-replace-word (function)
• editor-sexp-end (function)
• editor-sexp-start (function)
• editor-stop (function)
• editor-word (function)
• editor-word-end (function)
• editor-word-start (function)
• editor-yank (generic function)
• editor-yank (method)
• (setf editor-yank) (method)
• (setf editor-yank) (generic function)
• ensure (macro)
• ensure-buffer (function)
• eof-handler (function)
• find-close-paren (function)
• find-close-quote (function)
• find-col (function)
• find-open-paren (function)
• find-open-quote (function)
• find-row (function)
• finish-input (function)
• fix-wraparound (function)
• forget-yank (function)
• forward-sexp (function)
• get-finished-string (function)
• get-point (generic function)
• get-point (method)
• (setf get-point) (method)
• (setf get-point) (generic function)
• (setf get-point) (method)
• get-start (generic function)
• get-start (method)
• (setf get-start) (method)
• (setf get-start) (generic function)
• get-string (generic function)
• get-string (method)
• (setf get-string) (method)
• (setf get-string) (generic function)
• (setf get-string) (method)
• help (function)
• history-next (function)
• history-previous (function)
• history-search (function)
• history-search-needle (function)
• in-quoted-string-p (function)
• interrupt-lisp (function)
• invariant (macro)
• kill-sexp (function)
• kill-to-bol (function)
• kill-to-eol (function)
• last-state (function)
• line (class)
• lisp-complete (function)
• logical-pathname-complete (function)
• logical-pathname-p (function)
• make-editor (function)
• make-whitespace (function)
• min* (function)
• move-char-left (function)
• move-char-right (function)
• move-in-column (function)
• move-to-bol (function)
• move-to-eol (function)
• move-word-backwards (function)
• move-word-forwards (function)
• newline (generic function)
• newline (method)
• next-chord (function)
• old-markup (generic function)
• old-markup (method)
• (setf old-markup) (method)
• (setf old-markup) (generic function)
• old-point (generic function)
• old-point (method)
• (setf old-point) (method)
• (setf old-point) (generic function)
• old-string (generic function)
• old-string (method)
• (setf old-string) (method)
• (setf old-string) (generic function)
• page (generic function)
• page (method)
• paren-count-delta (function)
• paren-style (function)
• place-point (function)
• print-in-columns (generic function)
• print-in-columns (method)
• print-in-lines (generic function)
• print-in-lines (method)
• quoted-p (function)
• read-chord (generic function)
• read-chord (method)
• redraw-line (function)
• remember-yank (function)
• required (function)
• rewind-state (generic function)
• rewind-state (method)
• rewind-state (method)
• rewindable (class)
• save-rewindable-state (function)
• save-state (function)
• search-history-backwards (function)
• search-history-forwards (function)
• semicolon-reader (function)
• set-column-address (function)
• set-mark (function)
• smart-editor (class)
• smart-terminal (class)
• smart-terminal-p (function)
• stop-lisp (function)
• terminal (class)
• tilde-expand-string (function)
• toggle-insert (function)
• try-yank (function)
• underlying-directory-p (function)
• undo (function)
• unknown-command (function)
• upcase-word (function)
• whitespacep (function)
• with-backend (macro)
• with-editor-point-and-string (macro)
• with-unique-names (macro)
• without-backend (macro)
• word-delimiter-p (function)
• yank (function)
• yank-cycle (function)
• yes-or-no (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *default-columns*

Package

linedit

Source

backend.lisp (file)

Special Variable: *default-lines*

Package

linedit

Source

backend.lisp (file)

Special Variable: *highlight-color*

Color to use for highlighting parentheses. NIL is the current foreground color bolded, other options are terminal colors :BLACK, :RED, :GREEN, :YELLOW, :BLUE, :MAGENTA, :CYAN, and :WHITE.

Package

linedit

Source

backend.lisp (file)

6.1.2 Functions

Function: end-debug ()

End linedit debugging output.

Package

linedit

Source

utility-functions.lisp (file)

Function: formedit &rest ARGS &key PROMPT1 PROMPT2 HISTORY KILLRING &allow-other-keys

Reads a single form (s-expession) of input with line-editing from standard input of the process and returns it as a string.

Results are unspecified if *STANDARD-INPUT* has been bound or altered, or if *READTABLE* is not the standard readtable.

PROMPT1 specifies the string to print to *STANDARD-OUTPUT* before starting the accept input.

PROMPT2 specifies the string to print to *STANDARD-OUTPUT* when input spans multiple lines (ie. prefixing every but first line of input.)

HISTORY and KILLRING can be pathname designators, in which case they indicate the file to use for history and killring persistence, respectively.

Further keyword arguments to FORMEDIT are an advanced and undocumented topic, but if you’re willing to dive into sources you can eg. use multiple kill-rings not shared between different invocations of FORMEDIT, or change the function responsible for providing input completion.

Package

linedit

Source

main.lisp (file)

Function: install-repl &rest ARGS &key WRAP-CURRENT EOF-QUITS HISTORY KILLRING &allow-other-keys

Package

linedit

Source

sbcl.lisp (file)

Function: linedit &rest KEYWORD-ARGS &key PROMPT HISTORY KILLRING &allow-other-keys

Reads a single line of input with line-editing from standard input of the process and returns it as a string.

Results are unspecified if *STANDARD-INPUT* has been bound or altered.

PROMPT specifies the string to print to *STANDARD-OUTPUT* before starting the accept input.

HISTORY and KILLRING can be pathname designators, in which case they indicate the file to use for history and killring persistence, respectively.

Further keyword arguments to LINEDIT are an advanced and undocumented topic, but if you’re willing to dive into sources you can eg. use multiple kill-rings not shared between different invocations of LINEDIT, or change the function responsible for providing input completion.

Package

linedit

Source

main.lisp (file)

Function: start-debug PATHNAME &rest OPEN-ARGS

Start linedit debugging output to pathname, with additional open-args passed to ‘open’.

Package

linedit

Source

utility-functions.lisp (file)

Function: uninstall-repl ()

Package

linedit

Source

sbcl.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: +terminal-bell+

Package

linedit

Source

terminal.lisp (file)

6.2.2 Special variables

Special Variable: *announced*

Package

linedit

Source

editor.lisp (file)

Special Variable: *aux-prompt*

Package

linedit

Source

editor.lisp (file)

Special Variable: *commands*

Package

linedit

Source

command-keys.lisp (file)

Special Variable: *debug*

Package

linedit

Source

utility-functions.lisp (file)

Special Variable: *debug-info*

Package

linedit

Source

editor.lisp (file)

Special Variable: *editor*

Package

linedit

Source

main.lisp (file)

Special Variable: *history*

Package

linedit

Source

editor.lisp (file)

Special Variable: *history-needle*

Package

linedit

Source

command-functions.lisp (file)

Special Variable: *history-search*

Package

linedit

Source

command-functions.lisp (file)

Special Variable: *killring*

Package

linedit

Source

editor.lisp (file)

Special Variable: *last-command*

Package

linedit

Source

editor.lisp (file)

Special Variable: *level*

Package

linedit

Source

main.lisp (file)

Special Variable: *terminal-translations*

Package

linedit

Source

terminal-translations.lisp (file)

Special Variable: *version*

Package

linedit

Source

editor.lisp (file)

Special Variable: *word-delimiters*

Package

linedit

Source

utility-functions.lisp (file)

Special Variable: +linedit-attr-error+

Package

linedit

Source

terminal-glue.lisp (file)

Special Variable: +linedit-memory-error+

Package

linedit

Source

terminal-glue.lisp (file)

Special Variable: +linedit-no-attr-error+

Package

linedit

Source

terminal-glue.lisp (file)

Special Variable: +linedit-not-atty+

Package

linedit

Source

terminal-glue.lisp (file)

Special Variable: +linedit-ok+

Package

linedit

Source

terminal-glue.lisp (file)

Special Variable: +linedit-tcgetattr-error+

Package

linedit

Source

terminal-glue.lisp (file)

Special Variable: +linedit-tcsetattr-error+

Package

linedit

Source

terminal-glue.lisp (file)

6.2.3 Macros

Macro: acase FORM &rest CASES

Package

linedit

Source

utility-macros.lisp (file)

Macro: aif CONDITION CONSEQUENT &optional ALTERNATIVE

Package

linedit

Source

utility-macros.lisp (file)

Macro: awhen CONDITION &body BODY

Package

linedit

Source

utility-macros.lisp (file)

Macro: dbg-values &rest PLACES

Package

linedit

Source

utility-macros.lisp (file)

Macro: defcommand COMMAND &optional ACTION

Package

linedit

Source

command-keys.lisp (file)

Macro: deftrans NAME &rest CHORDS

Package

linedit

Source

terminal-translations.lisp (file)

Macro: do-internal-symbols (VAR PACKAGE) &body FORMS

Package

linedit

Source

utility-macros.lisp (file)

Macro: ensure SYMBOL EXPR

Package

linedit

Source

utility-macros.lisp (file)

Macro: invariant CONDITION

Package

linedit

Source

utility-macros.lisp (file)

Macro: with-backend BACKEND &body FORMS

Package

linedit

Source

backend.lisp (file)

Macro: with-editor-point-and-string ((POINT STRING) EDITOR) &body FORMS

Package

linedit

Source

editor.lisp (file)

Macro: with-unique-names (&rest BINDINGS) &body BODY

Package

linedit

Source

utility-macros.lisp (file)

Macro: without-backend BACKEND &body FORMS

Package

linedit

Source

backend.lisp (file)

6.2.4 Functions

Function: %rewind-count REWINDABLE

Package

linedit

Source

rewindable.lisp (file)

Function: %yank EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: add-char CHAR EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: after-close-p STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: apropos-word CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: at-delimiter-p STRING INDEX

Package

linedit

Source

utility-functions.lisp (file)

Function: at-open-p STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: backward-sexp CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: buffer-cycle BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: buffer-find-next-if TEST BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: buffer-find-previous-if TEST BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: buffer-next STRING BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: buffer-peek BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: buffer-previous STRING BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: buffer-push STRING BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: c-terminal-close ()

Package

linedit

Source

terminal-glue.lisp (file)

Function: c-terminal-columns DEF

Package

linedit

Source

terminal-glue.lisp (file)

Function: c-terminal-init ()

Package

linedit

Source

terminal-glue.lisp (file)

Function: c-terminal-lines DEF

Package

linedit

Source

terminal-glue.lisp (file)

Function: c-terminal-winsize DEF SIDE SIDE-ENV

Package

linedit

Source

terminal-glue.lisp (file)

Function: close-all-sexp CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: colon-reader STREAM CHAR

Package

linedit

Source

main.lisp (file)

Function: complete CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: concat &rest STRINGS

Package

linedit

Source

utility-functions.lisp (file)

Function: copy-buffer BUFFER

Package

linedit

Source

buffer.lisp (file)

Function: copy-region CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: cut-region CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: dbg FORMAT-STRING &rest FORMAT-ARGS

Package

linedit

Source

utility-functions.lisp (file)

Function: delete-char-backwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: delete-char-forwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: delete-char-forwards-or-eof CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: delete-word-backwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: delete-word-forwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: describe-word CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: directory-complete STRING

Package

linedit

Source

complete.lisp (file)

Function: downcase-word CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: dwim-mark-parens STRING INDEX &key PRE-MARK POST-MARK

Package

linedit

Source

matcher.lisp (file)

Function: dwim-match-parens STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: editor-complete EDITOR

Package

linedit

Source

editor.lisp (file)

Function: editor-interrupt EDITOR

Package

linedit

Source

editor.lisp (file)

Function: editor-next-word-end EDITOR

Returns the index just beyond the last letter of current or next word, if the point was between words.

Package

linedit

Source

editor.lisp (file)

Function: editor-previous-word-start EDITOR

Returns the index of the first letter of current or previous word, if the point was at the start of a word or between words.

Package

linedit

Source

editor.lisp (file)

Function: editor-replace-word EDITOR WORD

Package

linedit

Source

editor.lisp (file)

Function: editor-sexp-end EDITOR

Package

linedit

Source

editor.lisp (file)

Function: editor-sexp-start EDITOR

Package

linedit

Source

editor.lisp (file)

Function: editor-stop EDITOR

Package

linedit

Source

editor.lisp (file)

Function: editor-word EDITOR

Returns the current word the point is in or right after, or an empty string.

Package

linedit

Source

editor.lisp (file)

Function: editor-word-end EDITOR

Returns the index just beyond the current word or the point if point is not inside a word.

Package

linedit

Source

editor.lisp (file)

Function: editor-word-start EDITOR

Returns the index of the first letter of current or previous word, if the point is just after a word, or the point.

Package

linedit

Source

editor.lisp (file)

Function: ensure-buffer DATUM

Package

linedit

Source

buffer.lisp (file)

Function: eof-handler LISP-NAME QUIT-FN

Package

linedit

Source

utility-functions.lisp (file)

Function: find-close-paren STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: find-close-quote STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: find-col N COLUMNS

Package

linedit

Source

smart-terminal.lisp (file)

Function: find-open-paren STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: find-open-quote STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: find-row N COLUMNS

Package

linedit

Source

smart-terminal.lisp (file)

Function: finish-input CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: fix-wraparound START END COLUMNS

Package

linedit

Source

smart-terminal.lisp (file)

Function: forget-yank EDITOR

Package

linedit

Source

editor.lisp (file)

Function: forward-sexp CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: get-finished-string EDITOR

Package

linedit

Source

editor.lisp (file)

Function: help CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: history-next CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: history-previous CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: history-search EDITOR DIRECTION

Package

linedit

Source

command-functions.lisp (file)

Function: history-search-needle EDITOR &key DIRECTION

Package

linedit

Source

command-functions.lisp (file)

Function: in-quoted-string-p EDITOR

Package

linedit

Source

editor.lisp (file)

Function: interrupt-lisp CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: kill-sexp CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: kill-to-bol CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: kill-to-eol CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: last-state REWINDABLE

Package

linedit

Source

rewindable.lisp (file)

Function: lisp-complete STRING EDITOR

Package

linedit

Source

complete.lisp (file)

Function: logical-pathname-complete STRING

Package

linedit

Source

complete.lisp (file)

Function: logical-pathname-p PATHNAME

Package

linedit

Source

complete.lisp (file)

Function: make-editor &rest ARGS

Package

linedit

Source

editor.lisp (file)

Function: make-whitespace N

Package

linedit

Source

utility-functions.lisp (file)

Function: min* &rest ARGS

Like min, except ignores NILs.

Package

linedit

Source

utility-functions.lisp (file)

Function: move-char-left CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: move-char-right CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: move-in-column &key COL VERTICAL CLEAR-TO-EOS CURRENT-COL

Package

linedit

Source

smart-terminal.lisp (file)

Function: move-to-bol CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: move-to-eol CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: move-word-backwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: move-word-forwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: next-chord EDITOR

Package

linedit

Source

editor.lisp (file)

Function: paren-count-delta CHAR

Package

linedit

Source

matcher.lisp (file)

Function: paren-style ()

Package

linedit

Source

smart-terminal.lisp (file)

Function: place-point &key UP COL

Package

linedit

Source

smart-terminal.lisp (file)

Function: quoted-p STRING INDEX

Package

linedit

Source

matcher.lisp (file)

Function: redraw-line EDITOR &key MARKUP

Package

linedit

Source

editor.lisp (file)

Function: remember-yank EDITOR

Package

linedit

Source

editor.lisp (file)

Function: required ()

Package

linedit

Source

utility-functions.lisp (file)

Function: save-rewindable-state REWINDABLE OBJECT

Package

linedit

Source

rewindable.lisp (file)

Function: save-state EDITOR

Package

linedit

Source

editor.lisp (file)

Function: search-history-backwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: search-history-forwards CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: semicolon-reader STREAM CHAR

Package

linedit

Source

main.lisp (file)

Function: set-column-address N CURRENT

Package

linedit

Source

smart-terminal.lisp (file)

Function: set-mark CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: smart-terminal-p ()

Package

linedit

Source

smart-terminal.lisp (file)

Function: stop-lisp CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: tilde-expand-string STRING

Returns the supplied string, with a prefix of ~ or ~user expanded to the appropriate home directory.

Package

linedit

Source

complete.lisp (file)

Function: toggle-insert CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: try-yank EDITOR

Package

linedit

Source

editor.lisp (file)

Function: underlying-directory-p PATHNAME

Package

linedit

Source

complete.lisp (file)

Function: undo CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: unknown-command CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: upcase-word CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: whitespacep CHAR

Package

linedit

Source

utility-functions.lisp (file)

Function: word-delimiter-p CHAR

Package

linedit

Source

utility-functions.lisp (file)

Function: yank CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: yank-cycle CHORD EDITOR

Package

linedit

Source

command-functions.lisp (file)

Function: yes-or-no CONTROL &rest ARGS

Like Y-OR-N-P, but using linedit functionality.

Package

linedit

Source

utility-functions.lisp (file)

6.2.5 Generic functions

Generic Function: %buffer-list OBJECT

Generic Function: (setf %buffer-list) NEW-VALUE OBJECT

Package

linedit

Methods

Method: %buffer-list (BUFFER buffer)

automatically generated reader method

Source

buffer.lisp (file)

Method: (setf %buffer-list) NEW-VALUE (BUFFER buffer)

automatically generated writer method

Source

buffer.lisp (file)

Generic Function: %buffer-next OBJECT

Generic Function: (setf %buffer-next) NEW-VALUE OBJECT

Package

linedit

Methods

Method: %buffer-next (BUFFER buffer)

automatically generated reader method

Source

buffer.lisp (file)

Method: (setf %buffer-next) NEW-VALUE (BUFFER buffer)

automatically generated writer method

Source

buffer.lisp (file)

Generic Function: %buffer-pathname OBJECT

Generic Function: (setf %buffer-pathname) NEW-VALUE OBJECT

Package

linedit

Methods

Method: %buffer-pathname (BUFFER buffer)

automatically generated reader method

Source

buffer.lisp (file)

Method: (setf %buffer-pathname) NEW-VALUE (BUFFER buffer)

automatically generated writer method

Source

buffer.lisp (file)

Generic Function: %buffer-prev OBJECT

Generic Function: (setf %buffer-prev) NEW-VALUE OBJECT

Package

linedit

Methods

Method: %buffer-prev (BUFFER buffer)

automatically generated reader method

Source

buffer.lisp (file)

Method: (setf %buffer-prev) NEW-VALUE (BUFFER buffer)

automatically generated writer method

Source

buffer.lisp (file)

Generic Function: %rewind-index OBJECT

Generic Function: (setf %rewind-index) NEW-VALUE OBJECT

Package

linedit

Methods

Method: %rewind-index (REWINDABLE rewindable)

automatically generated reader method

Source

rewindable.lisp (file)

Method: (setf %rewind-index) NEW-VALUE (REWINDABLE rewindable)

automatically generated writer method

Source

rewindable.lisp (file)

Generic Function: %rewind-store OBJECT

Package

linedit

Methods

Method: %rewind-store (REWINDABLE rewindable)

automatically generated reader method

Source

rewindable.lisp (file)

Generic Function: backend-close BACKEND

Package

linedit

Methods

Method: backend-close (BACKEND terminal)

Source

terminal.lisp (file)

Generic Function: backend-columns BACKEND

Package

linedit

Methods

Method: backend-columns (BACKEND terminal)

Source

terminal.lisp (file)

Generic Function: backend-init BACKEND

Package

linedit

Methods

Method: backend-init (BACKEND smart-terminal)

Source

smart-terminal.lisp (file)

Method: backend-init (BACKEND terminal)

Source

terminal.lisp (file)

Generic Function: backend-lines BACKEND

Package

linedit

Methods

Method: backend-lines (BACKEND terminal)

Source

terminal.lisp (file)

Generic Function: backend-ready-p OBJECT

Generic Function: (setf backend-ready-p) NEW-VALUE OBJECT

Package

linedit

Methods

Method: backend-ready-p (BACKEND backend)

automatically generated reader method

Source

backend.lisp (file)

Method: (setf backend-ready-p) NEW-VALUE (BACKEND backend)

automatically generated writer method

Source

backend.lisp (file)

Generic Function: backend-translations OBJECT

Package

linedit

Methods

Method: backend-translations (BACKEND backend)

automatically generated reader method

Source

backend.lisp (file)

Generic Function: beep B

Package

linedit

Methods

Method: beep (B terminal)

Source

terminal.lisp (file)

Generic Function: dirty-p OBJECT

Generic Function: (setf dirty-p) NEW-VALUE OBJECT

Package

linedit

Methods

Method: dirty-p (TERMINAL terminal)

automatically generated reader method

Source

terminal.lisp (file)

Method: (setf dirty-p) NEW-VALUE (TERMINAL terminal)

automatically generated writer method

Source

terminal.lisp (file)

Generic Function: display BACKEND &key PROMPT LINE POINT MARKUP &allow-other-keys

Package

linedit

Source

backend.lisp (file)

Methods

Method: display (BACKEND dumb-terminal) &key PROMPT LINE POINT &allow-other-keys

Source

dumb-terminal.lisp (file)

Method: display (BACKEND smart-terminal) &key PROMPT LINE POINT MARKUP

Source

smart-terminal.lisp (file)

Generic Function: editor-commands OBJECT

Package

linedit

Methods

Method: editor-commands (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Generic Function: editor-completer OBJECT

Package

linedit

Methods

Method: editor-completer (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Generic Function: editor-history OBJECT

Generic Function: (setf editor-history) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-history (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-history) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: editor-insert-mode OBJECT

Generic Function: (setf editor-insert-mode) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-insert-mode (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-insert-mode) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: editor-killring OBJECT

Generic Function: (setf editor-killring) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-killring (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-killring) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: editor-last-yank OBJECT

Generic Function: (setf editor-last-yank) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-last-yank (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-last-yank) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: editor-mark OBJECT

Generic Function: (setf editor-mark) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-mark (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-mark) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: editor-prompt OBJECT

Generic Function: (setf editor-prompt) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-prompt (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-prompt) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: editor-yank OBJECT

Generic Function: (setf editor-yank) NEW-VALUE OBJECT

Package

linedit

Methods

Method: editor-yank (EDITOR editor)

automatically generated reader method

Source

editor.lisp (file)

Method: (setf editor-yank) NEW-VALUE (EDITOR editor)

automatically generated writer method

Source

editor.lisp (file)

Generic Function: get-point OBJECT

Generic Function: (setf get-point) NEW-VALUE OBJECT

Package

linedit

Methods

Method: get-point (LINE line)

automatically generated reader method

Source

line.lisp (file)

Method: (setf get-point) NEW-VALUE (LINE line)

automatically generated writer method

Source

line.lisp (file)

Method: (setf get-point) POINT LINE around

Source

line.lisp (file)

Generic Function: get-start OBJECT

Generic Function: (setf get-start) NEW-VALUE OBJECT

Package

linedit

Methods

Method: get-start (BACKEND backend)

automatically generated reader method

Source

backend.lisp (file)

Method: (setf get-start) NEW-VALUE (BACKEND backend)

automatically generated writer method

Source

backend.lisp (file)

Generic Function: get-string OBJECT

Generic Function: (setf get-string) NEW-VALUE OBJECT

Package

linedit

Methods

Method: get-string (LINE line)

automatically generated reader method

Source

line.lisp (file)

Method: (setf get-string) NEW-VALUE (LINE line)

automatically generated writer method

Source

line.lisp (file)

Method: (setf get-string) STRING LINE around

Source

line.lisp (file)