The uncursed Reference Manual

Table of Contents

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

The uncursed Reference Manual

This is the uncursed Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 18:11:14 2021 GMT+0.


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

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.


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

2 Systems

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


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

2.1 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
Source

uncursed.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 uncursed.asd

Location

uncursed.asd

Systems

uncursed (system)


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

3.1.2 uncursed/package.lisp

Parent

uncursed (system)

Location

package.lisp

Packages

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

3.1.3 uncursed/grovel.lisp

Dependency

package.lisp (file)

Parent

uncursed (system)

Location

grovel.lisp


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

3.1.4 uncursed/wrappers.lisp

Dependency

grovel.lisp (file)

Parent

uncursed (system)

Location

wrappers.lisp


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

3.1.5 uncursed/condition.lisp

Dependency

wrappers.lisp (file)

Parent

uncursed (system)

Location

condition.lisp

Exported Definitions

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

3.1.6 uncursed/hacks.lisp

Dependency

condition.lisp (file)

Parent

uncursed (system)

Location

hacks.lisp

Exported Definitions
Internal Definitions

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

3.1.7 uncursed/util.lisp

Dependency

hacks.lisp (file)

Parent

uncursed (system)

Location

util.lisp

Exported Definitions
Internal Definitions

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

3.1.8 uncursed/uncursed.lisp

Dependency

util.lisp (file)

Parent

uncursed (system)

Location

uncursed.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 uncursed-sys

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

4.2 uncursed

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *character-widths*
Package

uncursed-sys

Source

util.lisp (file)

Special Variable: *default-style*
Package

uncursed-sys

Source

util.lisp (file)


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

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

hacks.lisp (file)

Function: boldp INSTANCE
Function: (setf boldp) VALUE INSTANCE
Package

uncursed-sys

Source

util.lisp (file)

Function: catch-sigwinch WRITE-PIPE

Enables handling SIGWINCH. May fail silently.

Package

uncursed-sys

Source

util.lisp (file)

Function: character-width CHARACTER

Returns the displayed width of CHARACTER. It is recommended to bind *character-widths* dynamically in calling threads.

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-rect INSTANCE
Package

uncursed

Source

uncursed.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-focus-tracking ()
Package

uncursed-sys

Source

util.lisp (file)

Function: disable-mouse ()
Package

uncursed-sys

Source

util.lisp (file)

Function: display-width STRING
Package

uncursed-sys

Source

util.lisp (file)

Function: enable-alternate-screen ()
Package

uncursed-sys

Source

util.lisp (file)

Function: enable-focus-tracking ()
Package

uncursed-sys

Source

util.lisp (file)

Function: enable-mouse &key HOVER
Package

uncursed-sys

Source

util.lisp (file)

Function: error-syscall-error CONTROL &rest ARGS
Package

uncursed-sys

Source

condition.lisp (file)

Function: fg INSTANCE
Function: (setf fg) VALUE INSTANCE
Package

uncursed-sys

Source

util.lisp (file)

Function: green COLOR
Package

uncursed-sys

Source

hacks.lisp (file)

Function: italicp INSTANCE
Function: (setf italicp) VALUE INSTANCE
Package

uncursed-sys

Source

util.lisp (file)

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

uncursed

Source

uncursed.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 &key CONTEXT

Interval is given in seconds

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

Returns a value of one of the following forms:
* CHARACTER - singular character
* (CHARACTER [modifiers]...) - modifiers include :shift, :alt, :control and :meta
* :f1-20, :home, :end, :insert, :delete, :up/:down/:left/:right-arrow, :page-down, :page-up * (:function/special [modifiers]...) - above but with modifiers
* (:left/middle/right/wheel-up/down/left/right/hover :click/release/drag ROW COL [mods]...) * (:unknown [key-sequence]...)
Notably (:unknown :csi #I/O) may be xterm focus in/out events.

Package

uncursed-sys

Source

util.lisp (file)

Function: read-event-timeout &optional TIMEOUT

Wait up to timeout seconds waiting for input, returning NIL on timeout or an event.

Package

uncursed-sys

Source

util.lisp (file)

Function: rect-cols INSTANCE
Function: (setf rect-cols) VALUE INSTANCE
Package

uncursed

Source

uncursed.lisp (file)

Function: rect-rows INSTANCE
Function: (setf rect-rows) VALUE INSTANCE
Package

uncursed

Source

uncursed.lisp (file)

Function: rect-x INSTANCE
Function: (setf rect-x) VALUE INSTANCE
Package

uncursed

Source

uncursed.lisp (file)

Function: rect-y INSTANCE
Function: (setf rect-y) VALUE INSTANCE
Package

uncursed

Source

uncursed.lisp (file)

Function: red COLOR
Package

uncursed-sys

Source

hacks.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 &optional USE-PALETTE
Package

uncursed-sys

Source

util.lisp (file)

Function: set-style-from-old CURRENT-STYLE NEW-STYLE &optional USE-PALETTE
Package

uncursed-sys

Source

util.lisp (file)

Function: setup-terminal FD

Disables terminal echoing and buffering. Returns a pointer to the original termios. Sets process locale from 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)

Function: wakeup TUI

Wakes up TUI in a thread-safe manner.

Package

uncursed

Source

