The clinenoise Reference Manual

Table of Contents

The clinenoise Reference Manual

This is the clinenoise Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:37:23 2021 GMT+0.

1 Introduction

This is the stub README.txt for the "clinenoise" project.

2 Systems

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

2.1 clinenoise

Author

<Jason Miller <aidenn0@geocities.com>

License

BSD-2

Description

A trivial line-input library for VT-like terminals

Defsystem Dependency

cffi-grovel

Dependencies

• cffi
• alexandria
• split-sequence
• cffi-grovel

Source

clinenoise.asd (file)

Components

• package.lisp (file)
• termios-grovel.lisp (file)
• cwrappers.lisp (file)
• clinenoise.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 clinenoise.asd

Location

clinenoise.asd

Systems

clinenoise (system)

3.1.2 clinenoise/package.lisp

Parent

clinenoise (system)

Location

package.lisp

Packages

clinenoise

3.1.3 clinenoise/termios-grovel.lisp

Dependency

package.lisp (file)

Parent

clinenoise (system)

Location

termios-grovel.lisp

3.1.4 clinenoise/cwrappers.lisp

Dependency

termios-grovel.lisp (file)

Parent

clinenoise (system)

Location

cwrappers.lisp

Internal Definitions

• cread (function)
• getenv (function)
• ioctl (macro)
• isatty (function)
• tcgetattr (function)
• tcsetattr (function)
• zero-or-error-from-c (function)

3.1.5 clinenoise/clinenoise.lisp

Dependency

cwrappers.lisp (file)

Parent

clinenoise (system)

Location

clinenoise.lisp

Exported Definitions

• history-add (function)
• history-load (function)
• history-save (function)
• linenoise (function)

Internal Definitions

• *completion-callback* (special variable)
• *history* (special variable)
• *history-len* (special variable)
• *mlmode* (special variable)
• *unread-char* (special variable)
• +linenoise-default-history-max-len+ (constant)
• +linenoise-max-line+ (constant)
• +unsupported-term+ (special variable)
• clear-screen (function)
• complete-line (function)
• copy-linenoise-state (function)
• edit (function)
• edit-backspace (function)
• edit-delete (function)
• edit-delete-prev-word (function)
• edit-history-next (function)
• edit-insert (function)
• edit-move-left (function)
• edit-move-right (function)
• enable-raw-mode (function)
• get-columns (function)
• is-unsupported-term (function)
• linenoise-beep (function)
• linenoise-clear-screen (function)
• linenoise-raw (function)
• linenoise-set-multiline (function)
• linenoise-state (structure)
• linenoise-state-p (function)
• ls-buf (function)
• (setf ls-buf) (function)
• ls-cols (function)
• (setf ls-cols) (function)
• ls-fd (function)
• (setf ls-fd) (function)
• ls-history-index (function)
• (setf ls-history-index) (function)
• ls-maxrows (function)
• (setf ls-maxrows) (function)
• ls-oldpos (function)
• (setf ls-oldpos) (function)
• ls-plen (function)
• (setf ls-plen) (function)
• ls-pos (function)
• (setf ls-pos) (function)
• ls-prompt (function)
• (setf ls-prompt) (function)
• make-linenoise-state (function)
• my-read-char (function)
• my-unread-char (function)
• refresh-line (function)
• refresh-multi-line (function)
• refresh-single-line (function)
• restore-tty (function)
• set-completion-callback (function)
• with-raw-mode (macro)

4 Packages

Packages are listed by definition order.

4.1 clinenoise

Source

package.lisp (file)

Use List

• split-sequence
• alexandria
• cffi
• common-lisp

Exported Definitions

• history-add (function)
• history-load (function)
• history-save (function)
• linenoise (function)

Internal Definitions

