This is the cl-charms Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 03:52:19 2025 GMT+0.
cl-charms/cl-charms.asdcl-charms/features.lispcl-charms/low-level/package.lispcl-charms/low-level/curses-grovel.lispcl-charms/low-level/curses-bindings.lispcl-charms/low-level/mouse.lispcl-charms/high-level/package.lispcl-charms/high-level/utilities.lispcl-charms/high-level/windows.lispcl-charms/high-level/cursor.lispcl-charms/high-level/output.lispcl-charms/high-level/input.lispcl-charms/high-level/initialization.lispcl-charms/high-level/miscellaneous.lispThe main system appears first, followed by any subsystem dependency.
cl-charmsCFFI bindings for curses.
Mark Fedurin <hitecnologys@gmail.com>
Abhishek Reddy <abhishek@abhishek.geek.nz>
MIT License (See COPYING)
0.2.0
cffi-grovel (system).
cffi (system).
alexandria (system).
features.lisp (file).
low-level (module).
high-level (module).
Modules are listed depth-first from the system components tree.
cl-charms/low-levelfeatures.lisp (file).
cl-charms (system).
package.lisp (file).
curses-grovel.lisp (file).
curses-bindings.lisp (file).
mouse.lisp (file).
cl-charms/high-levellow-level (module).
cl-charms (system).
package.lisp (file).
utilities.lisp (file).
windows.lisp (file).
cursor.lisp (file).
output.lisp (file).
input.lisp (file).
initialization.lisp (file).
miscellaneous.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-charms/cl-charms.asdcl-charms/features.lispcl-charms/low-level/package.lispcl-charms/low-level/curses-grovel.lispcl-charms/low-level/curses-bindings.lispcl-charms/low-level/mouse.lispcl-charms/high-level/package.lispcl-charms/high-level/utilities.lispcl-charms/high-level/windows.lispcl-charms/high-level/cursor.lispcl-charms/high-level/output.lispcl-charms/high-level/input.lispcl-charms/high-level/initialization.lispcl-charms/high-level/miscellaneous.lispcl-charms/low-level/curses-grovel.lisppackage.lisp (file).
low-level (module).
cl-charms/low-level/curses-bindings.lispcurses-grovel.lisp (file).
low-level (module).
*color-pairs* (symbol macro).
*colors* (symbol macro).
*cols* (symbol macro).
*curscr* (symbol macro).
*escdelay* (symbol macro).
*lines* (symbol macro).
*newscr* (symbol macro).
*stdscr* (symbol macro).
*tabsize* (symbol macro).
a_altcharset (constant).
a_attributes (constant).
a_blink (constant).
a_bold (constant).
a_dim (constant).
a_horizontal (constant).
a_invis (constant).
a_left (constant).
a_low (constant).
a_normal (constant).
a_protect (constant).
a_reverse (constant).
a_right (constant).
a_standout (constant).
a_top (constant).
a_underline (constant).
a_vertical (constant).
acs_btee (constant).
acs_bullet (constant).
acs_ckboard (constant).
acs_degree (constant).
acs_diamond (constant).
acs_hline (constant).
acs_llcorner (constant).
acs_lrcorner (constant).
acs_ltee (constant).
acs_plminus (constant).
acs_plus (constant).
acs_rtee (constant).
acs_s1 (constant).
acs_s9 (constant).
acs_ttee (constant).
acs_ulcorner (constant).
acs_urcorner (constant).
acs_vline (constant).
addch (function).
addchnstr (function).
addchstr (function).
addnstr (function).
addstr (function).
assume-default-colors (function).
attr-get (function).
attr-off (function).
attr-on (function).
attr-set (function).
attroff (function).
attron (function).
attrset (function).
baudrate (function).
beep (function).
bkgd (function).
bkgdset (function).
border (function).
box (function).
can-change-color (function).
cbreak (function).
chgat (function).
clear (function).
clearok (function).
clrtobot (function).
clrtoeol (function).
color-content (function).
color-pair (function).
color-set (function).
color_black (constant).
color_blue (constant).
color_cyan (constant).
color_green (constant).
color_magenta (constant).
color_red (constant).
color_white (constant).
color_yellow (constant).
curs-set (function).
curses-version (function).
def-prog-mode (function).
def-shell-mode (function).
delay-output (function).
delch (function).
deleteln (function).
delscreen (function).
delwin (function).
derwin (function).
doupdate (function).
dupwin (function).
echo (function).
echochar (function).
endwin (function).
erase (function).
erasechar (function).
err (constant).
false (constant).
filter (function).
flash (function).
flushinp (function).
get-begyx (function).
get-maxyx (function).
get-paryx (function).
get-wch (function).
get-yx (function).
getbegx (function).
getbegy (function).
getbegyx (macro).
getbkgd (function).
getch (function).
getcurx (function).
getcury (function).
getmaxx (function).
getmaxy (function).
getmaxyx (macro).
getnstr (function).
getparx (function).
getpary (function).
getparyx (macro).
getstr (function).
getyx (macro).
halfdelay (function).
has-colors (function).
has-ic (function).
has-il (function).
has-key (function).
hline (function).
idcok (function).
idlok (function).
immedok (function).
inch (function).
inchnstr (function).
inchstr (function).
init-color (function).
init-pair (function).
initscr (function).
innstr (function).
insch (function).
insdelln (function).
insertln (function).
insnstr (function).
insstr (function).
instr (function).
intrflush (function).
is-linetouched (function).
is-term-resized (function).
is-wintouched (function).
isendwin (function).
key_a1 (constant).
key_a3 (constant).
key_b2 (constant).
key_backspace (constant).
key_beg (constant).
key_break (constant).
key_btab (constant).
key_c1 (constant).
key_c3 (constant).
key_cancel (constant).
key_catab (constant).
key_clear (constant).
key_close (constant).
key_command (constant).
key_copy (constant).
key_create (constant).
key_ctab (constant).
key_dc (constant).
key_dl (constant).
key_down (constant).
key_eic (constant).
key_end (constant).
key_enter (constant).
key_eol (constant).
key_eos (constant).
key_event (constant).
key_exit (constant).
key_f0 (constant).
key_find (constant).
key_fn (function).
key_help (constant).
key_home (constant).
key_ic (constant).
key_il (constant).
key_left (constant).
key_ll (constant).
key_mark (constant).
key_message (constant).
key_mouse (constant).
key_move (constant).
key_next (constant).
key_npage (constant).
key_open (constant).
key_options (constant).
key_ppage (constant).
key_previous (constant).
key_print (constant).
key_redo (constant).
key_reference (constant).
key_refresh (constant).
key_replace (constant).
key_reset (constant).
key_resize (constant).
key_restart (constant).
key_resume (constant).
key_right (constant).
key_save (constant).
key_sbeg (constant).
key_scancel (constant).
key_scommand (constant).
key_scopy (constant).
key_screate (constant).
key_sdc (constant).
key_sdl (constant).
key_select (constant).
key_send (constant).
key_seol (constant).
key_sexit (constant).
key_sf (constant).
key_sfind (constant).
key_shelp (constant).
key_shome (constant).
key_sic (constant).
key_sleft (constant).
key_smessage (constant).
key_smove (constant).
key_snext (constant).
key_soptions (constant).
key_sprevious (constant).
key_sprint (constant).
key_sr (constant).
key_sredo (constant).
key_sreplace (constant).
key_sreset (constant).
key_sright (constant).
key_srsume (constant).
key_ssave (constant).
key_ssuspend (constant).
key_stab (constant).
key_sundo (constant).
key_suspend (constant).
key_undo (constant).
key_up (constant).
keybound (function).
keyname (function).
keyok (function).
keypad (function).
killchar (function).
leaveok (function).
longname (function).
mcprint (function).
meta (function).
move (function).
mvaddch (function).
mvaddchnstr (function).
mvaddchstr (function).
mvaddnstr (function).
mvaddstr (function).
mvchgat (function).
mvdelch (function).
mvderwin (function).
mvget-wch (function).
mvgetch (function).
mvgetnstr (function).
mvgetstr (function).
mvhline (function).
mvinch (function).
mvinchnstr (function).
mvinchstr (function).
mvinnstr (function).
mvinsch (function).
mvinsnstr (function).
mvinsstr (function).
mvinstr (function).
mvprintw (macro).
mvvline (function).
mvwaddch (function).
mvwaddchnstr (function).
mvwaddchstr (function).
mvwaddnstr (function).
mvwaddstr (function).
mvwchgat (function).
mvwdelch (function).
mvwget-wch (function).
mvwgetch (function).
mvwgetnstr (function).
mvwgetstr (function).
mvwhline (function).
mvwin (function).
mvwinch (function).
mvwinchnstr (function).
mvwinchstr (function).
mvwinsch (function).
mvwinsnstr (function).
mvwinsstr (function).
mvwprintw (macro).
mvwvline (function).
napms (function).
newpad (function).
newterm (function).
newwin (function).
nl (function).
nocbreak (function).
nodelay (function).
noecho (function).
nonl (function).
noqiflush (function).
noraw (function).
notimeout (function).
ok (constant).
overlay (function).
overwrite (function).
pair-content (function).
pechochar (function).
pnoutrefresh (function).
prefresh (function).
printw (macro).
qiflush (function).
raw (function).
redrawwin (function).
refresh (function).
reset-prog-mode (function).
reset-shell-mode (function).
resetty (function).
resize-term (function).
resizeterm (function).
savetty (function).
scr-dump (function).
scr-init (function).
scr-restore (function).
scr-set (function).
scrl (function).
scroll (function).
scrollok (function).
set-term (function).
setscrreg (function).
slk-attroff (function).
slk-attron (function).
slk-attrset (function).
slk-clear (function).
slk-color (function).
slk-init (function).
slk-label (function).
slk-noutrefresh (function).
slk-refresh (function).
slk-restore (function).
slk-set (function).
slk-touch (function).
standend (function).
standout (function).
start-color (function).
subpad (function).
subwin (function).
syncok (function).
termattrs (function).
termname (function).
tgetflag (function).
tgetnum (function).
timeout (function).
touchline (function).
touchwin (function).
true (constant).
typeahead (function).
unctrl (function).
unget-wch (function).
ungetch (function).
untouchwin (function).
use-default-colors (function).
use-env (function).
use-extended-names (function).
vline (function).
wa_altcharset (constant).
wa_attributes (constant).
wa_blink (constant).
wa_bold (constant).
wa_dim (constant).
wa_horizontal (constant).
wa_invis (constant).
wa_left (constant).
wa_low (constant).
wa_normal (constant).
wa_protect (constant).
wa_reverse (constant).
wa_right (constant).
wa_standout (constant).
wa_top (constant).
wa_underline (constant).
wa_vertical (constant).
waddch (function).
waddchnstr (function).
waddchstr (function).
waddnstr (function).
waddstr (function).
wattr-get (function).
wattr-off (function).
wattr-on (function).
wattr-set (function).
wattroff (function).
wattron (function).
wattrset (function).
wbkgd (function).
wbkgdset (function).
wborder (function).
wchgat (function).
wclear (function).
wclrtobot (function).
wclrtoeol (function).
wcolor-set (function).
wcursyncup (function).
wdelch (function).
wdeleteln (function).
wechochar (function).
werase (function).
wget-wch (function).
wgetch (function).
wgetnstr (function).
wgetstr (function).
whline (function).
winch (function).
winchnstr (function).
winchstr (function).
winnstr (function).
winsch (function).
winsdelln (function).
winsertln (function).
winsnstr (function).
winsstr (function).
winstr (function).
wmove (function).
wnoutrefresh (function).
wprintw (macro).
wredrawln (function).
wrefresh (function).
wresize (function).
wscrl (function).
wsetscrreg (function).
wstandend (function).
wstandout (function).
wsyncdown (function).
wsyncup (function).
wtimeout (function).
wtouchln (function).
wvline (function).
%var-accessor-*color-pairs* (function).
(setf %var-accessor-*color-pairs*) (function).
%var-accessor-*color-paths* (function).
(setf %var-accessor-*color-paths*) (function).
%var-accessor-*colors* (function).
(setf %var-accessor-*colors*) (function).
%var-accessor-*cols* (function).
(setf %var-accessor-*cols*) (function).
%var-accessor-*curscr* (function).
(setf %var-accessor-*curscr*) (function).
%var-accessor-*escdelay* (function).
(setf %var-accessor-*escdelay*) (function).
%var-accessor-*lines* (function).
(setf %var-accessor-*lines*) (function).
%var-accessor-*newscr* (function).
(setf %var-accessor-*newscr*) (function).
%var-accessor-*stdscr* (function).
(setf %var-accessor-*stdscr*) (function).
%var-accessor-*tabsize* (function).
(setf %var-accessor-*tabsize*) (function).
*color-paths* (symbol macro).
c-get-wch (function).
c-mvget-wch (function).
c-mvwget-wch (function).
c-wget-wch (function).
define-exported-cfuns (macro).
define-exported-constant (macro).
generate-getyx-macro (macro).
generate-getyx-macros (macro).
cl-charms/low-level/mouse.lispcurses-bindings.lisp (file).
low-level (module).
all_mouse_events (constant).
button1_clicked (constant).
button1_double_clicked (constant).
button1_pressed (constant).
button1_released (constant).
button1_triple_clicked (constant).
button2_clicked (constant).
button2_double_clicked (constant).
button2_pressed (constant).
button2_released (constant).
button2_triple_clicked (constant).
button3_clicked (constant).
button3_double_clicked (constant).
button3_pressed (constant).
button3_released (constant).
button3_triple_clicked (constant).
button_alt (constant).
button_ctrl (constant).
button_shift (constant).
getmouse (function).
has-mouse (function).
mouse-trafo (function).
mouse-wtrafo (function).
mouseinterval (function).
mousemask (function).
report_mouse_position (constant).
wenclose (function).
%getmouse (function).
%mousemask (function).
%ungetmouse (function).
mevent-tclass (class).
cl-charms/high-level/utilities.lisppackage.lisp (file).
high-level (module).
%check-status (function).
c-char-to-character (function).
character-to-c-char (function).
check-status (macro).
from-foreign-boolean (function).
resolve-window (function).
to-foreign-boolean (function).
cl-charms/high-level/windows.lisputilities.lisp (file).
high-level (module).
*standard-window* (special variable).
char-at-cursor (function).
char-at-point (function).
clear-line-after-cursor (function).
clear-window (function).
clear-window-after-cursor (function).
copy-window (function).
destroy-window (function).
force-repaint (function).
make-window (function).
refresh-window (function).
standard-window (function).
window (class).
window-dimensions (function).
window-pointer (reader method).
(setf window-pointer) (writer method).
cl-charms/high-level/cursor.lispwindows.lisp (file).
high-level (module).
cursor-position (function).
move-cursor (function).
move-cursor-down (function).
move-cursor-left (function).
move-cursor-right (function).
move-cursor-up (function).
with-restored-cursor (macro).
cl-charms/high-level/output.lispcursor.lisp (file).
high-level (module).
insert-char-at-cursor (function).
insert-char-at-point (function).
write-char-at-cursor (function).
write-char-at-point (function).
write-string-at-cursor (function).
write-string-at-point (function).
last-position-p (function).
write-char-at-last-position (function).
cl-charms/high-level/input.lispoutput.lisp (file).
high-level (module).
get-char (function).
cl-charms/high-level/initialization.lispinput.lisp (file).
high-level (module).
disable-echoing (function).
disable-extra-keys (function).
disable-non-blocking-mode (function).
disable-raw-input (function).
enable-echoing (function).
enable-extra-keys (function).
enable-non-blocking-mode (function).
enable-raw-input (function).
finalize (function).
initialize (function).
with-curses (macro).
*input-mode* (special variable).
cl-charms/high-level/miscellaneous.lispinitialization.lisp (file).
high-level (module).
beep-console (function).
curses-version (function).
flash-console (function).
Packages are listed by definition order.
cl-charms/low-levelPackage containing the one-to-one bindings to the ncurses library.
charms/ll
common-lisp.
*color-pairs* (symbol macro).
*colors* (symbol macro).
*cols* (symbol macro).
*curscr* (symbol macro).
*escdelay* (symbol macro).
*lines* (symbol macro).
*newscr* (symbol macro).
*stdscr* (symbol macro).
*tabsize* (symbol macro).
a_altcharset (constant).
a_attributes (constant).
a_blink (constant).
a_bold (constant).
a_dim (constant).
a_horizontal (constant).
a_invis (constant).
a_left (constant).
a_low (constant).
a_normal (constant).
a_protect (constant).
a_reverse (constant).
a_right (constant).
a_standout (constant).
a_top (constant).
a_underline (constant).
a_vertical (constant).
acs_btee (constant).
acs_bullet (constant).
acs_ckboard (constant).
acs_degree (constant).
acs_diamond (constant).
acs_hline (constant).
acs_llcorner (constant).
acs_lrcorner (constant).
acs_ltee (constant).
acs_plminus (constant).
acs_plus (constant).
acs_rtee (constant).
acs_s1 (constant).
acs_s9 (constant).
acs_ttee (constant).
acs_ulcorner (constant).
acs_urcorner (constant).
acs_vline (constant).
addch (function).
addchnstr (function).
addchstr (function).
addnstr (function).
addstr (function).
all_mouse_events (constant).
assume-default-colors (function).
attr-get (function).
attr-off (function).
attr-on (function).
attr-set (function).
attroff (function).
attron (function).
attrset (function).
baudrate (function).
beep (function).
bkgd (function).
bkgdset (function).
border (function).
box (function).
button1_clicked (constant).
button1_double_clicked (constant).
button1_pressed (constant).
button1_released (constant).
button1_triple_clicked (constant).
button2_clicked (constant).
button2_double_clicked (constant).
button2_pressed (constant).
button2_released (constant).
button2_triple_clicked (constant).
button3_clicked (constant).
button3_double_clicked (constant).
button3_pressed (constant).
button3_released (constant).
button3_triple_clicked (constant).
button_alt (constant).
button_ctrl (constant).
button_shift (constant).
can-change-color (function).
cbreak (function).
chgat (function).
clear (function).
clearok (function).
clrtobot (function).
clrtoeol (function).
color-content (function).
color-pair (function).
color-set (function).
color_black (constant).
color_blue (constant).
color_cyan (constant).
color_green (constant).
color_magenta (constant).
color_red (constant).
color_white (constant).
color_yellow (constant).
curs-set (function).
curses-version (function).
def-prog-mode (function).
def-shell-mode (function).
delay-output (function).
delch (function).
deleteln (function).
delscreen (function).
delwin (function).
derwin (function).
doupdate (function).
dupwin (function).
echo (function).
echochar (function).
endwin (function).
erase (function).
erasechar (function).
err (constant).
false (constant).
filter (function).
flash (function).
flushinp (function).
get-begyx (function).
get-maxyx (function).
get-paryx (function).
get-wch (function).
get-yx (function).
getbegx (function).
getbegy (function).
getbegyx (macro).
getbkgd (function).
getch (function).
getcurx (function).
getcury (function).
getmaxx (function).
getmaxy (function).
getmaxyx (macro).
getmouse (function).
getnstr (function).
getparx (function).
getpary (function).
getparyx (macro).
getstr (function).
getyx (macro).
halfdelay (function).
has-colors (function).
has-ic (function).
has-il (function).
has-key (function).
has-mouse (function).
hline (function).
idcok (function).
idlok (function).
immedok (function).
inch (function).
inchnstr (function).
inchstr (function).
init-color (function).
init-pair (function).
initscr (function).
innstr (function).
insch (function).
insdelln (function).
insertln (function).
insnstr (function).
insstr (function).
instr (function).
intrflush (function).
is-linetouched (function).
is-term-resized (function).
is-wintouched (function).
isendwin (function).
key_a1 (constant).
key_a3 (constant).
key_b2 (constant).
key_backspace (constant).
key_beg (constant).
key_break (constant).
key_btab (constant).
key_c1 (constant).
key_c3 (constant).
key_cancel (constant).
key_catab (constant).
key_clear (constant).
key_close (constant).
key_command (constant).
key_copy (constant).
key_create (constant).
key_ctab (constant).
key_dc (constant).
key_dl (constant).
key_down (constant).
key_eic (constant).
key_end (constant).
key_enter (constant).
key_eol (constant).
key_eos (constant).
key_event (constant).
key_exit (constant).
key_f0 (constant).
key_find (constant).
key_fn (function).
key_help (constant).
key_home (constant).
key_ic (constant).
key_il (constant).
key_left (constant).
key_ll (constant).
key_mark (constant).
key_message (constant).
key_mouse (constant).
key_move (constant).
key_next (constant).
key_npage (constant).
key_open (constant).
key_options (constant).
key_ppage (constant).
key_previous (constant).
key_print (constant).
key_redo (constant).
key_reference (constant).
key_refresh (constant).
key_replace (constant).
key_reset (constant).
key_resize (constant).
key_restart (constant).
key_resume (constant).
key_right (constant).
key_save (constant).
key_sbeg (constant).
key_scancel (constant).
key_scommand (constant).
key_scopy (constant).
key_screate (constant).
key_sdc (constant).
key_sdl (constant).
key_select (constant).
key_send (constant).
key_seol (constant).
key_sexit (constant).
key_sf (constant).
key_sfind (constant).
key_shelp (constant).
key_shome (constant).
key_sic (constant).
key_sleft (constant).
key_smessage (constant).
key_smove (constant).
key_snext (constant).
key_soptions (constant).
key_sprevious (constant).
key_sprint (constant).
key_sr (constant).
key_sredo (constant).
key_sreplace (constant).
key_sreset (constant).
key_sright (constant).
key_srsume (constant).
key_ssave (constant).
key_ssuspend (constant).
key_stab (constant).
key_sundo (constant).
key_suspend (constant).
key_undo (constant).
key_up (constant).
keybound (function).
keyname (function).
keyok (function).
keypad (function).
killchar (function).
leaveok (function).
longname (function).
mcprint (function).
meta (function).
mouse-trafo (function).
mouse-wtrafo (function).
mouseinterval (function).
mousemask (function).
move (function).
mvaddch (function).
mvaddchnstr (function).
mvaddchstr (function).
mvaddnstr (function).
mvaddstr (function).
mvchgat (function).
mvdelch (function).
mvderwin (function).
mvget-wch (function).
mvgetch (function).
mvgetnstr (function).
mvgetstr (function).
mvhline (function).
mvinch (function).
mvinchnstr (function).
mvinchstr (function).
mvinnstr (function).
mvinsch (function).
mvinsnstr (function).
mvinsstr (function).
mvinstr (function).
mvprintw (macro).
mvvline (function).
mvwaddch (function).
mvwaddchnstr (function).
mvwaddchstr (function).
mvwaddnstr (function).
mvwaddstr (function).
mvwchgat (function).
mvwdelch (function).
mvwget-wch (function).
mvwgetch (function).
mvwgetnstr (function).
mvwgetstr (function).
mvwhline (function).
mvwin (function).
mvwinch (function).
mvwinchnstr (function).
mvwinchstr (function).
mvwinsch (function).
mvwinsnstr (function).
mvwinsstr (function).
mvwprintw (macro).
mvwvline (function).
napms (function).
newpad (function).
newterm (function).
newwin (function).
nl (function).
nocbreak (function).
nodelay (function).
noecho (function).
nonl (function).
noqiflush (function).
noraw (function).
notimeout (function).
ok (constant).
overlay (function).
overwrite (function).
pair-content (function).
pechochar (function).
pnoutrefresh (function).
prefresh (function).
printw (macro).
qiflush (function).
raw (function).
redrawwin (function).
refresh (function).
report_mouse_position (constant).
reset-prog-mode (function).
reset-shell-mode (function).
resetty (function).
resize-term (function).
resizeterm (function).
savetty (function).
scr-dump (function).
scr-init (function).
scr-restore (function).
scr-set (function).
scrl (function).
scroll (function).
scrollok (function).
set-term (function).
setscrreg (function).
slk-attroff (function).
slk-attron (function).
slk-attrset (function).
slk-clear (function).
slk-color (function).
slk-init (function).
slk-label (function).
slk-noutrefresh (function).
slk-refresh (function).
slk-restore (function).
slk-set (function).
slk-touch (function).
standend (function).
standout (function).
start-color (function).
subpad (function).
subwin (function).
syncok (function).
termattrs (function).
termname (function).
tgetflag (function).
tgetnum (function).
timeout (function).
touchline (function).
touchwin (function).
true (constant).
typeahead (function).
unctrl (function).
unget-wch (function).
ungetch (function).
untouchwin (function).
use-default-colors (function).
use-env (function).
use-extended-names (function).
vline (function).
wa_altcharset (constant).
wa_attributes (constant).
wa_blink (constant).
wa_bold (constant).
wa_dim (constant).
wa_horizontal (constant).
wa_invis (constant).
wa_left (constant).
wa_low (constant).
wa_normal (constant).
wa_protect (constant).
wa_reverse (constant).
wa_right (constant).
wa_standout (constant).
wa_top (constant).
wa_underline (constant).
wa_vertical (constant).
waddch (function).
waddchnstr (function).
waddchstr (function).
waddnstr (function).
waddstr (function).
wattr-get (function).
wattr-off (function).
wattr-on (function).
wattr-set (function).
wattroff (function).
wattron (function).
wattrset (function).
wbkgd (function).
wbkgdset (function).
wborder (function).
wchgat (function).
wclear (function).
wclrtobot (function).
wclrtoeol (function).
wcolor-set (function).
wcursyncup (function).
wdelch (function).
wdeleteln (function).
wechochar (function).
wenclose (function).
werase (function).
wget-wch (function).
wgetch (function).
wgetnstr (function).
wgetstr (function).
whline (function).
winch (function).
winchnstr (function).
winchstr (function).
winnstr (function).
winsch (function).
winsdelln (function).
winsertln (function).
winsnstr (function).
winsstr (function).
winstr (function).
wmove (function).
wnoutrefresh (function).
wprintw (macro).
wredrawln (function).
wrefresh (function).
wresize (function).
wscrl (function).
wsetscrreg (function).
wstandend (function).
wstandout (function).
wsyncdown (function).
wsyncup (function).
wtimeout (function).
wtouchln (function).
wvline (function).
%getmouse (function).
%mousemask (function).
%ungetmouse (function).
%var-accessor-*color-pairs* (function).
(setf %var-accessor-*color-pairs*) (function).
%var-accessor-*color-paths* (function).
(setf %var-accessor-*color-paths*) (function).
%var-accessor-*colors* (function).
(setf %var-accessor-*colors*) (function).
%var-accessor-*cols* (function).
(setf %var-accessor-*cols*) (function).
%var-accessor-*curscr* (function).
(setf %var-accessor-*curscr*) (function).
%var-accessor-*escdelay* (function).
(setf %var-accessor-*escdelay*) (function).
%var-accessor-*lines* (function).
(setf %var-accessor-*lines*) (function).
%var-accessor-*newscr* (function).
(setf %var-accessor-*newscr*) (function).
%var-accessor-*stdscr* (function).
(setf %var-accessor-*stdscr*) (function).
%var-accessor-*tabsize* (function).
(setf %var-accessor-*tabsize*) (function).
*color-paths* (symbol macro).
c-get-wch (function).
c-mvget-wch (function).
c-mvwget-wch (function).
c-wget-wch (function).
define-exported-cfuns (macro).
define-exported-constant (macro).
generate-getyx-macro (macro).
generate-getyx-macros (macro).
mevent-tclass (class).
cl-charmsPackage containing a high-level interface to ncurses.
charms
common-lisp.
*standard-window* (special variable).
beep-console (function).
char-at-cursor (function).
char-at-point (function).
clear-line-after-cursor (function).
clear-window (function).
clear-window-after-cursor (function).
copy-window (function).
curses-version (function).
cursor-position (function).
destroy-window (function).
disable-echoing (function).
disable-extra-keys (function).
disable-non-blocking-mode (function).
disable-raw-input (function).
enable-echoing (function).
enable-extra-keys (function).
enable-non-blocking-mode (function).
enable-raw-input (function).
finalize (function).
flash-console (function).
force-repaint (function).
get-char (function).
initialize (function).
insert-char-at-cursor (function).
insert-char-at-point (function).
make-window (function).
move-cursor (function).
move-cursor-down (function).
move-cursor-left (function).
move-cursor-right (function).
move-cursor-up (function).
refresh-window (function).
standard-window (function).
window (class).
window-dimensions (function).
with-curses (macro).
with-restored-cursor (macro).
write-char-at-cursor (function).
write-char-at-point (function).
write-string-at-cursor (function).
write-string-at-point (function).
%check-status (function).
*input-mode* (special variable).
c-char-to-character (function).
character-to-c-char (function).
check-status (macro).
from-foreign-boolean (function).
last-position-p (function).
resolve-window (function).
to-foreign-boolean (function).
window-pointer (generic reader).
(setf window-pointer) (generic writer).
write-char-at-last-position (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Bind-only special variable containing the standard window.
Prints formatted output in curses windows at (‘x‘, ‘y‘).
Output is formatted as ‘fmt‘, according to C language’s printf function.
Arguments for ‘fmt‘ can be passed as a form of { arg-type arg }*.
caution: This function may crash when format string ‘fmt‘ won’t match rest arguments.
see printw for examples.
Prints formatted output in window ‘win‘ at (‘x‘, ‘y‘).
Output is formatted as ‘fmt‘, according to C language’s printf function.
Arguments for ‘fmt‘ can be passed as a form of { arg-type arg }*.
caution: This function may crash when format string ‘fmt‘ won’t match rest arguments.
see printw for examples.
Prints formatted output in curses windows.
Output is formatted as ‘fmt‘, according to C language’s printf function.
Arguments for ‘fmt‘ can be passed as a form of { arg-type arg }*.
caution: This function may crash when format string ‘fmt‘ won’t match rest arguments.
examples:
(printw "Hello world") ; prints ’Hello world’
(printw "%d %.2f %s" :int 42 :double pi :string "charms"); prints ’42 3.14 charms’
Execute the body BODY, ensuring that curses is properly initialized and finalized.
Within BODY, the special variable *STANDARD-WINDOW* will be bound, which refers to the global window.
Currently, there are no OPTIONS.
Execute the body BODY, restoring the cursor position in the window WINDOW to its beginning state.
Prints formatted output in window ‘win‘.
Output is formatted as ‘fmt‘, according to C language’s printf function.
Arguments for ‘fmt‘ can be passed as a form of { arg-type arg }*.
caution: This function may crash when format string ‘fmt‘ won’t match rest arguments.
see printw for examples.
Audibly beep to alert the user.
What is the character at the cursor in the window WINDOW?
What is the character at the point (X, Y) in the window WINDOW?
Clear the rest of the line after the cursor in the window WINDOW.
Blank out the contents of the window WINDOW. If FORCE-REPAINT is T, then the window will be repainted entirely in the next refresh. (Using this option can be more optimally performant than calling ‘CHARMS:FORCE-REPAINT’ manually.)
Clear the rest of the window after the cursor in the window WINDOW.
Copy the window WINDOW.
Return a string representing the version of the underlying curses implementation.
Given a window WINDOW, return its X and Y coordinates as two values respectively.
Destroy the window WINDOW.
Disable the echoing of characters to the screen.
Disable extra keys, such as arrow and function keys, in the window WINDOW.
Disable non-blocking mode for the window WINDOW. This will cause character input to block.
Disables raw input mode. This undoes the action of ‘CHARMS:ENABLE-RAW-INPUT’.
Enable the echoing of characters to the screen.
Enable extra keys, such as arrow and function keys, in the window WINDOW.
Enable non-blocking mode for the window WINDOW. This will cause character input functions to not block and error (or return NIL).
Enables raw input mode. This disables line buffering and will make characters available as soon as they’re typed.
If INTERPRET-CONTROL-CHARACTERS is T, then control characters like Ctrl-C will be interpreted as usual.
Finalize ncurses.
This function must be called before exiting. Consider using the macro ‘CHARMS:WITH-CURSES’ to ensure this.
Visually flash the console.
Force the entire window to be cleared and repainted on the next call to ‘CHARMS:REFRESH-WINDOW’.
Get a character from the window WINDOW. In the event a character is not ready or could not be returned, thensignal an error. If IGNORE-ERROR is T, then instead return NIL.
Returns the character in the main value and C-function’s return code in second
value. Replaces primary value (which would be garbage) with :ERROR if C-function returned ERR
The has_mouse function returns TRUE if the mouse driver has been successfully initialized.
Initialize ncurses and the terminal for drawing. Return the standard window.
This function must be called before using curses functions. Consider using the macro ‘CHARMS:WITH-CURSES’ to ensure this.
Insert the character CHAR at the cursor within the window WINDOW, advancing the rest of the line, without moving the cursor. (This is akin to pressing the ’insert’ key and typing a character.)
Insert the character CHAR at the coordinates (X,Y) within the window WINDOW, advancing the rest of the line, without moving the cursor. (This is akin to pressing the ’insert’ key and typing a character.)
Make a new window of width WIDTH and height HEIGHT, starting at the coordinate (START-X, START-Y).
Note that windows may not overlap.
The mouse_trafo function performs the same translation as wmouse_trafo, using stdscr for win.
The wmouse_trafo function transforms a given pair of coordinates from
stdscr-relative coordinates to coordinates relative to the given window or vice
versa. The resulting stdscr-relative coordinates are not always identical to
window-relative coordinates due to the mechanism to reserve lines on top or
bottom of the screen for other purposes (see the ripoffline and slk_init calls,
for example).
- If the parameter to_screen is TRUE, the pointers pY, pX must reference the
coordinates of a location inside the window win. They are converted to
window-relative coordinates and returned through the pointers. If the
conversion was successful, the function returns TRUE.
- If one of the parameters was NULL or the location is not inside the window,
FALSE is returned.
- If to_screen is FALSE, the pointers pY, pX must reference window-relative
coordinates. They are converted to stdscr-relative coordinates if the window
win encloses this point. In this case the function returns TRUE.
- If one of the parameters is NULL or the point is not inside the window, FALSE is returned. The referenced coordinates are only replaced by the converted coordinates if the transformation was successful.
The mouseinterval function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to be recognized as a click. Use mouseinterval(0) to disable click resolution. This function returns the previous interval value. Use mouseinterval(-1) to obtain the interval without altering it. The default is one sixth of a second.
set newmask as mousemask, returning old one
Move the cursor in window WINDOW to the coordinates (X, Y).
Move the cursor in the window WINDOW down by 1 character. If the positive integer AMOUNT is specified, it will be moved down AMOUNT characters. If negative, it will move up AMOUNT characters.
Move the cursor in the window WINDOW left by 1 character. If the positive integer AMOUNT is specified, it will be moved left AMOUNT characters. If negative, it will move right AMOUNT characters.
Move the cursor in the window WINDOW right by 1 character. If the positive integer AMOUNT is specified, it will be moved right AMOUNT characters. If negative, it will move left AMOUNT characters.
Move the cursor in the window WINDOW up by 1 character. If the positive integer AMOUNT is specified, it will be moved up AMOUNT characters. If negative, it will move down AMOUNT characters.
Returns the character in the main value and C-function’s return code in second
value. Replaces primary value (which would be garbage) with :ERROR if C-function returned ERR
Returns the character in the main value and C-function’s return code in second
value. Replaces primary value (which would be garbage) with :ERROR if C-function returned ERR
Refresh the display of the window WINDOW.
The wenclose function tests whether a given pair of screen-relative character-cell coordinates is enclosed by a given window, returning TRUE if it is and FALSE otherwise. It is useful for determining what subset of the screen windows enclose the location of a mouse event.
Returns the character in the main value and C-function’s return code in second
value. Replaces primary value (which would be garbage) with :ERROR if C-function returned ERR
Given a window WINDOW, return its width and height as two values respectively.
Write the character CHAR to the window WINDOW at the cursor.
Write the character CHAR to the window WINDOW at the coordinates (X, Y).
Write the string STRING to the window WINDOW at the cursor.
Write the string STRING to the window WINDOW at the coordinates (X, Y).
Check the status of the resulting value VALUE to see if it is an error. If so, signal an error. If not, return the value.
Define libcurses functions using cffi:defcfun. If given multiple names, define each as a distinct C function but otherwise with the same signature. The resulting function names are exported from the current package.
Once a class of mouse events has been made visible in a window, calling the wgetch function on that window may return KEY_MOUSE as an indicator that a mouse event has been queued. To read the event data and pop the event off the queue, call getmouse. This function will return OK if a mouse event is actually visible in the given window, ERR otherwise. When getmouse returns OK, the data deposited as y and x in the event structure coordinates will be screen-relative character-cell coordinates. The returned state mask will have exactly one bit set to indicate the event type. The corresponding data in the queue is marked invalid. A subsequent call to getmouse will retrieve the next older item from the queue.
To make mouse events visible, use the mousemask function. This will set the
mouse events to be reported. By default, no mouse events are reported. The
function will return a mask to indicate which of the specified mouse events can
be reported; on complete failure it returns 0. If oldmask is non-NULL, this
function fills the indicated location with the previous value of the given
window’s mouse event mask.
As a side effect, setting a zero mousemask may turn off the mouse pointer; setting a nonzero mask may turn it on. Whether this happens is device-dependent.
The ungetmouse function behaves analogously to ungetch. It pushes a KEY_MOUSE event onto the input queue, and associates with that event the given state data and screen-relative character-cell coordinates.
Convert a C character to a Lisp character.
Convert a Lisp character to a C character.
Convert the value VALUE to a Lisp boolean. If RELAX is true, then all non-false values are true.
Convert the value VALUE to a foreign bool.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U V W |
|---|
| Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U V W |
|---|
| Jump to: | *
A B C E F K O P R S T W |
|---|
| Jump to: | *
A B C E F K O P R S T W |
|---|
| Jump to: | C F H I L M O P S U W |
|---|
| Jump to: | C F H I L M O P S U W |
|---|