cl-charms

API Reference

cl-charms

CFFI bindings for curses.

CL-CHARMS/LOW-LEVEL

Package containing the one-to-one bindings to the ncurses library.
  • Cffi-Type SCREEN-PTR
  • Cffi-Type WINDOW-PTR
  • Variable COLOR_BLACK
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_black 0 'eql)
  • Variable COLOR_RED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_red 1 'eql)
  • Variable COLOR_GREEN
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_green 2 'eql)
  • Variable COLOR_YELLOW
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_yellow 3
                                            'eql)
  • Variable COLOR_BLUE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_blue 4 'eql)
  • Variable COLOR_MAGENTA
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_magenta 5
                                            'eql)
  • Variable COLOR_CYAN
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_cyan 6 'eql)
  • Variable COLOR_WHITE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:color_white 7 'eql)
  • Variable TRUE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:true 1 'eql)
  • Variable FALSE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:false 0 'eql)
  • Variable ERR
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:err -1 'eql)
  • Variable OK
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:ok 0 'eql)
  • Variable KEY_BREAK
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_break 257 'eql)
  • Variable KEY_SRESET
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sreset 344
                                            'eql)
  • Variable KEY_RESET
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_reset 345 'eql)
  • Variable KEY_DOWN
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_down 258 'eql)
  • Variable KEY_UP
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_up 259 'eql)
  • Variable KEY_LEFT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_left 260 'eql)
  • Variable KEY_RIGHT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_right 261 'eql)
  • Variable KEY_HOME
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_home 262 'eql)
  • Variable KEY_BACKSPACE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_backspace 263
                                            'eql)
  • Variable KEY_F0
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_f0 264 'eql)
  • Function KEY_FN (n)
  • Variable KEY_DL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_dl 328 'eql)
  • Variable KEY_IL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_il 329 'eql)
  • Variable KEY_DC
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_dc 330 'eql)
  • Variable KEY_IC
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_ic 331 'eql)
  • Variable KEY_EIC
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_eic 332 'eql)
  • Variable KEY_CLEAR
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_clear 333 'eql)
  • Variable KEY_EOS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_eos 334 'eql)
  • Variable KEY_EOL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_eol 335 'eql)
  • Variable KEY_SF
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sf 336 'eql)
  • Variable KEY_SR
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sr 337 'eql)
  • Variable KEY_NPAGE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_npage 338 'eql)
  • Variable KEY_PPAGE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_ppage 339 'eql)
  • Variable KEY_STAB
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_stab 340 'eql)
  • Variable KEY_CTAB
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_ctab 341 'eql)
  • Variable KEY_CATAB
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_catab 342 'eql)
  • Variable KEY_ENTER
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_enter 343 'eql)
  • Variable KEY_PRINT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_print 346 'eql)
  • Variable KEY_LL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_ll 347 'eql)
  • Variable KEY_A1
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_a1 348 'eql)
  • Variable KEY_A3
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_a3 349 'eql)
  • Variable KEY_B2
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_b2 350 'eql)
  • Variable KEY_C1
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_c1 351 'eql)
  • Variable KEY_C3
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_c3 352 'eql)
  • Variable KEY_BTAB
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_btab 353 'eql)
  • Variable KEY_BEG
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_beg 354 'eql)
  • Variable KEY_CANCEL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_cancel 355
                                            'eql)
  • Variable KEY_CLOSE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_close 356 'eql)
  • Variable KEY_COMMAND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_command 357
                                            'eql)
  • Variable KEY_COPY
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_copy 358 'eql)
  • Variable KEY_CREATE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_create 359
                                            'eql)
  • Variable KEY_END
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_end 360 'eql)
  • Variable KEY_EXIT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_exit 361 'eql)
  • Variable KEY_FIND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_find 362 'eql)
  • Variable KEY_HELP
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_help 363 'eql)
  • Variable KEY_MARK
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_mark 364 'eql)
  • Variable KEY_MESSAGE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_message 365
                                            'eql)
  • Variable KEY_MOVE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_move 366 'eql)
  • Variable KEY_NEXT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_next 367 'eql)
  • Variable KEY_OPEN
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_open 368 'eql)
  • Variable KEY_OPTIONS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_options 369
                                            'eql)
  • Variable KEY_PREVIOUS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_previous 370
                                            'eql)
  • Variable KEY_REDO
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_redo 371 'eql)
  • Variable KEY_REFERENCE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_reference 372
                                            'eql)
  • Variable KEY_REFRESH
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_refresh 373
                                            'eql)
  • Variable KEY_REPLACE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_replace 374
                                            'eql)
  • Variable KEY_RESTART
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_restart 375
                                            'eql)
  • Variable KEY_RESUME
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_resume 376
                                            'eql)
  • Variable KEY_SAVE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_save 377 'eql)
  • Variable KEY_SBEG
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sbeg 378 'eql)
  • Variable KEY_SCANCEL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_scancel 379
                                            'eql)
  • Variable KEY_SCOMMAND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_scommand 380
                                            'eql)
  • Variable KEY_SCOPY
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_scopy 381 'eql)
  • Variable KEY_SCREATE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_screate 382
                                            'eql)
  • Variable KEY_SDC
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sdc 383 'eql)
  • Variable KEY_SDL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sdl 384 'eql)
  • Variable KEY_SELECT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_select 385
                                            'eql)
  • Variable KEY_SEND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_send 386 'eql)
  • Variable KEY_SEOL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_seol 387 'eql)
  • Variable KEY_SEXIT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sexit 388 'eql)
  • Variable KEY_SFIND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sfind 389 'eql)
  • Variable KEY_SHELP
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_shelp 390 'eql)
  • Variable KEY_SHOME
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_shome 391 'eql)
  • Variable KEY_SIC
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sic 392 'eql)
  • Variable KEY_SLEFT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sleft 393 'eql)
  • Variable KEY_SMESSAGE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_smessage 394
                                            'eql)
  • Variable KEY_SMOVE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_smove 395 'eql)
  • Variable KEY_SNEXT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_snext 396 'eql)
  • Variable KEY_SOPTIONS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_soptions 397
                                            'eql)
  • Variable KEY_SPREVIOUS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sprevious 398
                                            'eql)
  • Variable KEY_SPRINT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sprint 399
                                            'eql)
  • Variable KEY_SREDO
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sredo 400 'eql)
  • Variable KEY_SREPLACE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sreplace 401
                                            'eql)
  • Variable KEY_SRIGHT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sright 402
                                            'eql)
  • Variable KEY_SRSUME
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_srsume 403
                                            'eql)
  • Variable KEY_SSAVE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_ssave 404 'eql)
  • Variable KEY_SSUSPEND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_ssuspend 405
                                            'eql)
  • Variable KEY_SUNDO
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_sundo 406 'eql)
  • Variable KEY_SUSPEND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_suspend 407
                                            'eql)
  • Variable KEY_UNDO
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_undo 408 'eql)
  • Variable KEY_MOUSE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_mouse 409 'eql)
  • Variable KEY_RESIZE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_resize 410
                                            'eql)
  • Variable KEY_EVENT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:key_event 411 'eql)
  • Variable WA_ATTRIBUTES
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_attributes
                                            4294967040 'eql)
  • Variable WA_NORMAL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_normal 0 'eql)
  • Variable WA_STANDOUT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_standout 65536
                                            'eql)
  • Variable WA_UNDERLINE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_underline
                                            131072 'eql)
  • Variable WA_REVERSE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_reverse 262144
                                            'eql)
  • Variable WA_BLINK
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_blink 524288
                                            'eql)
  • Variable WA_DIM
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_dim 1048576
                                            'eql)
  • Variable WA_BOLD
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_bold 2097152
                                            'eql)
  • Variable WA_ALTCHARSET
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_altcharset
                                            4194304 'eql)
  • Variable WA_INVIS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_invis 8388608
                                            'eql)
  • Variable WA_PROTECT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_protect
                                            16777216 'eql)
  • Variable WA_HORIZONTAL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_horizontal
                                            33554432 'eql)
  • Variable WA_LEFT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_left 67108864
                                            'eql)
  • Variable WA_LOW
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_low 134217728
                                            'eql)
  • Variable WA_RIGHT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_right 268435456
                                            'eql)
  • Variable WA_TOP
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_top 536870912
                                            'eql)
  • Variable WA_VERTICAL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:wa_vertical
                                            1073741824 'eql)
  • Variable A_ATTRIBUTES
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_attributes
                                            4294967040 'eql)
  • Variable A_NORMAL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_normal 0 'eql)
  • Variable A_STANDOUT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_standout 65536
                                            'eql)
  • Variable A_UNDERLINE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_underline 131072
                                            'eql)
  • Variable A_REVERSE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_reverse 262144
                                            'eql)
  • Variable A_BLINK
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_blink 524288
                                            'eql)
  • Variable A_DIM
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_dim 1048576 'eql)
  • Variable A_BOLD
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_bold 2097152
                                            'eql)
  • Variable A_ALTCHARSET
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_altcharset
                                            4194304 'eql)
  • Variable A_INVIS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_invis 8388608
                                            'eql)
  • Variable A_PROTECT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_protect 16777216
                                            'eql)
  • Variable A_HORIZONTAL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_horizontal
                                            33554432 'eql)
  • Variable A_LEFT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_left 67108864
                                            'eql)
  • Variable A_LOW
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_low 134217728
                                            'eql)
  • Variable A_RIGHT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_right 268435456
                                            'eql)
  • Variable A_TOP
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_top 536870912
                                            'eql)
  • Variable A_VERTICAL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:a_vertical
                                            1073741824 'eql)
  • Variable ACS_ULCORNER
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_ulcorner #\l
                                            'eql)
  • Variable ACS_LLCORNER
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_llcorner #\m
                                            'eql)
  • Variable ACS_URCORNER
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_urcorner #\k
                                            'eql)
  • Variable ACS_LRCORNER
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_lrcorner #\j
                                            'eql)
  • Variable ACS_LTEE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_ltee #\t 'eql)
  • Variable ACS_RTEE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_rtee #\u 'eql)
  • Variable ACS_BTEE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_btee #\v 'eql)
  • Variable ACS_TTEE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_ttee #\w 'eql)
  • Variable ACS_HLINE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_hline #\q 'eql)
  • Variable ACS_VLINE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_vline #\x 'eql)
  • Variable ACS_PLUS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_plus #\n 'eql)
  • Variable ACS_S1
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_s1 #\o 'eql)
  • Variable ACS_S9
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_s9 #\s 'eql)
  • Variable ACS_DIAMOND
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_diamond #\`
                                            'eql)
  • Variable ACS_CKBOARD
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_ckboard #\a
                                            'eql)
  • Variable ACS_DEGREE
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_degree #\f
                                            'eql)
  • Variable ACS_PLMINUS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_plminus #\g
                                            'eql)
  • Variable ACS_BULLET
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:acs_bullet #\~
                                            'eql)
  • 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
  • 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
  • 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
  • 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
  • Macro GETYX (win y x)
  • Function GET-YX (win)
  • Macro GETPARYX (win y x)
  • Function GET-PARYX (win)
  • Macro GETMAXYX (win y x)
  • Function GET-MAXYX (win)
  • Macro GETBEGYX (win y x)
  • Function GET-BEGYX (win)
  • Variable BUTTON1_RELEASED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button1_released 1
                                            'eql)
  • Variable BUTTON1_PRESSED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button1_pressed 2
                                            'eql)
  • Variable BUTTON1_CLICKED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button1_clicked 4
                                            'eql)
  • Variable BUTTON1_DOUBLE_CLICKED
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:button1_double_clicked 8 'eql)
  • Variable BUTTON1_TRIPLE_CLICKED
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:button1_triple_clicked 16 'eql)
  • Variable BUTTON2_RELEASED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button2_released
                                            64 'eql)
  • Variable BUTTON2_PRESSED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button2_pressed
                                            128 'eql)
  • Variable BUTTON2_CLICKED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button2_clicked
                                            256 'eql)
  • Variable BUTTON2_DOUBLE_CLICKED
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:button2_double_clicked 512 'eql)
  • Variable BUTTON2_TRIPLE_CLICKED
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:button2_triple_clicked 1024 'eql)
  • Variable BUTTON3_RELEASED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button3_released
                                            4096 'eql)
  • Variable BUTTON3_PRESSED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button3_pressed
                                            8192 'eql)
  • Variable BUTTON3_CLICKED
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button3_clicked
                                            16384 'eql)
  • Variable BUTTON3_DOUBLE_CLICKED
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:button3_double_clicked 32768 'eql)
  • Variable BUTTON3_TRIPLE_CLICKED
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:button3_triple_clicked 65536 'eql)
  • Variable BUTTON_CTRL
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button_ctrl
                                            16777216 'eql)
  • Variable BUTTON_SHIFT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button_shift
                                            33554432 'eql)
  • Variable BUTTON_ALT
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:button_alt
                                            67108864 'eql)
  • Variable ALL_MOUSE_EVENTS
    (alexandria.0.dev::%reevaluate-constant 'cl-charms/low-level:all_mouse_events
                                            134217727 'eql)
  • Variable REPORT_MOUSE_POSITION
    (alexandria.0.dev::%reevaluate-constant
     'cl-charms/low-level:report_mouse_position 134217728 'eql)
  • Function MOUSEMASK (newmask)
    set newmask as mousemask, returning old one
  • Function GETMOUSE

CL-CHARMS

Package containing a high-level interface to ncurses.
  • Class WINDOW
    A curses window.
    POINTER   Accessor: WINDOW-POINTER
    Pointer to the underlying representation of a window pointer. (This is of CFFI type `CHARMS/LL:WINDOW-PTR'.)
  • Variable *STANDARD-WINDOW*
  • Function STANDARD-WINDOW
  • 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.
  • Function DESTROY-WINDOW (window)
    Destroy the window WINDOW.
  • Function COPY-WINDOW (window)
    Copy the window WINDOW.
  • Function WINDOW-DIMENSIONS (window)
    Given a window WINDOW, return its width and height as two values respectively.
  • Function REFRESH-WINDOW (window)
    Refresh the display of the window WINDOW.
  • Function FORCE-REPAINT (window)
    Force the entire window to be cleared and repainted on the next call to `CHARMS:REFRESH-WINDOW'.
  • 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.)
  • Function CLEAR-WINDOW-AFTER-CURSOR (window)
    Clear the rest of the window after the cursor in the window WINDOW.
  • Function CLEAR-LINE-AFTER-CURSOR (window)
    Clear the rest of the line after the cursor in the window WINDOW.
  • Function CHAR-AT-CURSOR (window)
    What is the character at the cursor in the window WINDOW?
  • Function CHAR-AT-POINT (window x y)
    What is the character at the point (X, Y) in the window WINDOW?
  • Function CURSOR-POSITION (window)
    Given a window WINDOW, return its X and Y coordinates as two values respectively.
  • Function MOVE-CURSOR (window x y)
    Move the cursor in window WINDOW to the coordinates (X, Y).
  • Macro WITH-RESTORED-CURSOR (window &body body)
    Execute the body BODY, restoring the cursor position in the window WINDOW to its beginning state.
  • Function MOVE-CURSOR-UP (window &key (amount 1))
    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.
  • Function MOVE-CURSOR-DOWN (window &key (amount 1))
    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.
  • Function MOVE-CURSOR-RIGHT (window &key (amount 1))
    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.
  • Function MOVE-CURSOR-LEFT (window &key (amount 1))
    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.
  • 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.)
  • 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.)
  • Function WRITE-CHAR-AT-CURSOR (window char)
    Write the character CHAR to the window WINDOW at the cursor.
  • Function WRITE-STRING-AT-CURSOR (window string)
    Write the string STRING to the window WINDOW at the cursor.
  • Function WRITE-CHAR-AT-POINT (window char x y)
    Write the character CHAR to the window WINDOW at the coordinates (X, Y).
  • Function WRITE-STRING-AT-POINT (window string x y)
    Write the string STRING to the window WINDOW at the coordinates (X, Y).
  • 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.
  • 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.
  • Function FINALIZE
    Finalize ncurses. This function must be called before exiting. Consider using the macro `CHARMS:WITH-CURSES' to ensure this.
  • 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.
  • Function ENABLE-ECHOING
    Enable the echoing of characters to the screen.
  • Function DISABLE-ECHOING
    Disable the echoing of characters to the screen.
  • Function ENABLE-EXTRA-KEYS (window)
    Enable extra keys, such as arrow and function keys, in the window WINDOW.
  • Function DISABLE-EXTRA-KEYS (window)
    Disable extra keys, such as arrow and function keys, in the window WINDOW.
  • 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.
  • Function DISABLE-RAW-INPUT
    Disables raw input mode. This undoes the action of `CHARMS:ENABLE-RAW-INPUT'.
  • 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).
  • Function DISABLE-NON-BLOCKING-MODE (window)
    Disable non-blocking mode for the window WINDOW. This will cause character input to block.
  • Function BEEP-CONSOLE
    Audibly beep to alert the user.
  • Function FLASH-CONSOLE
    Visually flash the console.
  • Function CURSES-VERSION
    Return a string representing the version of the underlying curses implementation.

cl-charms-paint

A simple ASCII art paint program for cl-charms.

CHARMS-PAINT

  • Function MAIN
    Start the timer program.

cl-charms-timer

Timer example for cl-charms.

CHARMS-TIMER

  • Function MAIN
    Start the timer program.