• *completion-callback* (special variable)
• *history* (special variable)
• *history-len* (special variable)
• *mlmode* (special variable)
• *unread-char* (special variable)
• +brkint+ (constant)
• +cs8+ (constant)
• +echo+ (constant)
• +icanon+ (constant)
• +icrnl+ (constant)
• +iexten+ (constant)
• +inpck+ (constant)
• +isig+ (constant)
• +istrip+ (constant)
• +ixon+ (constant)
• +linenoise-default-history-max-len+ (constant)
• +linenoise-max-line+ (constant)
• +nccs+ (constant)
• +opost+ (constant)
• +tcsaflush+ (constant)
• +tiocgwinsz+ (constant)
• +unsupported-term+ (special variable)
• +vmin+ (constant)
• +vtime+ (constant)
• clear-screen (function)
• complete-line (function)
• copy-linenoise-state (function)
• cread (function)
• edit (function)
• edit-backspace (function)
• edit-delete (function)
• edit-delete-prev-word (function)
• edit-history-next (function)
• edit-insert (function)
• edit-move-left (function)
• edit-move-right (function)
• enable-raw-mode (function)
• get-columns (function)
• getenv (function)
• ioctl (macro)
• is-unsupported-term (function)
• isatty (function)
• linenoise-beep (function)
• linenoise-clear-screen (function)
• linenoise-raw (function)
• linenoise-set-multiline (function)
• linenoise-state (structure)
• linenoise-state-p (function)
• ls-buf (function)
• (setf ls-buf) (function)
• ls-cols (function)
• (setf ls-cols) (function)
• ls-fd (function)
• (setf ls-fd) (function)
• ls-history-index (function)
• (setf ls-history-index) (function)
• ls-maxrows (function)
• (setf ls-maxrows) (function)
• ls-oldpos (function)
• (setf ls-oldpos) (function)
• ls-plen (function)
• (setf ls-plen) (function)
• ls-pos (function)
• (setf ls-pos) (function)
• ls-prompt (function)
• (setf ls-prompt) (function)
• make-linenoise-state (function)
• my-read-char (function)
• my-unread-char (function)
• refresh-line (function)
• refresh-multi-line (function)
• refresh-single-line (function)
• restore-tty (function)
• set-completion-callback (function)
• size-of-cc-t (constant)
• size-of-size_t (constant)
• size-of-ssize_t (constant)
• size-of-tcflag (constant)
• size-of-termios (constant)
• size-of-winsize (constant)
• tcgetattr (function)
• tcsetattr (function)
• termios-tclass (class)
• winsize-tclass (class)
• with-raw-mode (macro)
• zero-or-error-from-c (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: history-add LINE

Add LINE to the prompt history

Package

clinenoise

Source

clinenoise.lisp (file)

Function: history-load FN

Load history from pathname FN

Package

clinenoise

Source

clinenoise.lisp (file)

Function: history-save FN

Save history to pathname FN

Package

clinenoise

Source

clinenoise.lisp (file)

Function: linenoise PROMPT &optional PLEN

Display PROMPT and wait for a line to be entered with basic editing support PLEN can be specified for prompts that have a display width different from their character count (e.g. combining characters, escape codes)

Package

clinenoise

Source

clinenoise.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +brkint+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +cs8+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +echo+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +icanon+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +icrnl+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +iexten+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +inpck+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +isig+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +istrip+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +ixon+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +linenoise-default-history-max-len+

Package

clinenoise

Source

clinenoise.lisp (file)

Constant: +linenoise-max-line+

Package

clinenoise

Source

clinenoise.lisp (file)

Constant: +nccs+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +opost+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +tcsaflush+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +tiocgwinsz+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +vmin+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: +vtime+

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: size-of-cc-t

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: size-of-size_t

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: size-of-ssize_t

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: size-of-tcflag

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: size-of-termios

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Constant: size-of-winsize

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

5.2.2 Special variables

Special Variable: *completion-callback*

Function to call for completions.
Takes the current line as a parameter, and returns a list of possible completions Does not currently indicate the position of the cursor when the completion was requested

Package

clinenoise

Source

clinenoise.lisp (file)

Special Variable: *history*

Package

clinenoise

Source

clinenoise.lisp (file)

Special Variable: *history-len*

Package

clinenoise

Source

clinenoise.lisp (file)

Special Variable: *mlmode*

Package

clinenoise

Source

clinenoise.lisp (file)

Special Variable: *unread-char*

Package

clinenoise

Source

clinenoise.lisp (file)

Special Variable: +unsupported-term+

Package

clinenoise

Source

clinenoise.lisp (file)

5.2.3 Macros

Macro: ioctl D REQUEST &rest VARARGS0

Package

clinenoise

Source

cwrappers.lisp (file)

Macro: with-raw-mode (FD) &body B

Package

clinenoise

Source

clinenoise.lisp (file)

5.2.4 Functions

Function: clear-screen ()

Package

clinenoise

Source

clinenoise.lisp (file)

Function: complete-line LS

Package

clinenoise

Source

clinenoise.lisp (file)

Function: copy-linenoise-state INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: cread FD BUF NBYTE

Package

clinenoise

Source

cwrappers.lisp (file)

Function: edit FD PROMPT PLEN

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-backspace L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-delete L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-delete-prev-word L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-history-next L DIR

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-insert L C

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-move-left L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: edit-move-right L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: enable-raw-mode FD

Package

clinenoise

Source

clinenoise.lisp (file)

Function: get-columns ()

Package

clinenoise

Source

clinenoise.lisp (file)

Function: getenv NAME

Package

clinenoise

Source

cwrappers.lisp (file)

Function: is-unsupported-term ()

Package

clinenoise

Source

clinenoise.lisp (file)

Function: isatty FD

Package

clinenoise

Source

cwrappers.lisp (file)

Function: linenoise-beep ()

Package

clinenoise

Source

clinenoise.lisp (file)

Function: linenoise-clear-screen ()

Package

clinenoise

Source

clinenoise.lisp (file)

Function: linenoise-raw PROMPT PLEN

Package

clinenoise

Source

clinenoise.lisp (file)

Function: linenoise-set-multiline ML

Package

clinenoise

Source

clinenoise.lisp (file)

Function: linenoise-state-p OBJECT

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-buf INSTANCE

Function: (setf ls-buf) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-cols INSTANCE

Function: (setf ls-cols) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-fd INSTANCE

Function: (setf ls-fd) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-history-index INSTANCE

Function: (setf ls-history-index) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-maxrows INSTANCE

Function: (setf ls-maxrows) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-oldpos INSTANCE

Function: (setf ls-oldpos) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-plen INSTANCE

Function: (setf ls-plen) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-pos INSTANCE

Function: (setf ls-pos) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: ls-prompt INSTANCE

Function: (setf ls-prompt) VALUE INSTANCE

Package

clinenoise

Source

clinenoise.lisp (file)

Function: make-linenoise-state &key (FD FD) (BUF BUF) (PROMPT PROMPT) (PLEN PLEN) (POS POS) (OLDPOS OLDPOS) (COLS COLS) (MAXROWS MAXROWS) (HISTORY-INDEX HISTORY-INDEX)

Package

clinenoise

Source

clinenoise.lisp (file)

Function: my-read-char FD

Package

clinenoise

Source

clinenoise.lisp (file)

Function: my-unread-char CH FD

Package

clinenoise

Source

clinenoise.lisp (file)

Function: refresh-line L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: refresh-multi-line L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: refresh-single-line L

Package

clinenoise

Source

clinenoise.lisp (file)

Function: restore-tty FD ORIG-TERMIOS

Package

clinenoise

Source

clinenoise.lisp (file)

Function: set-completion-callback FN

Package

clinenoise

Source

clinenoise.lisp (file)

Function: tcgetattr FD TERMIOS-P

Package

clinenoise

Source

cwrappers.lisp (file)

Function: tcsetattr FD OPTIONAL-ACTIONS TERMIOS-P

Package

clinenoise

Source

cwrappers.lisp (file)

Function: zero-or-error-from-c VALUE

Package

clinenoise

Source

cwrappers.lisp (file)

5.2.5 Structures

Structure: linenoise-state ()

Package

clinenoise

Source

clinenoise.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: fd

Readers

ls-fd (function)

Writers

(setf ls-fd) (function)

Slot: buf

Readers

ls-buf (function)

Writers

(setf ls-buf) (function)

Slot: prompt

Readers

ls-prompt (function)

Writers

(setf ls-prompt) (function)

Slot: plen

Readers

ls-plen (function)

Writers

(setf ls-plen) (function)

Slot: pos

Readers

ls-pos (function)

Writers

(setf ls-pos) (function)

Slot: oldpos

Readers

ls-oldpos (function)

Writers

(setf ls-oldpos) (function)

Slot: cols

Readers

ls-cols (function)

Writers

(setf ls-cols) (function)

Slot: maxrows

Readers

ls-maxrows (function)

Writers

(setf ls-maxrows) (function)

Slot: history-index

Readers

ls-history-index (function)

Writers

(setf ls-history-index) (function)

5.2.6 Classes

Class: termios-tclass ()

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Direct superclasses

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

Class: winsize-tclass ()

Package

clinenoise

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/clinenoise-20200427-git/termios-grovel.processed-grovel-file

Direct superclasses

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

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types