The uncursed Reference Manual

Table of Contents

The uncursed Reference Manual

This is the uncursed Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:24:47 2020 GMT+0.

1 Introduction

uncursed

A library for writing terminal interfaces without curses. A higher-level buffered abstraction and low-level utilities are available. Supported implementations will include sbcl, ccl and ecl.

Some basic examples can be found in the examples directory. n.b. sand-game.lisp features the color/timer functionality of the library and displays flashing colors.

• [x] unicode support
• [x] basic terminal resizing support
• [ ] more comprehensive input handling
• [x] timers
• [ ] widgets

2 Systems

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

2.1 uncursed

Author

tianlin qu

License

BSD 3-Clause

Description

Another TUI library, this time without curses.

Version

0.2.0

Defsystem Dependency

cffi-grovel

Dependencies

• alexandria
• cffi
• terminfo

Source

uncursed.asd (file)

Components

• package.lisp (file)
• grovel.lisp (file)
• condition.lisp (file)
• util.lisp (file)
• uncursed.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 uncursed.asd

Location

uncursed.asd

Systems

uncursed (system)

3.1.2 uncursed/package.lisp

Parent

uncursed (system)

Location

package.lisp

Packages

• uncursed-sys
• uncursed

3.1.3 uncursed/grovel.lisp

Dependency

package.lisp (file)

Parent

uncursed (system)

Location

grovel.lisp

3.1.4 uncursed/condition.lisp

Dependency

grovel.lisp (file)

Parent

uncursed (system)

Location

condition.lisp

Exported Definitions

• syscall-error (condition)
• uncursed-error (condition)

Internal Definitions

error-syscall-error (function)

3.1.5 uncursed/util.lisp

Dependency

condition.lisp (file)

Parent

uncursed (system)

Location

util.lisp

Exported Definitions

• *character-widths* (special variable)
• *default-style* (special variable)
• bg (function)
• (setf bg) (function)
• blue (function)
• boldp (function)
• (setf boldp) (function)
• catch-sigwinch (function)
• character-width (function)
• clear-chars (function)
• clear-screen (function)
• clear-to-end-of-line (function)
• copy-rectangle (function)
• copy-style (function)
• disable-alternate-screen (function)
• disable-mouse (function)
• display-width (function)
• enable-alternate-screen (function)
• enable-mouse (function)
• fg (function)
• (setf fg) (function)
• green (function)
• italicp (function)
• (setf italicp) (function)
• make-rectangle (function)
• make-style (function)
• mouse-event-p (function)
• read-event (function)
• read-event-timeout (function)
• rect-cols (function)
• (setf rect-cols) (function)
• rect-rows (function)
• (setf rect-rows) (function)
• rect-x (function)
• (setf rect-x) (function)
• rect-y (function)
• (setf rect-y) (function)
• rectangle (structure)
• red (function)
• reset-sigwinch (function)
• restore-terminal (function)
• reversep (function)
• (setf reversep) (function)
• set-background (function)
• set-cursor-position (function)
• set-cursor-shape (function)
• set-foreground (function)
• set-style (function)
• set-style-from-old (function)
• setup-terminal (function)
• style (structure)
• style-difference (function)
• terminal-dimensions (function)
• underlinep (function)
• (setf underlinep) (function)

Internal Definitions

• *fallback-terminal-dimensions* (special variable)
• *got-sigwinch* (special variable)
• +sigwinch+ (constant)
• rectangle-p (function)
• style-p (function)
• tcgetattr (function)
• tcsetattr (function)

3.1.6 uncursed/uncursed.lisp

Dependency

util.lisp (file)

Parent

uncursed (system)

Location

uncursed.lisp

Exported Definitions