uncursed.lisp (file)


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

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: cols OBJECT
Generic Function: (setf cols) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: cols (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf cols) 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-p OBJECT
Generic Function: (setf focused-p) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: focused-p (WINDOW window)

automatically generated reader method

Source

uncursed.lisp (file)

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

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: handle-event TUI EV
Package

uncursed

Source

uncursed.lisp (file)

Generic Function: handle-key-event WINDOW TUI EVENT

Interface may change.

Package

uncursed

Source

uncursed.lisp (file)

Generic Function: handle-mouse-event WINDOW TUI BUTTON STATE LINE COL &key &allow-other-keys

Interface may change. Methods may optionally accept boolean keyword arguments :shift, :alt, :control and :meta.

Package

uncursed

Source

uncursed.lisp (file)

Generic Function: handle-resize TUI

Called when SIGWINCH is caught (the terminal window is resized).

Package

uncursed

Source

uncursed.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

Methods
Method: handle-resize (TUI tui) progn
Method: handle-resize (TUI tui-base) progn
Generic Function: initialize TUI
Package

uncursed

Methods
Method: initialize (TUI tui)
Source

uncursed.lisp (file)

Method: initialize (TUI tui) before
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) before
Generic Function: rows OBJECT
Generic Function: (setf rows) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: rows (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

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

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: run TUI &key REDISPLAY-ON-INPUT &allow-other-keys
Package

uncursed

Source

uncursed.lisp (file)

Methods
Method: run (TUI tui) &key REDISPLAY-ON-INPUT
Method: run (TUI tui-base) &key 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 two arguments, the TUI object and context it was scheduled with. The callback is expected to return one value: either the next timer expiry interval in seconds or NIL, meaning to cancel the timer. A second optional return value assigns a new timer context.

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: use-palette OBJECT
Generic Function: (setf use-palette) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: use-palette (TUI tui)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf use-palette) NEW-VALUE (TUI tui)

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 tui)
Method: (setf windows) NEW-VALUE (TUI tui)

Windows in drawing order.

Source

uncursed.lisp (file)


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

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


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

5.1.5 Structures

Structure: rect ()
Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: x
Type

fixnum

Initform

(error "rect x not provided")

Readers

rect-x (function)

Writers

(setf rect-x) (function)

Slot: y
Type

fixnum

Initform

(error "rect y not provided")

Readers

rect-y (function)

Writers

(setf rect-y) (function)

Slot: rows
Type

fixnum

Initform

(error "rect rows not provided")

Readers

rect-rows (function)

Writers

(setf rect-rows) (function)

Slot: cols
Type

fixnum

Initform

(error "rect 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 methods

make-load-form (method)

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)


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

5.1.6 Classes

Class: cell ()
Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
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
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: %windows

Windows in drawing order.

Initargs

:windows

Initform

(list)

Readers

windows (generic function)

Writers

(setf windows) (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)

Slot: %use-palette
Type

(member t nil :approximate)

Initargs

:use-palette

Readers

use-palette (generic function)

Writers

(setf use-palette) (generic function)

Class: tui-base ()
Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

tui (class)

Direct methods
Direct slots
Slot: %rows
Initargs

:rows

Readers

rows (generic function)

Writers

(setf rows) (generic function)

Slot: %cols
Initargs

:columns

Readers

cols (generic function)

Writers

(setf cols) (generic function)

Slot: %termios
Readers

%termios (generic function)

Writers

(setf %termios) (generic function)

Slot: %winch-pipe
Readers

%winch-pipe (generic function)

Writers

(setf %winch-pipe) (generic function)

Slot: %wakeup-pipe
Readers

%wakeup-pipe (generic function)

Writers

(setf %wakeup-pipe) (generic function)

Class: window ()

Pure data.

Package

uncursed

Source

uncursed.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-window (class)

Direct methods
  • print-object (method)
  • focused-p (method)
  • focused-p (method)
  • dimensions (method)
  • dimensions (method)
Direct slots
Slot: %dimensions
Type

uncursed:rect

Initargs

:dimensions

Initform

(error "window dimensions not provided")

Readers

dimensions (generic function)

Writers

(setf dimensions) (generic function)

Slot: %focused-p
Readers

focused-p (generic function)

Writers

(setf focused-p) (generic function)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +blank-style+
Package

uncursed-sys

Source

util.lisp (file)

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-20210228-git/grovel.processed-grovel-file

Constant: c-eintr
Package

uncursed-sys

Source

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

Constant: c-fsetfl
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-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-20210228-git/grovel.processed-grovel-file

Constant: c-ononblock
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-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-20210228-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-20210228-git/grovel.processed-grovel-file

Constant: c-set-attributes-flush
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-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-20210228-git/grovel.processed-grovel-file

Constant: size-of-c-fd-set
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-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-20210228-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-20210228-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-20210228-git/grovel.processed-grovel-file

Constant: size-of-c-time
Package

uncursed-sys

Source

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

Constant: size-of-c-timeval
Package

uncursed-sys

Source

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

Constant: size-of-c-usecs
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-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-20210228-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-20210228-git/grovel.processed-grovel-file


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

5.2.2 Special variables

Special Variable: *current-index*
Package

uncursed-sys

Source

hacks.lisp (file)

Special Variable: *fallback-terminal-dimensions*
Package

uncursed-sys

Source

util.lisp (file)

Special Variable: *palette*

