Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The cl-charms Reference Manual
This is the cl-charms Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:34:38 2022 GMT+0.
Table of Contents
- 1 Introduction
- 2 Systems
- 3 Modules
- 4 Files
- 4.1 Lisp
- 4.1.1 cl-charms/cl-charms.asd
- 4.1.2 cl-charms/features.lisp
- 4.1.3 cl-charms/low-level/package.lisp
- 4.1.4 cl-charms/low-level/curses-grovel.lisp
- 4.1.5 cl-charms/low-level/curses-bindings.lisp
- 4.1.6 cl-charms/low-level/mouse.lisp
- 4.1.7 cl-charms/high-level/package.lisp
- 4.1.8 cl-charms/high-level/utilities.lisp
- 4.1.9 cl-charms/high-level/windows.lisp
- 4.1.10 cl-charms/high-level/cursor.lisp
- 4.1.11 cl-charms/high-level/output.lisp
- 4.1.12 cl-charms/high-level/input.lisp
- 4.1.13 cl-charms/high-level/initialization.lisp
- 4.1.14 cl-charms/high-level/miscellaneous.lisp
- 4.1 Lisp
- 5 Packages
- 6 Definitions
- Appendix A Indexes
Next: Systems, Previous: The cl-charms Reference Manual, Up: The cl-charms Reference Manual [Contents][Index]
1 Introduction
Introduction
cl-charms is an interface to libcurses in Common Lisp. It provides
both a raw, low-level interface to libcurses via CFFI, and a more
higher-level lispier interface.
It is intended to succeed cl-ncurses, which used the less portable
UFFI instead of CFFI for foreign bindings. Indeed, cl-charms
includes portions of code from cl-ncurses, and is largely a direct
translation of the latter's UFFI definitions to CFFI.
Currently, the low-level interface (the package charms/ll) is
probably feature-equivalent to cl-ncurses and compatible with client
code. In the future, however, cl-charms may break compatibility with
cl-ncurses.
cl-charms has been developed by its original author, Abhishek Reddy
(abhishek@abhishek.geek.nz), since beginning of October 2010 for quite
some time, then abandoned for unknown reason. After that, in 2014,
Mark Fedurin (hitecnologys@gmail.com) took responsibility for keeping
the library in working state. Robert Smith (quad@symbo1ics.com) began
to fix up the CFFI bindings and provide a friendlier interface.
The software is released under an MIT-style license. See the file
COPYING for details.
The imitator dooms himself to hopeless mediocrity. The inventor did it because it was natural to him, and so in him it has a charm. In the imitator something else is natural, and he bereaves himself of his own beauty, to come short of another man's. -- R.W. Emerson on originality.
Version
Versioning roughly follows the scheme described in Semantic Versioning. Only "releases" will be versioned.
Since we are still pre-1.0.0, the minor version will indicate API
breakage. Despite being pre-1.0.0, what exists in the low-level
interface as of now is quite usable for ASCII usage. We consider this
"beta" quality. The high-level functionality is considered "alpha"
quality.
Portability
cl-charms has been tested to work to a reasonable extent (e.g.,
example code runs) on the following platforms:
- SBCL 1.1.8--1.2.9 on Gentoo Linux (3.13.6-hardened-r3--3.15.6-hardened) x86-64
- SBCL 1.2.3.15-4704124 on OS X 10.10 (Yosemite) x86-64
- SBCL 1.1.14.debian on Ubuntu 14.04.2 LTS (trusty) x86
- SBCL 1.2.11 on Windows 8.1 amd64
- CCL 1.9-r15769M on Gentoo Linux (3.13.6-hardened-r3) x86-64
- CCL 1.9-r15759 (64-bit) on OS X 10.10 (Yosemite) x86-64
- LispWorks 6.1.1 (64-bit) on OS X 10.10 (Yosemite) x86-64
- Lispworks 7.0.0 (32-bit) on OS X 10.10 (Yosemite) x86-64
It may work on other implementations and system but there's no guarantee. More testing is really appreciated.
cl-charms ought to function on other implementations of Common Lisp
and libcurses on various distributions of UNIX and UNIX-like
systems. See the section on Bugs and Contributing below for how to
help test and realize this.
cl-charms is supposed to be only bindings along with a separate,
no-frills interface atop: nothing more, nothing less. For
full-featured TUI see: https://bitbucket.org/naryl/cl-tui
Windows
cl-charms works on Windows with some limitations. Currently colours are not
supported and some other features like bold might not work correctly. In order
to use cl-charms on Windows, you'll need PDCurses library that is available
at http://pdcurses.sourceforge.net/. If you want to use GDI instead of console
http://www.projectpluto.com/win32a.htm would be a good option.
While the original PDCurses project offers prebuilt binaries, using project pluto requires you to compile your own binaries.
Usage is as simple as placing the pdcurses.dll (optionally renaming
it libcurses.dll) either in PATH or in the directory where you're
running your cl-charms program. Project pluto will require
additional dependencies, namely libgcc_s_dw2-1.dll and SDL.dll.
Installation
If you're Quicklisp user, then simple
(ql:quickload :cl-charms)
would suffice, as cl-charms is in Quicklisp.
If you're not, then install Quicklisp and follow to the previous paragraph.
Usage
The low-level library is contained within the package
cl-charms/low-level, nicknamed charms/ll. This is mostly a
one-to-one equivalent to standard curses functions.
The high-level library is contained within the package cl-charms,
nicknamed charms.
Examples and Tutorials
There are currently two examples included with the source code, all of which you can find in the examples directory.
You might also want to check out the following applications written
using cl-charms:
- CHARMLIFE, a viewer for Conway's Game of Life, exponentially accelerated with the HASHLIFE algorithm (video, source)
- The game "Snake" (video, source)
- Steve Losh's Lisp Game Jam entry silt2 (blog post)
Daniel Kochmanski has written a nice tutorial about CL-CHARMS here.
Timer
A minimal, simple timer/stopwatch program.
* (ql:quickload :cl-charms-timer)
* (charms-timer:main)
Paint
A simple ASCII art drawing program.
* (ql:quickload :cl-charms-paint)
* (charms-paint:main)
Testing
As a minimum, it would be appreciated if the library was compiled and loaded on various Lisp systems on a variety of operating systems.
[TODO]
Note about SLIME
The libcurses library handles terminal, and emacs is not a terminal
it can handle. So if you run lisp from SLIME (inside emacs),
libcurses functions won't work properly.
If you want to use SLIME, a possible way (to e.g. run the timer example) is:
- run lisp from terminal
(ql:quickload '(:swank) :silent t);; from terminal(swank:create-server :port 5555 :dont-close t);; from terminal, too(loop (sleep 1));; from terminal, prevents read-line in console REPL- go to emacs and M-x slime-connect RET localhost RET 5555 RET
(ql:quickload :cl-charms-timer);; from emacs repl(charms-timer:main);; from emacs repl
Now you should see timer running on terminal.
Step 1. ~ 3. can be done as a one-liner:
- for SBCL:
sbcl --eval "(ql:quickload '(:swank) :silent t)" --eval "(swank:create-server :port 5555 :dont-close t)" - for CCL:
ccl -e "(ql:quickload '(:swank) :silent t)" -e "(swank:create-server :port 5555 :dont-close t)";; maybe ccl64 instead of ccl - for Roswell:
ros run -e "(ql:quickload '(:swank) :silent t)" -e "(swank:create-server :port 5555 :dont-close t)"
Bugs and Contributing
You can use GitHub project's (which is located here: https://github.com/HiTECNOLOGYs/cl-charms) issues tracker or wiki to contribute bug reports/patches/etc. or just send an email to one of the maintainers.
Major areas of work to be done:
- Add bindings for all the functions from ncurses
- Do more testing on different OS and architectures
- Try it with non-libncurses libraries.
- Test cases and sample applications.
- Finally write documentation
Current Maintainers
- Robert Smith (quad@symbo1ics.com)
- Mark Fedurin (me@hitecnologys.org)
Next: Modules, Previous: Introduction, Up: The cl-charms Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-charms
CFFI bindings for curses.
- Maintainer
Mark Fedurin <hitecnologys@gmail.com>
- Author
Abhishek Reddy <abhishek@abhishek.geek.nz>
- License
MIT License (See COPYING)
- Version
0.2.0
- Defsystem Dependency
cffi-grovel (system).
- Dependencies
- cffi (system).
- alexandria (system).
- Source
- Child Components
- features.lisp (file).
- low-level (module).
- high-level (module).
Next: Files, Previous: Systems, Up: The cl-charms Reference Manual [Contents][Index]
3 Modules
Modules are listed depth-first from the system components tree.
Next: cl-charms/high-level, Previous: Modules, Up: Modules [Contents][Index]
3.1 cl-charms/low-level
- Dependency
features.lisp (file).
- Source
- Parent Component
cl-charms (system).
- Child Components
- package.lisp (file).
- curses-grovel.lisp (file).
- curses-bindings.lisp (file).
- mouse.lisp (file).
Previous: cl-charms/low-level, Up: Modules [Contents][Index]
3.2 cl-charms/high-level
- Dependency
low-level (module).
- Source
- Parent Component
cl-charms (system).
- Child Components
- package.lisp (file).
- utilities.lisp (file).
- windows.lisp (file).
- cursor.lisp (file).
- output.lisp (file).
- input.lisp (file).
- initialization.lisp (file).
- miscellaneous.lisp (file).
Next: Packages, Previous: Modules, Up: The cl-charms Reference Manual [Contents][Index]
4 Files
Files are sorted by type and then listed depth-first from the systems components trees.
4.1 Lisp
- cl-charms/cl-charms.asd
- cl-charms/features.lisp
- cl-charms/low-level/package.lisp
- cl-charms/low-level/curses-grovel.lisp
- cl-charms/low-level/curses-bindings.lisp
- cl-charms/low-level/mouse.lisp
- cl-charms/high-level/package.lisp
- cl-charms/high-level/utilities.lisp
- cl-charms/high-level/windows.lisp
- cl-charms/high-level/cursor.lisp
- cl-charms/high-level/output.lisp
- cl-charms/high-level/input.lisp
- cl-charms/high-level/initialization.lisp
- cl-charms/high-level/miscellaneous.lisp
Next: cl-charms/features.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
4.1.1 cl-charms/cl-charms.asd
- Source
- Parent Component
cl-charms (system).
- ASDF Systems
Next: cl-charms/low-level/package.lisp, Previous: cl-charms/cl-charms.asd, Up: Lisp [Contents][Index]
4.1.2 cl-charms/features.lisp
- Source
- Parent Component
cl-charms (system).
Next: cl-charms/low-level/curses-grovel.lisp, Previous: cl-charms/features.lisp, Up: Lisp [Contents][Index]
4.1.3 cl-charms/low-level/package.lisp
- Source
- Parent Component
low-level (module).
- Packages
Next: cl-charms/low-level/curses-bindings.lisp, Previous: cl-charms/low-level/package.lisp, Up: Lisp [Contents][Index]
4.1.4 cl-charms/low-level/curses-grovel.lisp
- Dependency
package.lisp (file).
- Source
- Parent Component
low-level (module).
Next: cl-charms/low-level/mouse.lisp, Previous: cl-charms/low-level/curses-grovel.lisp, Up: Lisp [Contents][Index]
4.1.5 cl-charms/low-level/curses-bindings.lisp
- Dependency
curses-grovel.lisp (file).
- Source
- Parent Component
low-level (module).
- Public Interface
- *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).
- Internals
- %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).
Next: cl-charms/high-level/package.lisp, Previous: cl-charms/low-level/curses-bindings.lisp, Up: Lisp [Contents][Index]
4.1.6 cl-charms/low-level/mouse.lisp
- Dependency
curses-bindings.lisp (file).
- Source
- Parent Component
low-level (module).
- Public Interface
- 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).
- Internals
- %getmouse (function).
- %mousemask (function).
- %ungetmouse (function).
- mevent-tclass (class).
Next: cl-charms/high-level/utilities.lisp, Previous: cl-charms/low-level/mouse.lisp, Up: Lisp [Contents][Index]
4.1.7 cl-charms/high-level/package.lisp
- Source
- Parent Component
high-level (module).
- Packages
Next: cl-charms/high-level/windows.lisp, Previous: cl-charms/high-level/package.lisp, Up: Lisp [Contents][Index]
4.1.8 cl-charms/high-level/utilities.lisp
- Dependency
package.lisp (file).
- Source
- Parent Component
high-level (module).
- Internals
- %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).
Next: cl-charms/high-level/cursor.lisp, Previous: cl-charms/high-level/utilities.lisp, Up: Lisp [Contents][Index]
4.1.9 cl-charms/high-level/windows.lisp
- Dependency
utilities.lisp (file).
- Source
- Parent Component
high-level (module).
- Public Interface
- *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).
- Internals
- window-pointer (reader method).
- (setf window-pointer) (writer method).
Next: cl-charms/high-level/output.lisp, Previous: cl-charms/high-level/windows.lisp, Up: Lisp [Contents][Index]
4.1.10 cl-charms/high-level/cursor.lisp
- Dependency
windows.lisp (file).
- Source
- Parent Component
high-level (module).
- Public Interface
- 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).
Next: cl-charms/high-level/input.lisp, Previous: cl-charms/high-level/cursor.lisp, Up: Lisp [Contents][Index]
4.1.11 cl-charms/high-level/output.lisp
- Dependency
cursor.lisp (file).
- Source
- Parent Component
high-level (module).
- Public Interface
- 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).
- Internals
- last-position-p (function).
- write-char-at-last-position (function).
Next: cl-charms/high-level/initialization.lisp, Previous: cl-charms/high-level/output.lisp, Up: Lisp [Contents][Index]
4.1.12 cl-charms/high-level/input.lisp
- Dependency
output.lisp (file).
- Source
- Parent Component
high-level (module).
- Public Interface
get-char (function).
Next: cl-charms/high-level/miscellaneous.lisp, Previous: cl-charms/high-level/input.lisp, Up: Lisp [Contents][Index]
4.1.13 cl-charms/high-level/initialization.lisp
- Dependency
input.lisp (file).
- Source
- Parent Component
high-level (module).
- Public Interface
- 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).
- Internals
*input-mode* (special variable).
Previous: cl-charms/high-level/initialization.lisp, Up: Lisp [Contents][Index]
4.1.14 cl-charms/high-level/miscellaneous.lisp
- Dependency
initialization.lisp (file).
- Source
- Parent Component
high-level (module).
- Public Interface
- beep-console (function).
- curses-version (function).
- flash-console (function).
Next: Definitions, Previous: Files, Up: The cl-charms Reference Manual [Contents][Index]
5 Packages
Packages are listed by definition order.
Next: cl-charms/low-level, Previous: Packages, Up: Packages [Contents][Index]
5.1 cl-charms
Package containing a high-level interface to ncurses.
- Source
- Nickname
charms
- Use List
common-lisp.
- Public Interface
- *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).
- Internals
- %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).
5.2 cl-charms/low-level
Package containing the one-to-one bindings to the ncurses library.
- Source
- Nickname
charms/ll
- Use List
common-lisp.
- Public Interface
- *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).
- Internals
- %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).
Next: Indexes, Previous: Packages, Up: The cl-charms Reference Manual [Contents][Index]
6 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
6.1 Public Interface
Next: Special variables, Previous: Public Interface, Up: Public Interface [Contents][Index]
6.1.1 Constants
- Constant: a_altcharset ¶
-
- Package
- Source
- Constant: a_attributes ¶
-
- Package
- Source
- Constant: a_blink ¶
-
- Package
- Source
- Constant: a_bold ¶
-
- Package
- Source
- Constant: a_dim ¶
-
- Package
- Source
- Constant: a_horizontal ¶
-
- Package
- Source
- Constant: a_invis ¶
-
- Package
- Source
- Constant: a_left ¶
-
- Package
- Source
- Constant: a_low ¶
-
- Package
- Source
- Constant: a_normal ¶
-
- Package
- Source
- Constant: a_protect ¶
-
- Package
- Source
- Constant: a_reverse ¶
-
- Package
- Source
- Constant: a_right ¶
-
- Package
- Source
- Constant: a_standout ¶
-
- Package
- Source
- Constant: a_top ¶
-
- Package
- Source
- Constant: a_underline ¶
-
- Package
- Source
- Constant: a_vertical ¶
-
- Package
- Source
- Constant: acs_btee ¶
-
- Package
- Source
- Constant: acs_bullet ¶
-
- Package
- Source
- Constant: acs_ckboard ¶
-
- Package
- Source
- Constant: acs_degree ¶
-
- Package
- Source
- Constant: acs_diamond ¶
-
- Package
- Source
- Constant: acs_hline ¶
-
- Package
- Source
- Constant: acs_llcorner ¶
-
- Package
- Source
- Constant: acs_lrcorner ¶
-
- Package
- Source
- Constant: acs_ltee ¶
-
- Package
- Source
- Constant: acs_plminus ¶
-
- Package
- Source
- Constant: acs_plus ¶
-
- Package
- Source
- Constant: acs_rtee ¶
-
- Package
- Source
- Constant: acs_s1 ¶
-
- Package
- Source
- Constant: acs_s9 ¶
-
- Package
- Source
- Constant: acs_ttee ¶
-
- Package
- Source
- Constant: acs_ulcorner ¶
-
- Package
- Source
- Constant: acs_urcorner ¶
-
- Package
- Source
- Constant: acs_vline ¶
-
- Package
- Source
- Constant: all_mouse_events ¶
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
-
- Package
- Source
- Constant: color_black ¶
-
- Package
- Source
- Constant: color_blue ¶
-
- Package
- Source
- Constant: color_cyan ¶
-
- Package
- Source
- Constant: color_green ¶
-
- Package
- Source
- Constant: color_magenta ¶
-
- Package
- Source
- Constant: color_red ¶
-
- Package
- Source
- Constant: color_white ¶
-
- Package
- Source
- Constant: color_yellow ¶
-
- Package
- Source
- Constant: err ¶
-
- Package
- Source
- Constant: false ¶
-
- Package
- Source
- Constant: key_a1 ¶
-
- Package
- Source
- Constant: key_a3 ¶
-
- Package
- Source
- Constant: key_b2 ¶
-
- Package
- Source
- Constant: key_backspace ¶
-
- Package
- Source
- Constant: key_beg ¶
-
- Package
- Source
- Constant: key_break ¶
-
- Package
- Source
- Constant: key_btab ¶
-
- Package
- Source
- Constant: key_c1 ¶
-
- Package
- Source
- Constant: key_c3 ¶
-
- Package
- Source
- Constant: key_cancel ¶
-
- Package
- Source
- Constant: key_catab ¶
-
- Package
- Source
- Constant: key_clear ¶
-
- Package
- Source
- Constant: key_close ¶
-
- Package
- Source
- Constant: key_command ¶
-
- Package
- Source
- Constant: key_copy ¶
-
- Package
- Source
- Constant: key_create ¶
-
- Package
- Source
- Constant: key_ctab ¶
-
- Package
- Source
- Constant: key_dc ¶
-
- Package
- Source
- Constant: key_dl ¶
-
- Package
- Source
- Constant: key_down ¶
-
- Package
- Source
- Constant: key_eic ¶
-
- Package
- Source
- Constant: key_end ¶
-
- Package
- Source
- Constant: key_enter ¶
-
- Package
- Source
- Constant: key_eol ¶
-
- Package
- Source
- Constant: key_eos ¶
-
- Package
- Source
- Constant: key_event ¶
-
- Package
- Source
- Constant: key_exit ¶
-
- Package
- Source
- Constant: key_f0 ¶
-
- Package
- Source
- Constant: key_find ¶
-
- Package
- Source
- Constant: key_help ¶
-
- Package
- Source
- Constant: key_home ¶
-
- Package
- Source
- Constant: key_ic ¶
-
- Package
- Source
- Constant: key_il ¶
-
- Package
- Source
- Constant: key_left ¶
-
- Package
- Source
- Constant: key_ll ¶
-
- Package
- Source
- Constant: key_mark ¶
-
- Package
- Source
- Constant: key_message ¶
-
- Package
- Source
- Constant: key_mouse ¶
-
- Package
- Source
- Constant: key_move ¶
-
- Package
- Source
- Constant: key_next ¶
-
- Package
- Source
- Constant: key_npage ¶
-
- Package
- Source
- Constant: key_open ¶
-
- Package
- Source
- Constant: key_options ¶
-
- Package
- Source
- Constant: key_ppage ¶
-
- Package
- Source
- Constant: key_previous ¶
-
- Package
- Source
- Constant: key_print ¶
-
- Package
- Source
- Constant: key_redo ¶
-
- Package
- Source
- Constant: key_reference ¶
-
- Package
- Source
- Constant: key_refresh ¶
-
- Package
- Source
- Constant: key_replace ¶
-
- Package
- Source
- Constant: key_reset ¶
-
- Package
- Source
- Constant: key_resize ¶
-
- Package
- Source
- Constant: key_restart ¶
-
- Package
- Source
- Constant: key_resume ¶
-
- Package
- Source
- Constant: key_right ¶
-
- Package
- Source
- Constant: key_save ¶
-
- Package
- Source
- Constant: key_sbeg ¶
-
- Package
- Source
- Constant: key_scancel ¶
-
- Package
- Source
- Constant: key_scommand ¶
-
- Package
- Source
- Constant: key_scopy ¶
-
- Package
- Source
- Constant: key_screate ¶
-
- Package
- Source
- Constant: key_sdc ¶
-
- Package
- Source
- Constant: key_sdl ¶
-
- Package
- Source
- Constant: key_select ¶
-
- Package
- Source
- Constant: key_send ¶
-
- Package
- Source
- Constant: key_seol ¶
-
- Package
- Source
- Constant: key_sexit ¶
-
- Package
- Source
- Constant: key_sf ¶
-
- Package
- Source
- Constant: key_sfind ¶
-
- Package
- Source
- Constant: key_shelp ¶
-
- Package
- Source
- Constant: key_shome ¶
-
- Package
- Source
- Constant: key_sic ¶
-
- Package
- Source
- Constant: key_sleft ¶
-
- Package
- Source
- Constant: key_smessage ¶
-
- Package
- Source
- Constant: key_smove ¶
-
- Package
- Source
- Constant: key_snext ¶
-
- Package
- Source
- Constant: key_soptions ¶
-
- Package
- Source
- Constant: key_sprevious ¶
-
- Package
- Source
- Constant: key_sprint ¶
-
- Package
- Source
- Constant: key_sr ¶
-
- Package
- Source
- Constant: key_sredo ¶
-
- Package
- Source
- Constant: key_sreplace ¶
-
- Package
- Source
- Constant: key_sreset ¶
-
- Package
- Source
- Constant: key_sright ¶
-
- Package
- Source
- Constant: key_srsume ¶
-
- Package
- Source
- Constant: key_ssave ¶
-
- Package
- Source
- Constant: key_ssuspend ¶
-
- Package
- Source
- Constant: key_stab ¶
-
- Package
- Source
- Constant: key_sundo ¶
-
- Package
- Source
- Constant: key_suspend ¶
-
- Package
- Source
- Constant: key_undo ¶
-
- Package
- Source
- Constant: key_up ¶
-
- Package
- Source
- Constant: ok ¶
-
- Package
- Source
- Constant: report_mouse_position ¶
-
- Package
- Source
- Constant: true ¶
-
- Package
- Source
- Constant: wa_altcharset ¶
-
- Package
- Source
- Constant: wa_attributes ¶
-
- Package
- Source
- Constant: wa_blink ¶
-
- Package
- Source
- Constant: wa_bold ¶
-
- Package
- Source
- Constant: wa_dim ¶
-
- Package
- Source
- Constant: wa_horizontal ¶
-
- Package
- Source
- Constant: wa_invis ¶
-
- Package
- Source
- Constant: wa_left ¶
-
- Package
- Source
- Constant: wa_low ¶
-
- Package
- Source
- Constant: wa_normal ¶
-
- Package
- Source
- Constant: wa_protect ¶
-
- Package
- Source
- Constant: wa_reverse ¶
-
- Package
- Source
- Constant: wa_right ¶
-
- Package
- Source
- Constant: wa_standout ¶
-
- Package
- Source
- Constant: wa_top ¶
-
- Package
- Source
- Constant: wa_underline ¶
-
- Package
- Source
- Constant: wa_vertical ¶
-
- Package
- Source
Next: Symbol macros, Previous: Constants, Up: Public Interface [Contents][Index]
6.1.2 Special variables
- Special Variable: *standard-window* ¶
-
Bind-only special variable containing the standard window.
- Package
- Source
Next: Macros, Previous: Special variables, Up: Public Interface [Contents][Index]
6.1.3 Symbol macros
- Symbol Macro: *color-pairs* ¶
-
- Package
- Source
- Symbol Macro: *colors* ¶
-
- Package
- Source
- Symbol Macro: *cols* ¶
-
- Package
- Source
- Symbol Macro: *curscr* ¶
-
- Package
- Source
- Symbol Macro: *escdelay* ¶
-
- Package
- Source
- Symbol Macro: *lines* ¶
-
- Package
- Source
- Symbol Macro: *newscr* ¶
-
- Package
- Source
- Symbol Macro: *stdscr* ¶
-
- Package
- Source
- Symbol Macro: *tabsize* ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Symbol macros, Up: Public Interface [Contents][Index]
6.1.4 Macros
- Macro: getbegyx (win y x) ¶
-
- Package
- Source
- Macro: getmaxyx (win y x) ¶
-
- Package
- Source
- Macro: getparyx (win y x) ¶
-
- Package
- Source
- Macro: getyx (win y x) ¶
-
- Package
- Source
- Macro: mvprintw (y x fmt &rest varargs0) ¶
-
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.
- Package
- Source
- Macro: mvwprintw (win y x fmt &rest varargs0) ¶
-
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.
- Package
- Source
- Macro: printw (fmt &rest varargs0) ¶
-
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’- Package
- Source
- Macro: with-curses (options &body body) ¶
-
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.
- Package
- Source
- Macro: with-restored-cursor (window &body body) ¶
-
Execute the body BODY, restoring the cursor position in the window WINDOW to its beginning state.
- Package
- Source
- Macro: wprintw (win fmt &rest varargs0) ¶
-
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.
- Package
- Source
Next: Classes, Previous: Macros, Up: Public Interface [Contents][Index]
6.1.5 Ordinary functions
- Function: addch (ch) ¶
-
- Package
- Source
- Function: addchnstr (chstr n) ¶
-
- Package
- Source
- Function: addchstr (chstr) ¶
-
- Package
- Source
- Function: addnstr (str n) ¶
-
- Package
- Source
- Function: addstr (str) ¶
-
- Package
- Source
- Function: assume-default-colors (fg bg) ¶
-
- Package
- Source
- Function: attr-get (attrs pair opts) ¶
-
- Package
- Source
- Function: attr-off (attrs opts) ¶
-
- Package
- Source
- Function: attr-on (attrs opts) ¶
-
- Package
- Source
- Function: attr-set (attrs pair opts) ¶
-
- Package
- Source
- Function: attroff (attrs) ¶
-
- Package
- Source
- Function: attron (attrs) ¶
-
- Package
- Source
- Function: attrset (attrs) ¶
-
- Package
- Source
- Function: baudrate () ¶
-
- Package
- Source
- Function: beep () ¶
-
- Package
- Source
- Function: beep-console () ¶
-
Audibly beep to alert the user.
- Package
- Source
- Function: bkgd (ch) ¶
-
- Package
- Source
- Function: bkgdset (ch) ¶
-
- Package
- Source
- Function: border (ls rs ts bs tl tr bl br) ¶
-
- Package
- Source
- Function: box (win verch horch) ¶
-
- Package
- Source
- Function: can-change-color () ¶
-
- Package
- Source
- Function: cbreak () ¶
-
- Package
- Source
- Function: char-at-cursor (window) ¶
-
What is the character at the cursor in the window WINDOW?
- Package
- Source
- Function: char-at-point (window x y) ¶
-
What is the character at the point (X, Y) in the window WINDOW?
- Package
- Source
- Function: chgat (n attr color opts) ¶
-
- Package
- Source
- Function: clear () ¶
-
- Package
- Source
- Function: clear-line-after-cursor (window) ¶
-
Clear the rest of the line after the cursor in the window WINDOW.
- Package
- Source
- Function: clear-window (window &key force-repaint) ¶
-
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.)
- Package
- Source
- Function: clear-window-after-cursor (window) ¶
-
Clear the rest of the window after the cursor in the window WINDOW.
- Package
- Source
- Function: clearok (win bf) ¶
-
- Package
- Source
- Function: clrtobot () ¶
-
- Package
- Source
- Function: clrtoeol () ¶
-
- Package
- Source
- Function: color-content (color r g b) ¶
-
- Package
- Source
- Function: color-pair (pair) ¶
-
- Package
- Source
- Function: color-set (color_pair_number opts) ¶
-
- Package
- Source
- Function: copy-window (window) ¶
-
Copy the window WINDOW.
- Package
- Source
- Function: curs-set (visibility) ¶
-
- Package
- Source
- Function: curses-version () ¶
-
Return a string representing the version of the underlying curses implementation.
- Package
- Source
- Function: curses-version () ¶
-
- Package
- Source
- Function: cursor-position (window) ¶
-
Given a window WINDOW, return its X and Y coordinates as two values respectively.
- Package
- Source
- Function: def-prog-mode () ¶
-
- Package
- Source
- Function: def-shell-mode () ¶
-
- Package
- Source
- Function: delay-output (ms) ¶
-
- Package
- Source
- Function: delch () ¶
-
- Package
- Source
- Function: deleteln () ¶
-
- Package
- Source
- Function: delscreen (sp) ¶
-
- Package
- Source
- Function: delwin (win) ¶
-
- Package
- Source
- Function: derwin (orig nlines ncols begin_y begin_x) ¶
-
- Package
- Source
- Function: destroy-window (window) ¶
-
Destroy the window WINDOW.
- Package
- Source
- Function: disable-echoing () ¶
-
Disable the echoing of characters to the screen.
- Package
- Source
- Function: disable-extra-keys (window) ¶
-
Disable extra keys, such as arrow and function keys, in the window WINDOW.
- Package
- Source
- Function: disable-non-blocking-mode (window) ¶
-
Disable non-blocking mode for the window WINDOW. This will cause character input to block.
- Package
- Source
- Function: disable-raw-input () ¶
-
Disables raw input mode. This undoes the action of ‘CHARMS:ENABLE-RAW-INPUT’.
- Package
- Source
- Function: doupdate () ¶
-
- Package
- Source
- Function: dupwin (win) ¶
-
- Package
- Source
- Function: echo () ¶
-
- Package
- Source
- Function: echochar (ch) ¶
-
- Package
- Source
- Function: enable-echoing () ¶
-
Enable the echoing of characters to the screen.
- Package
- Source
- Function: enable-extra-keys (window) ¶
-
Enable extra keys, such as arrow and function keys, in the window WINDOW.
- Package
- Source
- Function: enable-non-blocking-mode (window) ¶
-
Enable non-blocking mode for the window WINDOW. This will cause character input functions to not block and error (or return NIL).
- Package
- Source
- Function: enable-raw-input (&key interpret-control-characters) ¶
-
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.
- Package
- Source
- Function: endwin () ¶
-
- Package
- Source
- Function: erase () ¶
-
- Package
- Source
- Function: erasechar () ¶
-
- Package
- Source
- Function: filter () ¶
-
- Package
- Source
- Function: finalize () ¶
-
Finalize ncurses.
This function must be called before exiting. Consider using the macro ‘CHARMS:WITH-CURSES’ to ensure this.
- Package
- Source
- Function: flash () ¶
-
- Package
- Source
- Function: flash-console () ¶
-
Visually flash the console.
- Package
- Source
- Function: flushinp () ¶
-
- Package
- Source
- Function: force-repaint (window) ¶
-
Force the entire window to be cleared and repainted on the next call to ‘CHARMS:REFRESH-WINDOW’.
- Package
- Source
- Function: get-begyx (win) ¶
-
- Package
- Source
- Function: get-char (window &key ignore-error) ¶
-
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.
- Package
- Source
- Function: get-maxyx (win) ¶
-
- Package
- Source
- Function: get-paryx (win) ¶
-
- Package
- Source
- Function: get-wch () ¶
-
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- Package
- Source
- Function: get-yx (win) ¶
-
- Package
- Source
- Function: getbegx (win) ¶
-
- Package
- Source
- Function: getbegy (win) ¶
-
- Package
- Source
- Function: getbkgd (win) ¶
-
- Package
- Source
- Function: getch () ¶
-
- Package
- Source
- Function: getcurx (win) ¶
-
- Package
- Source
- Function: getcury (win) ¶
-
- Package
- Source
- Function: getmaxx (win) ¶
-
- Package
- Source
- Function: getmaxy (win) ¶
-
- Package
- Source
- Function: getmouse () ¶
-
- Package
- Source
- Function: getnstr (str n) ¶
-
- Package
- Source
- Function: getparx (win) ¶
-
- Package
- Source
- Function: getpary (win) ¶
-
- Package
- Source
- Function: getstr (str) ¶
-
- Package
- Source
- Function: halfdelay (tenths) ¶
-
- Package
- Source
- Function: has-colors () ¶
-
- Package
- Source
- Function: has-ic () ¶
-
- Package
- Source
- Function: has-il () ¶
-
- Package
- Source
- Function: has-key (ch) ¶
-
- Package
- Source
- Function: has-mouse () ¶
-
The has_mouse function returns TRUE if the mouse driver has been successfully initialized.
- Package
- Source
- Function: hline (ch n) ¶
-
- Package
- Source
- Function: idcok (win bf) ¶
-
- Package
- Source
- Function: idlok (win bf) ¶
-
- Package
- Source
- Function: immedok (win bf) ¶
-
- Package
- Source
- Function: inch () ¶
-
- Package
- Source
- Function: inchnstr (chstr n) ¶
-
- Package
- Source
- Function: inchstr (chstr) ¶
-
- Package
- Source
- Function: init-color (color r g b) ¶
-
- Package
- Source
- Function: init-pair (pair f b) ¶
-
- Package
- Source
- Function: initialize () ¶
-
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.
- Package
- Source
- Function: initscr () ¶
-
- Package
- Source
- Function: innstr (str n) ¶
-
- Package
- Source
- Function: insch (ch) ¶
-
- Package
- Source
- Function: insdelln (n) ¶
-
- Package
- Source
- Function: insert-char-at-cursor (window char) ¶
-
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.)
- Package
- Source
- Function: insert-char-at-point (window char x y) ¶
-
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.)
- Package
- Source
- Function: insertln () ¶
-
- Package
- Source
- Function: insnstr (str n) ¶
-
- Package
- Source
- Function: insstr (str) ¶
-
- Package
- Source
- Function: instr (str) ¶
-
- Package
- Source
- Function: intrflush (window bf) ¶
-
- Package
- Source
- Function: is-linetouched (win line) ¶
-
- Package
- Source
- Function: is-term-resized (lines columns) ¶
-
- Package
- Source
- Function: is-wintouched (win) ¶
-
- Package
- Source
- Function: isendwin () ¶
-
- Package
- Source
- Function: key_fn (n) ¶
-
- Package
- Source
- Function: keybound (keycode count) ¶
-
- Package
- Source
- Function: keyname (c) ¶
-
- Package
- Source
- Function: keyok (keycode enable) ¶
-
- Package
- Source
- Function: keypad (window bf) ¶
-
- Package
- Source
- Function: killchar () ¶
-
- Package
- Source
- Function: leaveok (win bf) ¶
-
- Package
- Source
- Function: longname () ¶
-
- Package
- Source
- Function: make-window (width height start-x start-y) ¶
-
Make a new window of width WIDTH and height HEIGHT, starting at the coordinate (START-X, START-Y).
Note that windows may not overlap.
- Package
- Source
- Function: mcprint (data len) ¶
-
- Package
- Source
- Function: meta (window bf) ¶
-
- Package
- Source
- Function: mouse-trafo (py px to-screen) ¶
-
The mouse_trafo function performs the same translation as wmouse_trafo, using stdscr for win.
- Package
- Source
- Function: mouse-wtrafo (win py px to-screen) ¶
-
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.
- Package
- Source
- Function: mouseinterval (erval) ¶
-
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.
- Package
- Source
- Function: mousemask (newmask) ¶
-
set newmask as mousemask, returning old one
- Package
- Source
- Function: move (y x) ¶
-
- Package
- Source
- Function: move-cursor (window x y) ¶
-
Move the cursor in window WINDOW to the coordinates (X, Y).
- Package
- Source
- Function: move-cursor-down (window &key amount) ¶
-
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.
- Package
- Source
- Function: move-cursor-left (window &key amount) ¶
-
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.
- Package
- Source
- Function: move-cursor-right (window &key amount) ¶
-
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.
- Package
- Source
- Function: move-cursor-up (window &key amount) ¶
-
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.
- Package
- Source
- Function: mvaddch (y x ch) ¶
-
- Package
- Source
- Function: mvaddchnstr (y x chstr n) ¶
-
- Package
- Source
- Function: mvaddchstr (y x chstr) ¶
-
- Package
- Source
- Function: mvaddnstr (y x str n) ¶
-
- Package
- Source
- Function: mvaddstr (y x str) ¶
-
- Package
- Source
- Function: mvchgat (y x n attr color opts) ¶
-
- Package
- Source
- Function: mvdelch (y x) ¶
-
- Package
- Source
- Function: mvderwin (win y x) ¶
-
- Package
- Source
- Function: mvget-wch (y x) ¶
-
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- Package
- Source
- Function: mvgetch (y x) ¶
-
- Package
- Source
- Function: mvgetnstr (y x str n) ¶
-
- Package
- Source
- Function: mvgetstr (y x str) ¶
-
- Package
- Source
- Function: mvhline (y x ch n) ¶
-
- Package
- Source
- Function: mvinch (y x) ¶
-
- Package
- Source
- Function: mvinchnstr (y x chstr n) ¶
-
- Package
- Source
- Function: mvinchstr (y x chstr) ¶
-
- Package
- Source
- Function: mvinnstr (y x str n) ¶
-
- Package
- Source
- Function: mvinsch (y x ch) ¶
-
- Package
- Source
- Function: mvinsnstr (y x str n) ¶
-
- Package
- Source
- Function: mvinsstr (y x str) ¶
-
- Package
- Source
- Function: mvinstr (y x str) ¶
-
- Package
- Source
- Function: mvvline (y x ch n) ¶
-
- Package
- Source
- Function: mvwaddch (win y x ch) ¶
-
- Package
- Source
- Function: mvwaddchnstr (win y x chstr n) ¶
-
- Package
- Source
- Function: mvwaddchstr (win y x chstr) ¶
-
- Package
- Source
- Function: mvwaddnstr (win y x str n) ¶
-
- Package
- Source
- Function: mvwaddstr (win y x str) ¶
-
- Package
- Source
- Function: mvwchgat (win y x n attr color opts) ¶
-
- Package
- Source
- Function: mvwdelch (win y x) ¶
-
- Package
- Source
- Function: mvwget-wch (win y x) ¶
-
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- Package
- Source
- Function: mvwgetch (win y x) ¶
-
- Package
- Source
- Function: mvwgetnstr (win y x str n) ¶
-
- Package
- Source
- Function: mvwgetstr (win y x str) ¶
-
- Package
- Source
- Function: mvwhline (win y x ch n) ¶
-
- Package
- Source
- Function: mvwin (win y x) ¶
-
- Package
- Source
- Function: mvwinch (win y x) ¶
-
- Package
- Source
- Function: mvwinchnstr (win y x chstr n) ¶
-
- Package
- Source
- Function: mvwinchstr (win y x chstr) ¶
-
- Package
- Source
- Function: mvwinsch (win y x ch) ¶
-
- Package
- Source
- Function: mvwinsnstr (win y x str n) ¶
-
- Package
- Source
- Function: mvwinsstr (win y x str) ¶
-
- Package
- Source
- Function: mvwvline (win y x ch n) ¶
-
- Package
- Source
- Function: napms (ms) ¶
-
- Package
- Source
- Function: newpad (nlines ncols) ¶
-
- Package
- Source
- Function: newterm (type outfd infd) ¶
-
- Package
- Source
- Function: newwin (nlines ncols begin_y begin_x) ¶
-
- Package
- Source
- Function: nl () ¶
-
- Package
- Source
- Function: nocbreak () ¶
-
- Package
- Source
- Function: nodelay (window bf) ¶
-
- Package
- Source
- Function: noecho () ¶
-
- Package
- Source
- Function: nonl () ¶
-
- Package
- Source
- Function: noqiflush () ¶
-
- Package
- Source
- Function: noraw () ¶
-
- Package
- Source
- Function: notimeout (window bf) ¶
-
- Package
- Source
- Function: overlay (srcwin dstwin) ¶
-
- Package
- Source
- Function: overwrite (srcwin dstwin) ¶
-
- Package
- Source
- Function: pair-content (pair f b) ¶
-
- Package
- Source
- Function: pechochar (pad ch) ¶
-
- Package
- Source
- Function: pnoutrefresh (pad pminrow pmincol sminrow smincol smaxrow smaxcol) ¶
-
- Package
- Source
- Function: prefresh (pad pminrow pmincol sminrow smincol smaxrow smaxcol) ¶
-
- Package
- Source
- Function: qiflush () ¶
-
- Package
- Source
- Function: raw () ¶
-
- Package
- Source
- Function: redrawwin (win) ¶
-
- Package
- Source
- Function: refresh () ¶
-
- Package
- Source
- Function: refresh-window (window) ¶
-
Refresh the display of the window WINDOW.
- Package
- Source
- Function: reset-prog-mode () ¶
-
- Package
- Source
- Function: reset-shell-mode () ¶
-
- Package
- Source
- Function: resetty () ¶
-
- Package
- Source
- Function: resize-term (lines columns) ¶
-
- Package
- Source
- Function: resizeterm (lines columns) ¶
-
- Package
- Source
- Function: savetty () ¶
-
- Package
- Source
- Function: scr-dump (filename) ¶
-
- Package
- Source
- Function: scr-init (filename) ¶
-
- Package
- Source
- Function: scr-restore (filename) ¶
-
- Package
- Source
- Function: scr-set (filename) ¶
-
- Package
- Source
- Function: scrl (n) ¶
-
- Package
- Source
- Function: scroll (win) ¶
-
- Package
- Source
- Function: scrollok (win bf) ¶
-
- Package
- Source
- Function: set-term (new) ¶
-
- Package
- Source
- Function: setscrreg (top bot) ¶
-
- Package
- Source
- Function: slk-attroff (attrs) ¶
-
- Package
- Source
- Function: slk-attron (attrs) ¶
-
- Package
- Source
- Function: slk-attrset (attrs) ¶
-
- Package
- Source
- Function: slk-clear () ¶
-
- Package
- Source
- Function: slk-color (color_pair_number) ¶
-
- Package
- Source
- Function: slk-init (fmt) ¶
-
- Package
- Source
- Function: slk-label (labnum) ¶
-
- Package
- Source
- Function: slk-noutrefresh () ¶
-
- Package
- Source
- Function: slk-refresh () ¶
-
- Package
- Source
- Function: slk-restore () ¶
-
- Package
- Source
- Function: slk-set (labnum label fmt) ¶
-
- Package
- Source
- Function: slk-touch () ¶
-
- Package
- Source
- Function: standard-window () ¶
-
- Package
- Source
- Function: standend () ¶
-
- Package
- Source
- Function: standout () ¶
-
- Package
- Source
- Function: start-color () ¶
-
- Package
- Source
- Function: subpad (orig nlines ncols begin_y begin_x) ¶
-
- Package
- Source
- Function: subwin (orig nlines ncols begin_y begin_x) ¶
-
- Package
- Source
- Function: syncok (win bf) ¶
-
- Package
- Source
- Function: termattrs () ¶
-
- Package
- Source
- Function: termname () ¶
-
- Package
- Source
- Function: tgetflag (id) ¶
-
- Package
- Source
- Function: tgetnum (id) ¶
-
- Package
- Source
- Function: timeout (delay) ¶
-
- Package
- Source
- Function: touchline (win start count) ¶
-
- Package
- Source
- Function: touchwin (win) ¶
-
- Package
- Source
- Function: typeahead (fd) ¶
-
- Package
- Source
- Function: unctrl (c) ¶
-
- Package
- Source
- Function: unget-wch (wch) ¶
-
- Package
- Source
- Function: ungetch (ch) ¶
-
- Package
- Source
- Function: untouchwin (win) ¶
-
- Package
- Source
- Function: use-default-colors () ¶
-
- Package
- Source
- Function: use-env (f) ¶
-
- Package
- Source
- Function: use-extended-names (enable) ¶
-
- Package
- Source
- Function: vline (ch n) ¶
-
- Package
- Source
- Function: waddch (win ch) ¶
-
- Package
- Source
- Function: waddchnstr (win chstr n) ¶
-
- Package
- Source
- Function: waddchstr (win chstr) ¶
-
- Package
- Source
- Function: waddnstr (win str n) ¶
-
- Package
- Source
- Function: waddstr (win str) ¶
-
- Package
- Source
- Function: wattr-get (win attrs pair opts) ¶
-
- Package
- Source
- Function: wattr-off (win attrs opts) ¶
-
- Package
- Source
- Function: wattr-on (win attrs opts) ¶
-
- Package
- Source
- Function: wattr-set (win attrs pair opts) ¶
-
- Package
- Source
- Function: wattroff (win attrs) ¶
-
- Package
- Source
- Function: wattron (win attrs) ¶
-
- Package
- Source
- Function: wattrset (win attrs) ¶
-
- Package
- Source
- Function: wbkgd (win ch) ¶
-
- Package
- Source
- Function: wbkgdset (win ch) ¶
-
- Package
- Source
- Function: wborder (win ls rs ts bs tl tr bl br) ¶
-
- Package
- Source
- Function: wchgat (win n attr color opts) ¶
-
- Package
- Source
- Function: wclear (win) ¶
-
- Package
- Source
- Function: wclrtobot (win) ¶
-
- Package
- Source
- Function: wclrtoeol (win) ¶
-
- Package
- Source
- Function: wcolor-set (win color opts) ¶
-
- Package
- Source
- Function: wcursyncup (win) ¶
-
- Package
- Source
- Function: wdelch (win) ¶
-
- Package
- Source
- Function: wdeleteln (win) ¶
-
- Package
- Source
- Function: wechochar (win ch) ¶
-
- Package
- Source
- Function: wenclose (win y x) ¶
-
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.
- Package
- Source
- Function: werase (win) ¶
-
- Package
- Source
- Function: wget-wch (win) ¶
-
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- Package
- Source
- Function: wgetch (win) ¶
-
- Package
- Source
- Function: wgetnstr (win str n) ¶
-
- Package
- Source
- Function: wgetstr (win str) ¶
-
- Package
- Source
- Function: whline (win ch n) ¶
-
- Package
- Source
- Function: winch (win) ¶
-
- Package
- Source
- Function: winchnstr (win chstr n) ¶
-
- Package
- Source
- Function: winchstr (win chstr) ¶
-
- Package
- Source
- Function: window-dimensions (window) ¶
-
Given a window WINDOW, return its width and height as two values respectively.
- Package
- Source
- Function: winnstr (win str n) ¶
-
- Package
- Source
- Function: winsch (win ch) ¶
-
- Package
- Source
- Function: winsdelln (win n) ¶
-
- Package
- Source
- Function: winsertln (win) ¶
-
- Package
- Source
- Function: winsnstr (win str n) ¶
-
- Package
- Source
- Function: winsstr (win str) ¶
-
- Package
- Source
- Function: winstr (win str) ¶
-
- Package
- Source
- Function: wmove (win y x) ¶
-
- Package
- Source
- Function: wnoutrefresh (win) ¶
-
- Package
- Source
- Function: wredrawln (win beg_line num_lines) ¶
-
- Package
- Source
- Function: wrefresh (win) ¶
-
- Package
- Source
- Function: wresize (win lines columns) ¶
-
- Package
- Source
- Function: write-char-at-cursor (window char) ¶
-
Write the character CHAR to the window WINDOW at the cursor.
- Package
- Source
- Function: write-char-at-point (window char x y) ¶
-
Write the character CHAR to the window WINDOW at the coordinates (X, Y).
- Package
- Source
- Function: write-string-at-cursor (window string) ¶
-
Write the string STRING to the window WINDOW at the cursor.
- Package
- Source
- Function: write-string-at-point (window string x y) ¶
-
Write the string STRING to the window WINDOW at the coordinates (X, Y).
- Package
- Source
- Function: wscrl (win n) ¶
-
- Package
- Source
- Function: wsetscrreg (win top bot) ¶
-
- Package
- Source
- Function: wstandend () ¶
-
- Package
- Source
- Function: wstandout () ¶
-
- Package
- Source
- Function: wsyncdown (win) ¶
-
- Package
- Source
- Function: wsyncup (win) ¶
-
- Package
- Source
- Function: wtimeout (win delay) ¶
-
- Package
- Source
- Function: wtouchln (win y n changed) ¶
-
- Package
- Source
- Function: wvline (win ch n) ¶
-
- Package
- Source
Previous: Ordinary functions, Up: Public Interface [Contents][Index]
6.1.6 Classes
- Class: window ¶
-
A curses window.
- Package
- Source
- Direct methods
- Direct slots
- Slot: pointer ¶
-
Pointer to the underlying representation of a window pointer. (This is of CFFI type ‘CHARMS/LL:WINDOW-PTR’.)
- Initargs
:pointer
- Readers
- Writers
Previous: Public Interface, Up: Definitions [Contents][Index]
6.2 Internals
Next: Symbol macros, Previous: Internals, Up: Internals [Contents][Index]
6.2.1 Special variables
- Special Variable: *input-mode* ¶
-
- Package
- Source
Next: Macros, Previous: Special variables, Up: Internals [Contents][Index]
6.2.2 Symbol macros
- Symbol Macro: *color-paths* ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Symbol macros, Up: Internals [Contents][Index]
6.2.3 Macros
- Macro: check-status (form) ¶
-
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.
- Package
- Source
- Macro: define-exported-cfuns (names return-type &body arguments) ¶
-
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.
- Package
- Source
- Macro: define-exported-constant (name value) ¶
-
- Package
- Source
- Macro: generate-getyx-macro (name yfun xfun values-function-name) ¶
-
- Package
- Source
- Macro: generate-getyx-macros (&rest names) ¶
-
- Package
- Source
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
6.2.4 Ordinary functions
- Function: %check-status (value &key error-message) ¶
-
- Package
- Source
- Function: %getmouse (event) ¶
-
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.
- Package
- Source
- Function: %mousemask (newmask oldmask) ¶
-
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.
- Package
- Source
- Function: %ungetmouse (event) ¶
-
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.
- Package
- Source
- Function: %var-accessor-*color-pairs* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*color-pairs*) () ¶
-
- Package
- Source
- Function: %var-accessor-*color-paths* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*color-paths*) () ¶
-
- Package
- Source
- Function: %var-accessor-*colors* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*colors*) () ¶
-
- Package
- Source
- Function: %var-accessor-*cols* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*cols*) () ¶
-
- Package
- Source
- Function: %var-accessor-*curscr* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*curscr*) () ¶
-
- Package
- Source
- Function: %var-accessor-*escdelay* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*escdelay*) () ¶
-
- Package
- Source
- Function: %var-accessor-*lines* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*lines*) () ¶
-
- Package
- Source
- Function: %var-accessor-*newscr* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*newscr*) () ¶
-
- Package
- Source
- Function: %var-accessor-*stdscr* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*stdscr*) () ¶
-
- Package
- Source
- Function: %var-accessor-*tabsize* () ¶
-
- Package
- Source
- Function: (setf %var-accessor-*tabsize*) () ¶
-
- Package
- Source
- Function: c-char-to-character (c-char) ¶
-
Convert a C character to a Lisp character.
- Package
- Source
- Function: c-get-wch (target) ¶
-
- Package
- Source
- Function: c-mvget-wch (y x target) ¶
-
- Package
- Source
- Function: c-mvwget-wch (win y x target) ¶
-
- Package
- Source
- Function: c-wget-wch (win target) ¶
-
- Package
- Source
- Function: character-to-c-char (character) ¶
-
Convert a Lisp character to a C character.
- Package
- Source
- Function: from-foreign-boolean (value &key relax) ¶
-
Convert the value VALUE to a Lisp boolean. If RELAX is true, then all non-false values are true.
- Package
- Source
- Function: last-position-p (window x y) ¶
-
- Package
- Source
- Function: resolve-window (window-designator) ¶
-
- Package
- Source
- Function: to-foreign-boolean (value) ¶
-
Convert the value VALUE to a foreign bool.
- Package
- Source
- Function: write-char-at-last-position (window char) ¶
-
- Package
- Source
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
6.2.5 Generic functions
Previous: Generic functions, Up: Internals [Contents][Index]
6.2.6 Classes
- Class: mevent-tclass ¶
-
- Package
- Source
- Direct superclasses
- foreign-struct-type.
- translatable-foreign-type.
Previous: Definitions, Up: The cl-charms Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| 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 |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| 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 |
|---|
A.4 Data types
| 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 |
|---|