• cell (class)
• cell-string (method)
• (setf cell-string) (method)
• cell-style (method)
• (setf cell-style) (method)
• columns (method)
• (setf columns) (method)
• dimensions (method)
• (setf dimensions) (method)
• event-handler (method)
• (setf event-handler) (method)
• focused-window (method)
• (setf focused-window) (method)
• got-winch (method)
• got-winch (method)
• (setf got-winch) (method)
• handle-event (generic function)
• handle-key-event (generic function)
• handle-mouse-event (generic function)
• handle-resize (generic function)
• handle-resize (method)
• lines (method)
• (setf lines) (method)
• make-timer (function)
• present (generic function)
• present (method)
• put (function)
• put-style (function)
• puts (function)
• redisplay (generic function)
• redisplay (method)
• redisplay (method)
• run (generic function)
• run (method)
• run (method)
• schedule-timer (method)
• standard-window (class)
• stop (generic function)
• stop (method)
• timer-callback (method)
• (setf timer-callback) (method)
• timer-interval (method)
• (setf timer-interval) (method)
• tui (class)
• tui-base (class)
• unschedule-timer (method)
• wide-char-overwrite-error (condition)
• win-focused-p (method)
• (setf win-focused-p) (method)
• window (class)
• window-bounds-error (condition)
• window-bounds-error-bounds (method)
• window-bounds-error-coordinate (method)
• window-bounds-error-window (method)
• windows (method)
• (setf windows) (method)

Internal Definitions

• %termios (method)
• (setf %termios) (method)
• *put-buffer* (special variable)
• *put-window* (special variable)
• buffer (type)
• buffer-diff (function)
• canvas (method)
• (setf canvas) (method)
• cell/= (function)
• dispatch-mouse-event (function)
• handle-winch (method)
• screen (method)
• (setf screen) (method)
• timer (class)
• timers (method)
• (setf timers) (method)
• wide-cell-p (function)
• wide-char-overwrite-error-buffer (method)
• wide-char-overwrite-error-x (method)
• wide-char-overwrite-error-y (method)

4 Packages

Packages are listed by definition order.

4.1 uncursed-sys

Source

package.lisp (file)

Use List

• alexandria
• common-lisp

Used By List

uncursed

Exported Definitions

• *character-widths* (special variable)
• *default-style* (special variable)
• bg (function)
• (setf bg) (function)
• blue (function)
• boldp (function)
• (setf boldp) (function)
• catch-sigwinch (function)
• character-width (function)
• clear-chars (function)
• clear-screen (function)
• clear-to-end-of-line (function)
• copy-rectangle (function)
• copy-style (function)
• disable-alternate-screen (function)
• disable-mouse (function)
• display-width (function)
• enable-alternate-screen (function)
• enable-mouse (function)
• fg (function)
• (setf fg) (function)
• green (function)
• italicp (function)
• (setf italicp) (function)
• make-rectangle (function)
• make-style (function)
• mouse-event-p (function)
• read-event (function)
• read-event-timeout (function)
• rect-cols (function)
• (setf rect-cols) (function)
• rect-rows (function)
• (setf rect-rows) (function)
• rect-x (function)
• (setf rect-x) (function)
• rect-y (function)
• (setf rect-y) (function)
• rectangle (structure)
• red (function)
• reset-sigwinch (function)
• restore-terminal (function)
• reversep (function)
• (setf reversep) (function)
• set-background (function)
• set-cursor-position (function)
• set-cursor-shape (function)
• set-foreground (function)
• set-style (function)
• set-style-from-old (function)
• setup-terminal (function)
• style (structure)
• style-difference (function)
• syscall-error (condition)
• terminal-dimensions (function)
• uncursed-error (condition)
• underlinep (function)
• (setf underlinep) (function)

Internal Definitions

• *fallback-terminal-dimensions* (special variable)
• *got-sigwinch* (special variable)
• +sigwinch+ (constant)
• c-echo (constant)
• c-get-winsz (constant)
• c-icanon (constant)
• c-icrnl (constant)
• c-iexten (constant)
• c-igncr (constant)
• c-inlcr (constant)
• c-inpck (constant)
• c-isig (constant)
• c-istrip (constant)
• c-ixoff (constant)
• c-ixon (constant)
• c-lc-ctype (constant)
• c-max-size (constant)
• c-opost (constant)
• c-parenb (constant)
• c-set-attributes-now (constant)
• c-sigwinch (constant)
• c-termios-tclass (class)
• c-winsize-tclass (class)
• error-syscall-error (function)
• rectangle-p (function)
• size-of-c-size (constant)
• size-of-c-tcflag (constant)
• size-of-c-termios (constant)
• size-of-c-wchar (constant)
• size-of-c-winsize (constant)
• style-p (function)
• tcgetattr (function)
• tcsetattr (function)