Maps indexes 1-231 to their colors to save some sequences.
Yes we only actually use 16-231 as otherwise the user’s custom colors get clobbered.

Package

uncursed-sys

Source

hacks.lisp (file)

Special Variable: *put-buffer*
Package

uncursed

Source

uncursed.lisp (file)

Special Variable: *put-window*
Package

uncursed

Source

uncursed.lisp (file)

Special Variable: *xterm-256*
Package

uncursed-sys

Source

hacks.lisp (file)


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

5.2.3 Symbol macros

Symbol Macro: c-errno
Package

uncursed-sys

Source

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

Expansion

(cffi:mem-ref (uncursed-sys::%c-errno-accessor) (quote :int))


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

5.2.4 Functions

Function: %c-errno-accessor ()
Package

uncursed-sys

Source

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

Function: approximate-rgb RGB
Package

uncursed-sys

Source

hacks.lisp (file)

Function: buffer-diff OLD NEW
Package

uncursed

Source

uncursed.lisp (file)

Function: c-close FD
Package

uncursed-sys

Source

util.lisp (file)

Function: c-read FD BUF N
Package

uncursed-sys

Source

util.lisp (file)

Function: c-write FD BUF N
Package

uncursed-sys

Source

util.lisp (file)

Function: cell/= CELL1 CELL2
Package

uncursed

Source

uncursed.lisp (file)

Function: code->fkey CODE
Package

uncursed-sys

Source

util.lisp (file)

Function: color R G B
Package

uncursed-sys

Source

hacks.lisp (file)

Function: color-diff A B
Package

uncursed-sys

Source

hacks.lisp (file)

Function: color-magic C

very clever.

Package

uncursed-sys

Source

hacks.lisp (file)

Function: dispatch-event TUI EVENT
Package

uncursed

Source

uncursed.lisp (file)

Function: dispatch-mouse-event WINDOW TUI EVENT
Package

uncursed

Source

uncursed.lisp (file)

Function: fd-isset FD SET
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-git/wrappers.processed-wrapper-file

Function: fd-set FD SET
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-git/wrappers.processed-wrapper-file

Function: fd-setp FD SET
Package

uncursed-sys

Source

util.lisp (file)

Function: fd-zero SET
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-git/wrappers.processed-wrapper-file

Function: initialize-color-magic INDEX ATTR
Package

uncursed-sys

Source

util.lisp (file)

Function: lookup-color COLOR
Package

uncursed-sys

Source

hacks.lisp (file)

Function: modify-key KEY MOD
Package

uncursed-sys

Source

util.lisp (file)

Function: next-free-color ()
Package

uncursed-sys

Source

hacks.lisp (file)

Function: non-blocking-pipe PIPE
Package

uncursed-sys

Source

util.lisp (file)

Function: pipe PIPEFD
Package

uncursed-sys

Source

util.lisp (file)

Function: pipe-cleanup PIPE
Package

uncursed-sys

Source

util.lisp (file)

Function: process-timer TUI TIMER
Package

uncursed

Source

uncursed.lisp (file)

Function: read-fd PIPE
Package

uncursed-sys

Source

util.lisp (file)

Function: read-function-and-special-keys ()

CSI [code] ~/h (or modified, see above)

Package

uncursed-sys

Source

util.lisp (file)

Function: read-integer ()
Package

uncursed-sys

Source

util.lisp (file)

Function: read-modified-function-keys CODE

CSI [code] ; [mods] ~

Package

uncursed-sys

Source

util.lisp (file)

Function: read-modified-special-keys-and-f1-f4 CODE

CSI 1 ; [mods] [terminator]

Package

uncursed-sys

Source

util.lisp (file)

Function: read-mouse-sgr ()

CSI < [code&mods] ; COL ; ROW ; M/m

Package

uncursed-sys

Source

util.lisp (file)

Function: rect-p OBJECT
Package

uncursed

Source

uncursed.lisp (file)

Function: reset-colors ()
Package

uncursed-sys

Source

hacks.lisp (file)

Function: select NFDS READFDS WRITEFDS EXCEPTFDS TIMEOUT
Package

uncursed-sys

Source

util.lisp (file)

Function: set-nonblock FD
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)

Function: write-fd PIPE
Package

uncursed-sys

Source

util.lisp (file)

Function: write-seconds-to-timeval TIMEOUT TIMEVAL
Package

uncursed

Source

uncursed.lisp (file)


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

5.2.5 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: %wakeup-pipe OBJECT
Generic Function: (setf %wakeup-pipe) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: %wakeup-pipe (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

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

automatically generated writer method

Source

uncursed.lisp (file)

Generic Function: %winch-pipe OBJECT
Generic Function: (setf %winch-pipe) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: %winch-pipe (TUI-BASE tui-base)

automatically generated reader method

Source

uncursed.lisp (file)

Method: (setf %winch-pipe) 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: 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: timer-context OBJECT
Generic Function: (setf timer-context) NEW-VALUE OBJECT
Package

uncursed

Methods
Method: timer-context (TIMER timer)

automatically generated reader method

Source

uncursed.lisp (file)

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

automatically generated writer method

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)


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

5.2.6 Classes

Class: c-fd-set-tclass ()
Package

uncursed-sys

Source

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

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
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-20210228-git/grovel.processed-grovel-file

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: c-timeval-tclass ()
Package

