Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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.
• Introduction | What uncursed is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
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: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The uncursed system |
tianlin qu
BSD 3-Clause
Another TUI library, this time without curses.
0.2.0
cffi-grovel
uncursed.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The uncursed.asd file | ||
• The uncursed/package.lisp file | ||
• The uncursed/grovel.lisp file | ||
• The uncursed/condition.lisp file | ||
• The uncursed/util.lisp file | ||
• The uncursed/uncursed.lisp file |
Next: The uncursed/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
uncursed.asd
uncursed (system)
Next: The uncursed/grovel․lisp file, Previous: The uncursed․asd file, Up: Lisp files [Contents][Index]
uncursed (system)
package.lisp
Next: The uncursed/condition․lisp file, Previous: The uncursed/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
uncursed (system)
grovel.lisp
Next: The uncursed/util․lisp file, Previous: The uncursed/grovel․lisp file, Up: Lisp files [Contents][Index]
grovel.lisp (file)
uncursed (system)
condition.lisp
error-syscall-error (function)
Next: The uncursed/uncursed․lisp file, Previous: The uncursed/condition․lisp file, Up: Lisp files [Contents][Index]
condition.lisp (file)
uncursed (system)
util.lisp
Previous: The uncursed/util․lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
uncursed (system)
uncursed.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The uncursed-sys package | ||
• The uncursed package |
Next: The uncursed package, Previous: Packages, Up: Packages [Contents][Index]
package.lisp (file)
Previous: The uncursed-sys package, Up: Packages [Contents][Index]
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported structures | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
util.lisp (file)
util.lisp (file)
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
util.lisp (file)
util.lisp (file)
util.lisp (file)
Enables handling SIGWINCH. May fail silently.
util.lisp (file)
Returns the displayed width of CHARACTER
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
Good enough
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
uncursed.lisp (file)
util.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
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.
util.lisp (file)
util.lisp (file)
util.lisp (file)
NEW-VALUE is a (LINE . COLUMN) pair
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
Disables terminal echoing and buffering and enables mouse mode 1003. Returns a pointer to the original termios. Sets process locale to environment.
util.lisp (file)
util.lisp (file)
Returns a cons (LINES . COLUMNS) containing the dimensions of the terminal device backing FD. Returns NIL on failure.
util.lisp (file)
util.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Represents a grapheme cluster and its display style.
Note that setf-ing the style copies over the new attributes into the existing cell-style.
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
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.
uncursed.lisp (file)
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.
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
Windows in drawing order.
uncursed.lisp (file)
Next: Exported structures, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
condition.lisp (file)
uncursed-error (condition)
condition.lisp (file)
simple-error (condition)
Signaled if an attempt is made to overwrite a wide character.
uncursed.lisp (file)
uncursed-error (condition)
:y
wide-char-overwrite-error-y (generic function)
:x
wide-char-overwrite-error-x (generic function)
:buffer
wide-char-overwrite-error-buffer (generic function)
Signaled if an attempt is made to index outside a window’s bounds
uncursed.lisp (file)
uncursed-error (condition)
:coordinate
window-bounds-error-coordinate (generic function)
:bounds
window-bounds-error-bounds (generic function)
:window
window-bounds-error-window (generic function)
Next: Exported classes, Previous: Exported conditions, Up: Exported definitions [Contents][Index]
util.lisp (file)
structure-object (structure)
fixnum
(error "rectangle x not provided")
rect-x (function)
(setf rect-x) (function)
fixnum
(error "rectangle y not provided")
rect-y (function)
(setf rect-y) (function)
fixnum
(error "rectangle rows not provided")
rect-rows (function)
(setf rect-rows) (function)
fixnum
(error "rectangle cols not provided")
rect-cols (function)
(setf rect-cols) (function)
util.lisp (file)
structure-object (structure)
boolean
boldp (function)
(setf boldp) (function)
boolean
italicp (function)
(setf italicp) (function)
boolean
reversep (function)
(setf reversep) (function)
boolean
underlinep (function)
(setf underlinep) (function)
Previous: Exported structures, Up: Exported definitions [Contents][Index]
uncursed.lisp (file)
standard-object (class)
uncursed-sys:style
:style
(uncursed-sys:copy-style uncursed-sys:*default-style*)
cell-style (generic function)
Represents a grapheme cluster and its display style.
Note that setf-ing the style copies over the new attributes into the existing cell-style.
simple-string
:string
(string #\ )
cell-string (generic function)
(setf cell-string) (generic function)
uncursed.lisp (file)
window (class)
present (method)
uncursed.lisp (file)
tui-base (class)
The contents of the screen
uncursed::buffer
:screen
screen (generic function)
(setf screen) (generic function)
The contents to be drawn to the screen
uncursed::buffer
:canvas
canvas (generic function)
(setf canvas) (generic function)
uncursed:window
:focused-window
focused-window (generic function)
(setf focused-window) (generic function)
:event-handler
(error "must provide an event handler")
event-handler (generic function)
(setf event-handler) (generic function)
(list)
timers (generic function)
(setf timers) (generic function)
uncursed.lisp (file)
standard-object (class)
tui (class)
:lines
lines (generic function)
(setf lines) (generic function)
:columns
columns (generic function)
(setf columns) (generic function)
Windows in drawing order.
:windows
(list)
windows (generic function)
(setf windows) (generic function)
%termios (generic function)
(setf %termios) (generic function)
got-winch (generic function)
(setf got-winch) (generic function)
Pure data.
uncursed.lisp (file)
standard-object (class)
standard-window (class)
uncursed-sys:rectangle
:dimensions
(error "window dimensions not provided")
dimensions (generic function)
(setf dimensions) (generic function)
win-focused-p (generic function)
(setf win-focused-p) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes | ||
• Internal types |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Signal number of SIGWINCH.
util.lisp (file)
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
Next: Internal functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
util.lisp (file)
util.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
condition.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
util.lisp (file)
uncursed.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
The contents to be drawn to the screen
uncursed.lisp (file)
uncursed.lisp (file)
The contents of the screen
uncursed.lisp (file)
automatically generated reader method
uncursed.lisp (file)
automatically generated writer method
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
uncursed.lisp (file)
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/uncursed-20201220-git/grovel.processed-grovel-file
uncursed.lisp (file)
standard-object (class)
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.
:callback
timer-callback (generic function)
(setf timer-callback) (generic function)
(real 0)
:interval
timer-interval (generic function)
(setf timer-interval) (generic function)
Previous: Internal classes, Up: Internal definitions [Contents][Index]
uncursed.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L U |
---|
Jump to: | F L U |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
B C D E F G H I L M P R S T U W |
---|
Jump to: | %
(
B C D E F G H I L M P R S T U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | %
*
+
B C F I R S U W X Y |
---|
Jump to: | %
*
+
B C F I R S U W X Y |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | B C P R S T U W |
---|
Jump to: | B C P R S T U W |
---|