4.2 uncursed

Source

package.lisp (file)

Use List

• uncursed-sys
• common-lisp

Exported Definitions

• cell (class)
• cell-string (generic function)
• cell-string (method)
• (setf cell-string) (method)
• (setf cell-string) (generic function)
• cell-style (generic function)
• cell-style (method)
• (setf cell-style) (generic function)
• (setf cell-style) (method)
• columns (generic function)
• columns (method)
• (setf columns) (method)
• (setf columns) (generic function)
• dimensions (generic function)
• dimensions (method)
• (setf dimensions) (method)
• (setf dimensions) (generic function)
• event-handler (generic function)
• event-handler (method)
• (setf event-handler) (method)
• (setf event-handler) (generic function)
• focused-window (generic function)
• focused-window (method)
• (setf focused-window) (method)
• (setf focused-window) (generic function)
• got-winch (generic function)
• got-winch (method)
• got-winch (method)
• (setf got-winch) (method)
• (setf got-winch) (generic function)
• handle-event (generic function)
• handle-key-event (generic function)
• handle-mouse-event (generic function)
• handle-resize (generic function)
• handle-resize (method)
• lines (generic function)
• lines (method)
• (setf lines) (method)
• (setf lines) (generic function)
• make-timer (function)
• present (generic function)
• present (method)
• put (function)
• put-style (function)
• puts (function)
• redisplay (generic function)
• redisplay (method)
• redisplay (method)
• run (generic function)
• run (method)
• run (method)
• schedule-timer (generic function)
• schedule-timer (method)
• standard-window (class)
• stop (generic function)
• stop (method)
• timer-callback (generic function)
• timer-callback (method)
• (setf timer-callback) (method)
• (setf timer-callback) (generic function)
• timer-interval (generic function)
• timer-interval (method)
• (setf timer-interval) (method)
• (setf timer-interval) (generic function)
• tui (class)
• tui-base (class)
• unschedule-timer (generic function)
• unschedule-timer (method)
• wide-char-overwrite-error (condition)
• win-focused-p (generic function)
• win-focused-p (method)
• (setf win-focused-p) (method)
• (setf win-focused-p) (generic function)
• window (class)
• window-bounds-error (condition)
• window-bounds-error-bounds (generic function)
• window-bounds-error-bounds (method)
• window-bounds-error-coordinate (generic function)
• window-bounds-error-coordinate (method)
• window-bounds-error-window (generic function)
• window-bounds-error-window (method)
• windows (generic function)
• windows (method)
• (setf windows) (method)
• (setf windows) (generic function)

Internal Definitions