uncursed-sys

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20210228-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-20210228-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
Direct slots
Slot: %callback

A function that is run when the timer expires. It is a
function of two arguments, the TUI object and context it was scheduled with. The callback is expected to return one value: either the next timer expiry interval in seconds or NIL, meaning to cancel the timer. A second optional return value assigns a new timer context.

Initargs

:callback

Readers

timer-callback (generic function)

Writers

(setf timer-callback) (generic function)

Slot: %context
Initargs

:context

Readers

timer-context (generic function)

Writers

(setf timer-context) (generic function)

Slot: %interval
Type

(real 0)

Initargs

:interval

Readers

timer-interval (generic function)

Writers

(setf timer-interval) (generic function)


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

5.2.7 Types

Type: buffer ()
Package

uncursed

Source

uncursed.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   U  
Index Entry  Section

F
File, Lisp, uncursed.asd: The uncursed․asd file
File, Lisp, uncursed/condition.lisp: The uncursed/condition․lisp file
File, Lisp, uncursed/grovel.lisp: The uncursed/grovel․lisp file
File, Lisp, uncursed/hacks.lisp: The uncursed/hacks․lisp file
File, Lisp, uncursed/package.lisp: The uncursed/package․lisp file
File, Lisp, uncursed/uncursed.lisp: The uncursed/uncursed․lisp file
File, Lisp, uncursed/util.lisp: The uncursed/util․lisp file
File, Lisp, uncursed/wrappers.lisp: The uncursed/wrappers․lisp file

L
Lisp File, uncursed.asd: The uncursed․asd file
Lisp File, uncursed/condition.lisp: The uncursed/condition․lisp file
Lisp File, uncursed/grovel.lisp: The uncursed/grovel․lisp file
Lisp File, uncursed/hacks.lisp: The uncursed/hacks․lisp file
Lisp File, uncursed/package.lisp: The uncursed/package․lisp file
Lisp File, uncursed/uncursed.lisp: The uncursed/uncursed․lisp file
Lisp File, uncursed/util.lisp: The uncursed/util․lisp file
Lisp File, uncursed/wrappers.lisp: The uncursed/wrappers․lisp file

U
uncursed.asd: The uncursed․asd file
uncursed/condition.lisp: The uncursed/condition․lisp file
uncursed/grovel.lisp: The uncursed/grovel․lisp file
uncursed/hacks.lisp: The uncursed/hacks․lisp file
uncursed/package.lisp: The uncursed/package․lisp file
uncursed/uncursed.lisp: The uncursed/uncursed․lisp file
uncursed/util.lisp: The uncursed/util․lisp file
uncursed/wrappers.lisp: The uncursed/wrappers․lisp file

Jump to:   F   L   U  

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

A.2 Functions

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

%
%c-errno-accessor: Internal functions
%termios: Internal generic functions
%termios: Internal generic functions
%wakeup-pipe: Internal generic functions
%wakeup-pipe: Internal generic functions
%winch-pipe: Internal generic functions
%winch-pipe: Internal generic functions