• %termios (generic function)
• %termios (method)
• (setf %termios) (method)
• (setf %termios) (generic function)
• *put-buffer* (special variable)
• *put-window* (special variable)
• buffer (type)
• buffer-diff (function)
• canvas (generic function)
• canvas (method)
• (setf canvas) (method)
• (setf canvas) (generic function)
• cell/= (function)
• dispatch-mouse-event (function)
• handle-winch (generic function)
• handle-winch (method)
• screen (generic function)
• screen (method)
• (setf screen) (method)
• (setf screen) (generic function)
• timer (class)
• timers (generic function)
• timers (method)
• (setf timers) (method)
• (setf timers) (generic function)
• wide-cell-p (function)
• wide-char-overwrite-error-buffer (generic function)
• wide-char-overwrite-error-buffer (method)
• wide-char-overwrite-error-x (generic function)
• wide-char-overwrite-error-x (method)
• wide-char-overwrite-error-y (generic function)
• wide-char-overwrite-error-y (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *character-widths*

Package

uncursed-sys

Source

util.lisp (file)

Special Variable: *default-style*

Package

uncursed-sys

Source

util.lisp (file)

5.1.2 Functions

Function: bg INSTANCE

Function: (setf bg) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: blue COLOR

Package

uncursed-sys

Source

util.lisp (file)

Function: boldp INSTANCE

Function: (setf boldp) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: catch-sigwinch ()

Enables handling SIGWINCH. May fail silently.

Package

uncursed-sys

Source

util.lisp (file)

Function: character-width CHARACTER

Returns the displayed width of CHARACTER

Package

uncursed-sys

Source

util.lisp (file)

Function: clear-chars &optional N

Package

uncursed-sys

Source

util.lisp (file)

Function: clear-screen ()

Package

uncursed-sys

Source

util.lisp (file)

Function: clear-to-end-of-line ()

Package

uncursed-sys

Source

util.lisp (file)

Function: copy-rectangle INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: copy-style INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: disable-alternate-screen ()

Package

uncursed-sys

Source

util.lisp (file)

Function: disable-mouse ()

Package

uncursed-sys

Source

util.lisp (file)

Function: display-width STRING

Good enough

Package

uncursed-sys

Source

util.lisp (file)

Function: enable-alternate-screen ()

Package

uncursed-sys

Source

util.lisp (file)

Function: enable-mouse ()

Package

uncursed-sys

Source

util.lisp (file)

Function: fg INSTANCE

Function: (setf fg) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: green COLOR

Package

uncursed-sys

Source

util.lisp (file)

Function: italicp INSTANCE

Function: (setf italicp) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: make-rectangle &key (X X) (Y Y) (ROWS ROWS) (COLS COLS)

Package

uncursed-sys

Source

util.lisp (file)

Function: make-style &key (FG FG) (BG BG) (BOLDP BOLDP) (ITALICP ITALICP) (REVERSEP REVERSEP) (UNDERLINEP UNDERLINEP)

Package

uncursed-sys

Source

util.lisp (file)

Function: make-timer INTERVAL CALLBACK

Package

uncursed

Source

uncursed.lisp (file)

Function: mouse-event-p EVENT

Package

uncursed-sys

Source

util.lisp (file)

Function: put CHAR LINE COL &optional STYLE PUT-BUFFER PUT-WINDOW

Package

uncursed

Source

uncursed.lisp (file)

Function: put-style STYLE RECT &optional PUT-BUFFER PUT-WINDOW

Package

uncursed

Source

uncursed.lisp (file)

Function: puts STRING LINE COL &optional STYLE PUT-BUFFER PUT-WINDOW

Package

uncursed

Source

uncursed.lisp (file)

Function: read-event &optional STREAM &aux *TERMINAL-IO* FIRST SECOND THIRD

Package

uncursed-sys

Source

util.lisp (file)

Function: read-event-timeout &optional TIMEOUT STREAM

Package

uncursed-sys

Source

util.lisp (file)

Function: rect-cols INSTANCE

Function: (setf rect-cols) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: rect-rows INSTANCE

Function: (setf rect-rows) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: rect-x INSTANCE

Function: (setf rect-x) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: rect-y INSTANCE

Function: (setf rect-y) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: red COLOR

Package

uncursed-sys

Source

util.lisp (file)

Function: reset-sigwinch ()

Package

uncursed-sys

Source

util.lisp (file)

Function: restore-terminal OLD-TERMIOS FD

Restores the terminal device backing FD to its original state. ORIG-TERMIOS is a pointer to the original termios struct returned by a call to SETUP-TERM which is freed.

Package

uncursed-sys

Source

util.lisp (file)

Function: reversep INSTANCE

Function: (setf reversep) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

Function: set-background R G B

Package

uncursed-sys

Source

util.lisp (file)

Function: set-cursor-position LINE COLUMN

NEW-VALUE is a (LINE . COLUMN) pair

Package

uncursed-sys

Source

util.lisp (file)

Function: set-cursor-shape STYLE &key BLINK-P

Package

uncursed-sys

Source

util.lisp (file)

Function: set-foreground R G B

Package

uncursed-sys

Source

util.lisp (file)

Function: set-style STYLE

Package

uncursed-sys

Source

util.lisp (file)

Function: set-style-from-old CURRENT-STYLE NEW-STYLE

Package

uncursed-sys

Source

util.lisp (file)

Function: setup-terminal FD

Disables terminal echoing and buffering and enables mouse mode 1003. Returns a pointer to the original termios. Sets process locale to environment.

Package

uncursed-sys

Source

util.lisp (file)

Function: style-difference A B

Package

uncursed-sys

Source

util.lisp (file)

Function: terminal-dimensions ()

Returns a cons (LINES . COLUMNS) containing the dimensions of the terminal device backing FD. Returns NIL on failure.

Package

uncursed-sys

Source

util.lisp (file)

Function: underlinep INSTANCE

Function: (setf underlinep) VALUE INSTANCE

Package

uncursed-sys

Source

util.lisp (file)

5.1.3 Generic functions

Generic Function: cell-string OBJECT

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

Package

uncursed

Methods

Method: cell-string (CELL cell)

Method: (setf cell-string) NEW-VALUE (CELL cell)

Represents a grapheme cluster and its display style.
Note that setf-ing the style copies over the new attributes into the existing cell-style.

Source

uncursed.lisp (file)

Generic Function: cell-style OBJECT

Generic Function: (setf cell-style) NEW-VALUE CELL

Package

uncursed

Methods

Method: cell-style (CELL cell)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf cell-style) NEW-VALUE (CELL cell)