(
(setf %termios): Internal generic functions
(setf %termios): Internal generic functions
(setf %wakeup-pipe): Internal generic functions
(setf %wakeup-pipe): Internal generic functions
(setf %winch-pipe): Internal generic functions
(setf %winch-pipe): Internal generic functions
(setf bg): Exported functions
(setf boldp): Exported functions
(setf canvas): Internal generic functions
(setf canvas): Internal generic functions
(setf cell-string): Exported generic functions
(setf cell-string): Exported generic functions
(setf cell-style): Exported generic functions
(setf cell-style): Exported generic functions
(setf cols): Exported generic functions
(setf cols): Exported generic functions
(setf dimensions): Exported generic functions
(setf dimensions): Exported generic functions
(setf event-handler): Exported generic functions
(setf event-handler): Exported generic functions
(setf fg): Exported functions
(setf focused-p): Exported generic functions
(setf focused-p): Exported generic functions
(setf focused-window): Exported generic functions
(setf focused-window): Exported generic functions
(setf italicp): Exported functions
(setf rect-cols): Exported functions
(setf rect-rows): Exported functions
(setf rect-x): Exported functions
(setf rect-y): Exported functions
(setf reversep): Exported functions
(setf rows): Exported generic functions
(setf rows): Exported generic functions
(setf screen): Internal generic functions
(setf screen): Internal generic functions
(setf timer-callback): Exported generic functions
(setf timer-callback): Exported generic functions
(setf timer-context): Internal generic functions
(setf timer-context): Internal generic functions
(setf timer-interval): Exported generic functions
(setf timer-interval): Exported generic functions
(setf timers): Internal generic functions
(setf timers): Internal generic functions
(setf underlinep): Exported functions
(setf use-palette): Exported generic functions
(setf use-palette): Exported generic functions
(setf windows): Exported generic functions
(setf windows): Exported generic functions

A
approximate-rgb: Internal functions

B
bg: Exported functions
blue: Exported functions
boldp: Exported functions
buffer-diff: Internal functions

C
c-close: Internal functions
c-read: Internal functions
c-write: Internal functions
canvas: Internal generic functions
canvas: Internal generic functions
catch-sigwinch: Exported functions
cell-string: Exported generic functions
cell-string: Exported generic functions
cell-style: Exported generic functions
cell-style: Exported generic functions
cell/=: Internal functions
character-width: Exported functions
clear-chars: Exported functions
clear-screen: Exported functions
clear-to-end-of-line: Exported functions
code->fkey: Internal functions
color: Internal functions
color-diff: Internal functions
color-magic: Internal functions
cols: Exported generic functions
cols: Exported generic functions
copy-rect: Exported functions
copy-style: Exported functions

D
dimensions: Exported generic functions
dimensions: Exported generic functions
disable-alternate-screen: Exported functions
disable-focus-tracking: Exported functions
disable-mouse: Exported functions
dispatch-event: Internal functions
dispatch-mouse-event: Internal functions
display-width: Exported functions

E
enable-alternate-screen: Exported functions
enable-focus-tracking: Exported functions
enable-mouse: Exported functions
error-syscall-error: Exported functions
event-handler: Exported generic functions
event-handler: Exported generic functions

F
fd-isset: Internal functions
fd-set: Internal functions
fd-setp: Internal functions
fd-zero: Internal functions
fg: Exported functions
focused-p: Exported generic functions
focused-p: Exported generic functions
focused-window: Exported generic functions
focused-window: Exported generic functions
Function, %c-errno-accessor: Internal functions
Function, (setf bg): Exported functions
Function, (setf boldp): Exported functions
Function, (setf fg): Exported functions
Function, (setf italicp): Exported functions
Function, (setf rect-cols): Exported functions
Function, (setf rect-rows): Exported functions
Function, (setf rect-x): Exported functions
Function, (setf rect-y): Exported functions
Function, (setf reversep): Exported functions
Function, (setf underlinep): Exported functions
Function, approximate-rgb: Internal functions
Function, bg: Exported functions
Function, blue: Exported functions
Function, boldp: Exported functions
Function, buffer-diff: Internal functions
Function, c-close: Internal functions
Function, c-read: Internal functions
Function, c-write: Internal functions
Function, catch-sigwinch: Exported functions
Function, cell/=: Internal functions
Function, character-width: Exported functions
Function, clear-chars: Exported functions
Function, clear-screen: Exported functions
Function, clear-to-end-of-line: Exported functions
Function, code->fkey: Internal functions
Function, color: Internal functions
Function, color-diff: Internal functions
Function, color-magic: Internal functions
Function, copy-rect: Exported functions
Function, copy-style: Exported functions
Function, disable-alternate-screen: Exported functions
Function, disable-focus-tracking: Exported functions
Function, disable-mouse: Exported functions
Function, dispatch-event: Internal functions
Function, dispatch-mouse-event: Internal functions
Function, display-width: Exported functions
Function, enable-alternate-screen: Exported functions
Function, enable-focus-tracking: Exported functions
Function, enable-mouse: Exported functions
Function, error-syscall-error: Exported functions
Function, fd-isset: Internal functions
Function, fd-set: Internal functions
Function, fd-setp: Internal functions
Function, fd-zero: Internal functions
Function, fg: Exported functions
Function, green: Exported functions
Function, initialize-color-magic: Internal functions
Function, italicp: Exported functions
Function, lookup-color: Internal functions
Function, make-rect: Exported functions
Function, make-style: Exported functions
Function, make-timer: Exported functions
Function, modify-key: Internal functions
Function, mouse-event-p: Exported functions
Function, next-free-color: Internal functions
Function, non-blocking-pipe: Internal functions
Function, pipe: Internal functions
Function, pipe-cleanup: Internal functions
Function, process-timer: Internal functions
Function, put: Exported functions
Function, put-style: Exported functions
Function, puts: Exported functions
Function, read-event: Exported functions
Function, read-event-timeout: Exported functions
Function, read-fd: Internal functions
Function, read-function-and-special-keys: Internal functions
Function, read-integer: Internal functions
Function, read-modified-function-keys: Internal functions
Function, read-modified-special-keys-and-f1-f4: Internal functions
Function, read-mouse-sgr: Internal functions
Function, rect-cols: Exported functions
Function, rect-p: Internal functions
Function, rect-rows: Exported functions
Function, rect-x: Exported functions
Function, rect-y: Exported functions
Function, red: Exported functions
Function, reset-colors: Internal functions
Function, reset-sigwinch: Exported functions
Function, restore-terminal: Exported functions
Function, reversep: Exported functions
Function, select: Internal functions
Function, set-background: Exported functions
Function, set-cursor-position: Exported functions
Function, set-cursor-shape: Exported functions
Function, set-foreground: Exported functions
Function, set-nonblock: Internal functions
Function, set-style: Exported functions
Function, set-style-from-old: Exported functions
Function, setup-terminal: Exported functions
Function, style-difference: Exported functions
Function, style-p: Internal functions
Function, tcgetattr: Internal functions
Function, tcsetattr: Internal functions
Function, terminal-dimensions: Exported functions
Function, underlinep: Exported functions
Function, wakeup: Exported functions
Function, wide-cell-p: Internal functions
Function, write-fd: Internal functions
Function, write-seconds-to-timeval: Internal functions

G
Generic Function, %termios: Internal generic functions
Generic Function, %wakeup-pipe: Internal generic functions
Generic Function, %winch-pipe: Internal generic functions
Generic Function, (setf %termios): Internal generic functions
Generic Function, (setf %wakeup-pipe): Internal generic functions
Generic Function, (setf %winch-pipe): Internal generic functions
Generic Function, (setf canvas): Internal generic functions
Generic Function, (setf cell-string): Exported generic functions
Generic Function, (setf cell-style): Exported generic functions
Generic Function, (setf cols): Exported generic functions
Generic Function, (setf dimensions): Exported generic functions
Generic Function, (setf event-handler): Exported generic functions
Generic Function, (setf focused-p): Exported generic functions
Generic Function, (setf focused-window): Exported generic functions
Generic Function, (setf rows): Exported generic functions
Generic Function, (setf screen): Internal generic functions
Generic Function, (setf timer-callback): Exported generic functions
Generic Function, (setf timer-context): Internal generic functions
Generic Function, (setf timer-interval): Exported generic functions
Generic Function, (setf timers): Internal generic functions
Generic Function, (setf use-palette): Exported generic functions
Generic Function, (setf windows): Exported generic functions
Generic Function, canvas: Internal generic functions
Generic Function, cell-string: Exported generic functions
Generic Function, cell-style: Exported generic functions
Generic Function, cols: Exported generic functions
Generic Function, dimensions: Exported generic functions
Generic Function, event-handler: Exported generic functions
Generic Function, focused-p: Exported generic functions
Generic Function, focused-window: Exported generic functions
Generic Function, handle-event: Exported generic functions
Generic Function, handle-key-event: Exported generic functions
Generic Function, handle-mouse-event: Exported generic functions
Generic Function, handle-resize: Exported generic functions
Generic Function, initialize: Exported generic functions
Generic Function, present: Exported generic functions
Generic Function, redisplay: Exported generic functions
Generic Function, rows: Exported generic functions
Generic Function, run: Exported generic functions
Generic Function, schedule-timer: Exported generic functions
Generic Function, screen: Internal generic functions
Generic Function, stop: Exported generic functions
Generic Function, timer-callback: Exported generic functions
Generic Function, timer-context: Internal generic functions
Generic Function, timer-interval: Exported generic functions
Generic Function, timers: Internal generic functions
Generic Function, unschedule-timer: Exported generic functions
Generic Function, use-palette: Exported generic functions
Generic Function, wide-char-overwrite-error-buffer: Internal generic functions
Generic Function, wide-char-overwrite-error-x: Internal generic functions
Generic Function, wide-char-overwrite-error-y: Internal generic functions
Generic Function, window-bounds-error-bounds: Exported generic functions
Generic Function, window-bounds-error-coordinate: Exported generic functions
Generic Function, window-bounds-error-window: Exported generic functions
Generic Function, windows: Exported generic functions
green: Exported functions

H
handle-event: Exported generic functions
handle-key-event: Exported generic functions
handle-mouse-event: Exported generic functions
handle-resize: Exported generic functions
handle-resize: Exported generic functions
handle-resize: Exported generic functions

I
initialize: Exported generic functions
initialize: Exported generic functions
initialize: Exported generic functions
initialize-color-magic: Internal functions
italicp: Exported functions

L
lookup-color: Internal functions

M
make-rect: Exported functions
make-style: Exported functions
make-timer: Exported functions
Method, %termios: Internal generic functions
Method, %wakeup-pipe: Internal generic functions
Method, %winch-pipe: Internal generic functions
Method, (setf %termios): Internal generic functions
Method, (setf %wakeup-pipe): Internal generic functions
Method, (setf %winch-pipe): Internal generic functions
Method, (setf canvas): Internal generic functions
Method, (setf cell-string): Exported generic functions
Method, (setf cell-style): Exported generic functions
Method, (setf cols): Exported generic functions
Method, (setf dimensions): Exported generic functions
Method, (setf event-handler): Exported generic functions
Method, (setf focused-p): Exported generic functions
Method, (setf focused-window): Exported generic functions
Method, (setf rows): Exported generic functions
Method, (setf screen): Internal generic functions
Method, (setf timer-callback): Exported generic functions
Method, (setf timer-context): Internal generic functions
Method, (setf timer-interval): Exported generic functions
Method, (setf timers): Internal generic functions
Method, (setf use-palette): Exported generic functions
Method, (setf windows): Exported generic functions
Method, canvas: Internal generic functions
Method, cell-string: Exported generic functions
Method, cell-style: Exported generic functions
Method, cols: Exported generic functions
Method, dimensions: Exported generic functions
Method, event-handler: Exported generic functions
Method, focused-p: Exported generic functions
Method, focused-window: Exported generic functions
Method, handle-resize: Exported generic functions
Method, handle-resize: Exported generic functions
Method, initialize: Exported generic functions
Method, initialize: Exported generic functions
Method, present: Exported generic functions
Method, redisplay: Exported generic functions
Method, redisplay: Exported generic functions
Method, rows: Exported generic functions
Method, run: Exported generic functions
Method, run: Exported generic functions
Method, schedule-timer: Exported generic functions
Method, screen: Internal generic functions
Method, stop: Exported generic functions
Method, timer-callback: Exported generic functions
Method, timer-context: Internal generic functions
Method, timer-interval: Exported generic functions
Method, timers: Internal generic functions
Method, unschedule-timer: Exported generic functions
Method, use-palette: Exported generic functions
Method, wide-char-overwrite-error-buffer: Internal generic functions
Method, wide-char-overwrite-error-x: Internal generic functions
Method, wide-char-overwrite-error-y: Internal generic functions
Method, window-bounds-error-bounds: Exported generic functions
Method, window-bounds-error-coordinate: Exported generic functions
Method, window-bounds-error-window: Exported generic functions
Method, windows: Exported generic functions
modify-key: Internal functions
mouse-event-p: Exported functions

N
next-free-color: Internal functions
non-blocking-pipe: Internal functions

P
pipe: Internal functions
pipe-cleanup: Internal functions
present: Exported generic functions
present: Exported generic functions
process-timer: Internal functions
put: Exported functions
put-style: Exported functions
puts: Exported functions

R
read-event: Exported functions
read-event-timeout: Exported functions
read-fd: Internal functions
read-function-and-special-keys: Internal functions
read-integer: Internal functions
read-modified-function-keys: Internal functions
read-modified-special-keys-and-f1-f4: Internal functions
read-mouse-sgr: Internal functions
rect-cols: Exported functions
rect-p: Internal functions
rect-rows: Exported functions
rect-x: Exported functions
rect-y: Exported functions
red: Exported functions
redisplay: Exported generic functions
redisplay: Exported generic functions
redisplay: Exported generic functions
reset-colors: Internal functions
reset-sigwinch: Exported functions
restore-terminal: Exported functions
reversep: Exported functions
rows: Exported generic functions
rows: Exported generic functions
run: Exported generic functions
run: Exported generic functions
run: Exported generic functions

S
schedule-timer: Exported generic functions
schedule-timer: Exported generic functions
screen: Internal generic functions
screen: Internal generic functions
select: Internal functions
set-background: Exported functions
set-cursor-position: Exported functions
set-cursor-shape: Exported functions
set-foreground: Exported functions
set-nonblock: Internal functions
set-style: Exported functions
set-style-from-old: Exported functions
setup-terminal: Exported functions
stop: Exported generic functions
stop: Exported generic functions
style-difference: Exported functions
style-p: Internal functions

T
tcgetattr: Internal functions
tcsetattr: Internal functions
terminal-dimensions: Exported functions
timer-callback: Exported generic functions
timer-callback: Exported generic functions
timer-context: Internal generic functions
timer-context: Internal generic functions
timer-interval: Exported generic functions
timer-interval: Exported generic functions
timers: Internal generic functions
timers: Internal generic functions

U
underlinep: Exported functions
unschedule-timer: Exported generic functions
unschedule-timer: Exported generic functions
use-palette: Exported generic functions
use-palette: Exported generic functions

W
wakeup: Exported functions
wide-cell-p: Internal functions
wide-char-overwrite-error-buffer: Internal generic functions
wide-char-overwrite-error-buffer: Internal generic functions
wide-char-overwrite-error-x: Internal generic functions
wide-char-overwrite-error-x: Internal generic functions
wide-char-overwrite-error-y: Internal generic functions
wide-char-overwrite-error-y: Internal generic functions
window-bounds-error-bounds: Exported generic functions
window-bounds-error-bounds: Exported generic functions
window-bounds-error-coordinate: Exported generic functions
window-bounds-error-coordinate: Exported generic functions
window-bounds-error-window: Exported generic functions
window-bounds-error-window: Exported generic functions
windows: Exported generic functions
windows: Exported generic functions
write-fd: Internal functions
write-seconds-to-timeval: Internal functions

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

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

A.3 Variables

Jump to:   %   *   +  
B   C   F   I   R   S   U   W   X   Y  
Index Entry  Section

%
%callback: Internal classes
%canvas: Exported classes
%cols: Exported classes
%context: Internal classes
%dimensions: Exported classes
%event-handler: Exported classes
%focused-p: Exported classes
%focused-window: Exported classes
%interval: Internal classes
%rows: Exported classes
%screen: Exported classes
%string: Exported classes
%style: Exported classes
%termios: Exported classes
%timers: Exported classes
%use-palette: Exported classes
%wakeup-pipe: Exported classes
%winch-pipe: Exported classes
%windows: Exported classes

*
*character-widths*: Exported special variables
*current-index*: Internal special variables
*default-style*: Exported special variables
*fallback-terminal-dimensions*: Internal special variables
*palette*: Internal special variables
*put-buffer*: Internal special variables
*put-window*: Internal special variables
*xterm-256*: Internal special variables

+
+blank-style+: Internal constants
+sigwinch+: Internal constants

B
bg: Exported structures
boldp: Exported structures
bounds: Exported conditions
buffer: Exported conditions

C
c-echo: Internal constants
c-eintr: Internal constants
c-errno: Internal symbol macros
c-fsetfl: Internal constants
c-get-winsz: Internal constants
c-icanon: Internal constants
c-icrnl: Internal constants
c-iexten: Internal constants
c-igncr: Internal constants
c-inlcr: Internal constants
c-inpck: Internal constants
c-isig: Internal constants
c-istrip: Internal constants
c-ixoff: Internal constants
c-ixon: Internal constants
c-max-size: Internal constants
c-ononblock: Internal constants
c-opost: Internal constants
c-parenb: Internal constants
c-set-attributes-flush: Internal constants
c-sigwinch: Internal constants
cols: Exported structures
Constant, +blank-style+: Internal constants
Constant, +sigwinch+: Internal constants
Constant, c-echo: Internal constants
Constant, c-eintr: Internal constants
Constant, c-fsetfl: Internal constants
Constant, c-get-winsz: Internal constants
Constant, c-icanon: Internal constants
Constant, c-icrnl: Internal constants
Constant, c-iexten: Internal constants
Constant, c-igncr: Internal constants
Constant, c-inlcr: Internal constants
Constant, c-inpck: Internal constants
Constant, c-isig: Internal constants
Constant, c-istrip: Internal constants
Constant, c-ixoff: Internal constants
Constant, c-ixon: Internal constants
Constant, c-max-size: Internal constants
Constant, c-ononblock: Internal constants
Constant, c-opost: Internal constants
Constant, c-parenb: Internal constants
Constant, c-set-attributes-flush: Internal constants
Constant, c-sigwinch: Internal constants
Constant, size-of-c-fd-set: Internal constants
Constant, size-of-c-size: Internal constants
Constant, size-of-c-tcflag: Internal constants
Constant, size-of-c-termios: Internal constants
Constant, size-of-c-time: Internal constants
Constant, size-of-c-timeval: Internal constants
Constant, size-of-c-usecs: Internal constants
Constant, size-of-c-wchar: Internal constants
Constant, size-of-c-winsize: Internal constants
coordinate: Exported conditions

F
fg: Exported structures

I
italicp: Exported structures

R
reversep: Exported structures
rows: Exported structures

S
size-of-c-fd-set: Internal constants
size-of-c-size: Internal constants
size-of-c-tcflag: Internal constants
size-of-c-termios: Internal constants
size-of-c-time: Internal constants
size-of-c-timeval: Internal constants
size-of-c-usecs: Internal constants
size-of-c-wchar: Internal constants
size-of-c-winsize: Internal constants
Slot, %callback: Internal classes
Slot, %canvas: Exported classes
Slot, %cols: Exported classes
Slot, %context: Internal classes
Slot, %dimensions: Exported classes
Slot, %event-handler: Exported classes
Slot, %focused-p: Exported classes
Slot, %focused-window: Exported classes
Slot, %interval: Internal classes
Slot, %rows: Exported classes
Slot, %screen: Exported classes
Slot, %string: Exported classes
Slot, %style: Exported classes
Slot, %termios: Exported classes
Slot, %timers: Exported classes
Slot, %use-palette: Exported classes
Slot, %wakeup-pipe: Exported classes
Slot, %winch-pipe: Exported classes
Slot, %windows: Exported classes
Slot, bg: Exported structures
Slot, boldp: Exported structures
Slot, bounds: Exported conditions
Slot, buffer: Exported conditions
Slot, cols: Exported structures
Slot, coordinate: Exported conditions
Slot, fg: Exported structures
Slot, italicp: Exported structures
Slot, reversep: Exported structures
Slot, rows: Exported structures
Slot, underlinep: Exported structures
Slot, window: Exported conditions
Slot, x: Exported conditions
Slot, x: Exported structures
Slot, y: Exported conditions
Slot, y: Exported structures
Special Variable, *character-widths*: Exported special variables
Special Variable, *current-index*: Internal special variables
Special Variable, *default-style*: Exported special variables
Special Variable, *fallback-terminal-dimensions*: Internal special variables
Special Variable, *palette*: Internal special variables
Special Variable, *put-buffer*: Internal special variables
Special Variable, *put-window*: Internal special variables
Special Variable, *xterm-256*: Internal special variables
Symbol Macro, c-errno: Internal symbol macros

U
underlinep: Exported structures

W
window: Exported conditions

X
x: Exported conditions
x: Exported structures

Y
y: Exported conditions
y: Exported structures

Jump to:   %   *   +  
B   C   F   I   R   S   U   W   X   Y  

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

A.4 Data types

Jump to:   B   C   P   R   S   T   U   W  
Index Entry  Section

B
buffer: Internal types

C
c-fd-set-tclass: Internal classes
c-termios-tclass: Internal classes
c-timeval-tclass: Internal classes
c-winsize-tclass: Internal classes
cell: Exported classes
Class, c-fd-set-tclass: Internal classes
Class, c-termios-tclass: Internal classes
Class, c-timeval-tclass: Internal classes
Class, c-winsize-tclass: Internal classes
Class, cell: Exported classes
Class, standard-window: Exported classes
Class, timer: Internal classes
Class, tui: Exported classes
Class, tui-base: Exported classes
Class, window: Exported classes
Condition, syscall-error: Exported conditions
Condition, uncursed-error: Exported conditions
Condition, wide-char-overwrite-error: Exported conditions
Condition, window-bounds-error: Exported conditions

P
Package, uncursed: The uncursed package
Package, uncursed-sys: The uncursed-sys package

R
rect: Exported structures

S
standard-window: Exported classes
Structure, rect: Exported structures
Structure, style: Exported structures
style: Exported structures
syscall-error: Exported conditions
System, uncursed: The uncursed system

T
timer: Internal classes
tui: Exported classes
tui-base: Exported classes
Type, buffer: Internal types

U
uncursed: The uncursed system
uncursed: The uncursed package
uncursed-error: Exported conditions
uncursed-sys: The uncursed-sys package

W
wide-char-overwrite-error: Exported conditions
window: Exported classes
window-bounds-error: Exported conditions

Jump to:   B   C   P   R   S   T   U   W