Source

uncursed.lisp (file)

Generic Function: columns OBJECT

Generic Function: (setf columns) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: columns (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf columns) NEW-VALUE (TUI-BASE tui-base)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: dimensions OBJECT

Generic Function: (setf dimensions) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: dimensions (WINDOW window)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf dimensions) NEW-VALUE (WINDOW window)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: event-handler OBJECT

Generic Function: (setf event-handler) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: event-handler (TUI tui)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf event-handler) NEW-VALUE (TUI tui)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: focused-window OBJECT

Generic Function: (setf focused-window) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: focused-window (TUI tui)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf focused-window) NEW-VALUE (TUI tui)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: got-winch OBJECT

Generic Function: (setf got-winch) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: got-winch (TUI tui-base) before

Source

uncursed.lisp (file)

Method: got-winch (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf got-winch) NEW-VALUE (TUI-BASE tui-base)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: handle-event TUI EV

Package

uncursed

Source

uncursed.lisp (file)

Generic Function: handle-key-event WINDOW TUI EVENT

Package

uncursed

Source

uncursed.lisp (file)

Generic Function: handle-mouse-event WINDOW TUI TYPE BUTTON LINE COL CONTROLP

Package

uncursed

Source

uncursed.lisp (file)

Generic Function: handle-resize TUI

Package

uncursed

Source

uncursed.lisp (file)

Methods

Method: handle-resize (TUI tui) before

Generic Function: lines OBJECT

Generic Function: (setf lines) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: lines (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf lines) NEW-VALUE (TUI-BASE tui-base)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: present WINDOW

Package

uncursed

Source

uncursed.lisp (file)

Methods

Method: present (WINDOW standard-window) around

Generic Function: redisplay TUI

Package

uncursed

Source

uncursed.lisp (file)

Methods

Method: redisplay (TUI tui)

Method: redisplay (TUI tui) around

Generic Function: run TUI

Package

uncursed

Source

uncursed.lisp (file)

Methods

Method: run (TUI tui)

Method: run (TUI tui-base) around

Generic Function: schedule-timer TUI TIMER

Package

uncursed

Methods

Method: schedule-timer (TUI tui) TIMER

Source

uncursed.lisp (file)

Generic Function: stop TUI

Causes the terminal to be restored to its original state immediately. May only be called from within the dynamic-extent of a call to RUN.

Package

uncursed

Source

uncursed.lisp (file)

Methods

Method: stop (TUI tui)

Generic Function: timer-callback OBJECT

Generic Function: (setf timer-callback) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: timer-callback (TIMER timer)

Method: (setf timer-callback) NEW-VALUE (TIMER timer)

A function that is run when the timer expires. It is a function
of one argument, the TUI object it was scheduled with and is expected to return one value: either the next timer expiry interval or NIL, meaning to cancel the timer.

Source

uncursed.lisp (file)

Generic Function: timer-interval OBJECT

Generic Function: (setf timer-interval) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: timer-interval (TIMER timer)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf timer-interval) NEW-VALUE (TIMER timer)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: unschedule-timer TUI TIMER

Package

uncursed

Methods

Method: unschedule-timer (TUI tui) TIMER

Source

uncursed.lisp (file)

Generic Function: win-focused-p OBJECT

Generic Function: (setf win-focused-p) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: win-focused-p (WINDOW window)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf win-focused-p) NEW-VALUE (WINDOW window)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: window-bounds-error-bounds CONDITION

Package

uncursed

Methods

Method: window-bounds-error-bounds (CONDITION window-bounds-error)

Source

uncursed.lisp (file)

Generic Function: window-bounds-error-coordinate CONDITION

Package

uncursed

Methods

Method: window-bounds-error-coordinate (CONDITION window-bounds-error)

Source

uncursed.lisp (file)

Generic Function: window-bounds-error-window CONDITION

Package

uncursed

Methods

Method: window-bounds-error-window (CONDITION window-bounds-error)

Source

uncursed.lisp (file)

Generic Function: windows OBJECT

Generic Function: (setf windows) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: windows (TUI-BASE tui-base)

Method: (setf windows) NEW-VALUE (TUI-BASE tui-base)

Windows in drawing order.

Source

uncursed.lisp (file)

5.1.4 Conditions

Condition: syscall-error ()

Package

uncursed-sys

Source

condition.lisp (file)

Direct superclasses

uncursed-error (condition)

Condition: uncursed-error ()

Package

uncursed-sys

Source

condition.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

• syscall-error (condition)
• window-bounds-error (condition)
• wide-char-overwrite-error (condition)

Condition: wide-char-overwrite-error ()

Signaled if an attempt is made to overwrite a wide character.

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

uncursed-error (condition)

Direct methods

• wide-char-overwrite-error-buffer (method)
• wide-char-overwrite-error-x (method)
• wide-char-overwrite-error-y (method)

Direct slots

Slot: y

Initargs

:y

Readers

wide-char-overwrite-error-y (generic function)

Slot: x

Initargs

:x

Readers

wide-char-overwrite-error-x (generic function)

Slot: buffer

Initargs

:buffer

Readers

wide-char-overwrite-error-buffer (generic function)

Condition: window-bounds-error ()

Signaled if an attempt is made to index outside a window’s bounds

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

uncursed-error (condition)

Direct methods

• window-bounds-error-window (method)
• window-bounds-error-bounds (method)
• window-bounds-error-coordinate (method)

Direct slots

Slot: coordinate

Initargs

:coordinate

Readers

window-bounds-error-coordinate (generic function)

Slot: bounds

Initargs

:bounds

Readers

window-bounds-error-bounds (generic function)

Slot: window

Initargs

:window

Readers

window-bounds-error-window (generic function)

5.1.5 Structures

Structure: rectangle ()

Package

uncursed-sys

Source

util.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: x

Type

fixnum

Initform

(error "rectangle x not provided")

Readers

rect-x (function)

Writers

(setf rect-x) (function)

Slot: y

Type

fixnum

Initform

(error "rectangle y not provided")

Readers

rect-y (function)

Writers

(setf rect-y) (function)

Slot: rows

Type

fixnum

Initform

(error "rectangle rows not provided")

Readers

rect-rows (function)

Writers

(setf rect-rows) (function)

Slot: cols

Type

fixnum

Initform

(error "rectangle cols not provided")

Readers

rect-cols (function)

Writers

(setf rect-cols) (function)

Structure: style ()

Package

uncursed-sys

Source

util.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: fg

Type

(or null (integer 0 16777215))

Readers

fg (function)

Writers

(setf fg) (function)

Slot: bg

Type

(or null (integer 0 16777215))

Readers

bg (function)

Writers

(setf bg) (function)

Slot: boldp

Type

boolean

Readers

boldp (function)

Writers

(setf boldp) (function)

Slot: italicp

Type

boolean

Readers

italicp (function)

Writers

(setf italicp) (function)

Slot: reversep

Type

boolean

Readers

reversep (function)

Writers

(setf reversep) (function)

Slot: underlinep

Type

boolean

Readers

underlinep (function)

Writers

(setf underlinep) (function)

5.1.6 Classes

Class: cell ()

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• (setf cell-style) (method)
• cell-string (method)
• cell-string (method)
• cell-style (method)

Direct slots

Slot: %style

Type

uncursed-sys:style

Initargs

:style

Initform

(uncursed-sys:copy-style uncursed-sys:*default-style*)

Readers

cell-style (generic function)

Slot: %string

Represents a grapheme cluster and its display style.
Note that setf-ing the style copies over the new attributes into the existing cell-style.

Type

simple-string

Initargs

:string

Initform

(string #\ )

Readers

cell-string (generic function)

Writers

(setf cell-string) (generic function)

Class: standard-window ()

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

window (class)

Direct methods

present (method)

Class: tui ()

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

tui-base (class)

Direct methods

• stop (method)
• run (method)
• unschedule-timer (method)
• schedule-timer (method)
• redisplay (method)
• redisplay (method)
• handle-resize (method)
• timers (method)
• timers (method)
• event-handler (method)
• event-handler (method)
• focused-window (method)
• focused-window (method)
• canvas (method)
• canvas (method)
• screen (method)
• screen (method)

Direct slots

Slot: %screen

The contents of the screen

Type

uncursed::buffer

Initargs

:screen

Readers

screen (generic function)

Writers

(setf screen) (generic function)

Slot: %canvas

The contents to be drawn to the screen

Type

uncursed::buffer

Initargs

:canvas

Readers

canvas (generic function)

Writers

(setf canvas) (generic function)

Slot: %focused-window

Type

uncursed:window

Initargs

:focused-window

Readers

focused-window (generic function)

Writers

(setf focused-window) (generic function)

Slot: %event-handler

Initargs

:event-handler

Initform

(error "must provide an event handler")

Readers

event-handler (generic function)

Writers

(setf event-handler) (generic function)

Slot: %timers

Initform

(list)

Readers

timers (generic function)

Writers

(setf timers) (generic function)

Class: tui-base ()

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

tui (class)

Direct methods

• run (method)
• handle-winch (method)
• got-winch (method)
• got-winch (method)
• got-winch (method)
• %termios (method)
• %termios (method)
• windows (method)
• windows (method)
• columns (method)
• columns (method)
• lines (method)
• lines (method)

Direct slots

Slot: %lines

Initargs

:lines

Readers

lines (generic function)

Writers

(setf lines) (generic function)

Slot: %columns

Initargs

:columns

Readers

columns (generic function)

Writers

(setf columns) (generic function)

Slot: %windows

Windows in drawing order.

Initargs

:windows

Initform

(list)

Readers

windows (generic function)

Writers

(setf windows) (generic function)

Slot: %termios

Readers

%termios (generic function)

Writers

(setf %termios) (generic function)

Slot: %got-winch

Readers

got-winch (generic function)

Writers

(setf got-winch) (generic function)

Class: window ()

Pure data.

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-window (class)

Direct methods

• win-focused-p (method)
• win-focused-p (method)
• dimensions (method)
• dimensions (method)

Direct slots

Slot: %dimensions

Type

uncursed-sys:rectangle

Initargs

:dimensions

Initform

(error "window dimensions not provided")

Readers

dimensions (generic function)

Writers

(setf dimensions) (generic function)

Slot: %focused-p

Readers

win-focused-p (generic function)

Writers

(setf win-focused-p) (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +sigwinch+

Signal number of SIGWINCH.

Package

uncursed-sys

Source

util.lisp (file)

Constant: c-echo

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-get-winsz

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-icanon

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-icrnl

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-iexten

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-igncr

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-inlcr

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-inpck

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-isig

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-istrip

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-ixoff

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-ixon

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-lc-ctype

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-max-size

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-opost

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-parenb

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-set-attributes-now

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: c-sigwinch

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: size-of-c-size

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: size-of-c-tcflag

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: size-of-c-termios

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: size-of-c-wchar

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Constant: size-of-c-winsize

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

5.2.2 Special variables

Special Variable: *fallback-terminal-dimensions*

Package

uncursed-sys

Source

util.lisp (file)

Special Variable: *got-sigwinch*

Package

uncursed-sys

Source

util.lisp (file)

Special Variable: *put-buffer*

Package

uncursed

Source

uncursed.lisp (file)

Special Variable: *put-window*

Package

uncursed

Source

uncursed.lisp (file)

5.2.3 Functions

Function: buffer-diff OLD NEW

Package

uncursed

Source

uncursed.lisp (file)

Function: cell/= CELL1 CELL2

Package

uncursed

Source

uncursed.lisp (file)

Function: dispatch-mouse-event WINDOW TUI EVENT

Package

uncursed

Source

uncursed.lisp (file)

Function: error-syscall-error CONTROL &rest ARGS

Package

uncursed-sys

Source

condition.lisp (file)

Function: rectangle-p OBJECT

Package

uncursed-sys

Source

util.lisp (file)

Function: style-p OBJECT

Package

uncursed-sys

Source

util.lisp (file)

Function: tcgetattr FD TERMIOS-P

Package

uncursed-sys

Source

util.lisp (file)

Function: tcsetattr FD OPTIONAL-ACTIONS TERMIOS-P

Package

uncursed-sys

Source

util.lisp (file)

Function: wide-cell-p CELL

Package

uncursed

Source

uncursed.lisp (file)

5.2.4 Generic functions

Generic Function: %termios OBJECT

Generic Function: (setf %termios) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: %termios (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf %termios) NEW-VALUE (TUI-BASE tui-base)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: canvas OBJECT

Generic Function: (setf canvas) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: canvas (TUI tui)

Method: (setf canvas) NEW-VALUE (TUI tui)

The contents to be drawn to the screen

Source

uncursed.lisp (file)

Generic Function: handle-winch TUI

Package

uncursed

Methods

Method: handle-winch (TUI tui-base) after

Source

uncursed.lisp (file)

Generic Function: screen OBJECT

Generic Function: (setf screen) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: screen (TUI tui)

Method: (setf screen) NEW-VALUE (TUI tui)

The contents of the screen

Source

uncursed.lisp (file)

Generic Function: timers OBJECT

Generic Function: (setf timers) NEW-VALUE OBJECT

Package

uncursed

Methods

Method: timers (TUI tui)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf timers) NEW-VALUE (TUI tui)

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: wide-char-overwrite-error-buffer CONDITION

Package

uncursed

Methods

Method: wide-char-overwrite-error-buffer (CONDITION wide-char-overwrite-error)

Source

uncursed.lisp (file)

Generic Function: wide-char-overwrite-error-x CONDITION

Package

uncursed

Methods

Method: wide-char-overwrite-error-x (CONDITION wide-char-overwrite-error)

Source

uncursed.lisp (file)

Generic Function: wide-char-overwrite-error-y CONDITION

Package

uncursed

Methods

Method: wide-char-overwrite-error-y (CONDITION wide-char-overwrite-error)

Source

uncursed.lisp (file)

5.2.5 Classes

Class: c-termios-tclass ()

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Direct superclasses

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

Class: c-winsize-tclass ()

Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file

Direct superclasses

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

Class: timer ()

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• timer-interval (method)
• timer-interval (method)
• timer-callback (method)
• timer-callback (method)

Direct slots

Slot: %callback

A function that is run when the timer expires. It is a function
of one argument, the TUI object it was scheduled with and is expected to return one value: either the next timer expiry interval or NIL, meaning to cancel the timer.

Initargs

:callback

Readers

timer-callback (generic function)

Writers

(setf timer-callback) (generic function)

Slot: %interval

Type

(real 0)

Initargs

:interval

Readers

timer-interval (generic function)

Writers

(setf timer-interval) (generic function)

5.2.6 Types

Type: buffer ()

Package

uncursed

Source

uncursed.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions