The croatoan Reference Manual

Table of Contents

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

The croatoan Reference Manual

This is the croatoan Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:39:01 2018 GMT+0.


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

1 Introduction

croatoan is a set of bindings to the ncurses terminal library for
Common Lisp.

It is inspired by, but not derived from, cl-ncurses and cl-charms.

Its main goal is to provide a higher-level, lispy/CLOSy interface,
whereas the existing bindings clone the cryptic C API.

As of now, the library is in an early, but hopefully usable stage. 
Ncurses is old and huge and it will take a while to cover completely.

The API is not yet stable.

It is developed and tested on Ubuntu 16.04 x86_64 and SBCL 1.4.0.

The only supported ncurses version is 6.0 --with-abi-version=6.
Version 5.9 mostly works, but I will focus new efforts on 6.0.

Since many popular distributions ship ncurses --with-abi-version=5,
for full compatibility (wide characters, 256 colors and extended
mouse support), you will have to manually build ncurses 6.0.

The documentation is currently provided by the commented examples.

You are welcome to contribute and any form of help would be greatly
appreciated.


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

2 Systems

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


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

2.1 croatoan

Author

Anton Vidovic <anton.vidovic@gmx.de>

License

MIT

Description

Common Lisp bindings for the ncurses terminal library.

Version

0.0.1

Dependencies
Source

croatoan.asd (file)

Components

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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 croatoan/ncurses

Parent

croatoan (system)

Location

ncurses/

Components

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

3.2 croatoan/source

Dependency

ncurses (module)

Parent

croatoan (system)

Location

source/

Components

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

3.3 croatoan/tests

Dependency

source (module)

Parent

croatoan (system)

Location

tests/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 croatoan.asd

Location

croatoan.asd

Systems

croatoan (system)


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

4.1.2 croatoan/ncurses/package.lisp

Parent

ncurses (module)

Location

ncurses/package.lisp

Packages

de.anvi.ncurses


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

4.1.3 croatoan/ncurses/ncurses.lisp

Parent

ncurses (module)

Location

ncurses/ncurses.lisp

Internal Definitions

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

4.1.4 croatoan/ncurses/addch.lisp

Parent

ncurses (module)

Location

ncurses/addch.lisp

Exported Definitions

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

4.1.5 croatoan/ncurses/add_wch.lisp

Parent

ncurses (module)

Location

ncurses/add_wch.lisp

Exported Definitions

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

4.1.6 croatoan/ncurses/addstr.lisp

Parent

ncurses (module)

Location

ncurses/addstr.lisp

Exported Definitions

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

4.1.7 croatoan/ncurses/attr.lisp

Parent

ncurses (module)

Location

ncurses/attr.lisp

Exported Definitions

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

4.1.8 croatoan/ncurses/beep.lisp

Parent

ncurses (module)

Location

ncurses/beep.lisp

Exported Definitions

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

4.1.9 croatoan/ncurses/bkgd.lisp

Parent

ncurses (module)

Location

ncurses/bkgd.lisp

Exported Definitions

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

4.1.10 croatoan/ncurses/bkgrnd.lisp

Parent

ncurses (module)

Location

ncurses/bkgrnd.lisp

Exported Definitions

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

4.1.11 croatoan/ncurses/border.lisp

Parent

ncurses (module)

Location

ncurses/border.lisp

Exported Definitions

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

4.1.12 croatoan/ncurses/border_set.lisp

Parent

ncurses (module)

Location

ncurses/border_set.lisp

Exported Definitions

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

4.1.13 croatoan/ncurses/clear.lisp

Parent

ncurses (module)

Location

ncurses/clear.lisp

Exported Definitions

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

4.1.14 croatoan/ncurses/color.lisp

Parent

ncurses (module)

Location

ncurses/color.lisp

Exported Definitions

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

4.1.15 croatoan/ncurses/default_colors.lisp

Parent

ncurses (module)

Location

ncurses/default_colors.lisp

Exported Definitions

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

4.1.16 croatoan/ncurses/define_key.lisp

Parent

ncurses (module)

Location

ncurses/define_key.lisp

Exported Definitions

%define-key (function)


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

4.1.17 croatoan/ncurses/delch.lisp

Parent

ncurses (module)

Location

ncurses/delch.lisp

Exported Definitions

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

4.1.18 croatoan/ncurses/deleteln.lisp

Parent

ncurses (module)

Location

ncurses/deleteln.lisp

Exported Definitions

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

4.1.19 croatoan/ncurses/extend.lisp

Parent

ncurses (module)

Location

ncurses/extend.lisp

Exported Definitions

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

4.1.20 croatoan/ncurses/getch.lisp

Parent

ncurses (module)

Location

ncurses/getch.lisp

Exported Definitions

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

4.1.21 croatoan/ncurses/get_wch.lisp

Parent

ncurses (module)

Location

ncurses/get_wch.lisp

Exported Definitions

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

4.1.22 croatoan/ncurses/getcchar.lisp

Parent

ncurses (module)

Location

ncurses/getcchar.lisp

Exported Definitions

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

4.1.23 croatoan/ncurses/getstr.lisp

Parent

ncurses (module)

Location

ncurses/getstr.lisp

Exported Definitions

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

4.1.24 croatoan/ncurses/getyx.lisp

Parent

ncurses (module)

Location

ncurses/getyx.lisp


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

4.1.25 croatoan/ncurses/inch.lisp

Parent

ncurses (module)

Location

ncurses/inch.lisp

Exported Definitions

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

4.1.26 croatoan/ncurses/in_wch.lisp

Parent

ncurses (module)

Location

ncurses/in_wch.lisp

Exported Definitions

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

4.1.27 croatoan/ncurses/insch.lisp

Parent

ncurses (module)

Location

ncurses/insch.lisp

Exported Definitions

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

4.1.28 croatoan/ncurses/ins_wch.lisp

Parent

ncurses (module)

Location

ncurses/ins_wch.lisp

Exported Definitions

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

4.1.29 croatoan/ncurses/instr.lisp

Parent

ncurses (module)

Location

ncurses/instr.lisp

Exported Definitions

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

4.1.30 croatoan/ncurses/inwstr.lisp

Parent

ncurses (module)

Location

ncurses/inwstr.lisp

Exported Definitions

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

4.1.31 croatoan/ncurses/inchstr.lisp

Parent

ncurses (module)

Location

ncurses/inchstr.lisp

Exported Definitions

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

4.1.32 croatoan/ncurses/insstr.lisp

Parent

ncurses (module)

Location

ncurses/insstr.lisp

Exported Definitions

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

4.1.33 croatoan/ncurses/initscr.lisp

Parent

ncurses (module)

Location

ncurses/initscr.lisp

Exported Definitions

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

4.1.34 croatoan/ncurses/inopts.lisp

Parent

ncurses (module)

Location

ncurses/inopts.lisp

Exported Definitions

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

4.1.35 croatoan/ncurses/kernel.lisp

Parent

ncurses (module)

Location

ncurses/kernel.lisp

Exported Definitions

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

4.1.36 croatoan/ncurses/keybound.lisp

Parent

ncurses (module)

Location

ncurses/keybound.lisp

Exported Definitions

%keybound (function)


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

4.1.37 croatoan/ncurses/key_defined.lisp

Parent

ncurses (module)

Location

ncurses/key_defined.lisp

Exported Definitions

%key-defined (function)


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

4.1.38 croatoan/ncurses/legacy.lisp

Parent

ncurses (module)

Location

ncurses/legacy.lisp

Exported Definitions

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

4.1.39 croatoan/ncurses/legacy_coding.lisp

Parent

ncurses (module)

Location

ncurses/legacy_coding.lisp

Exported Definitions

%use-legacy-coding (function)


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

4.1.40 croatoan/ncurses/mouse.lisp

Parent

ncurses (module)

Location

ncurses/mouse.lisp

Exported Definitions
Internal Definitions

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

4.1.41 croatoan/ncurses/move.lisp

Parent

ncurses (module)

Location

ncurses/move.lisp

Exported Definitions

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

4.1.42 croatoan/ncurses/opaque.lisp

Parent

ncurses (module)

Location

ncurses/opaque.lisp

Exported Definitions

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

4.1.43 croatoan/ncurses/outopts.lisp

Parent

ncurses (module)

Location

ncurses/outopts.lisp

Exported Definitions

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

4.1.44 croatoan/ncurses/pad.lisp

Parent

ncurses (module)

Location

ncurses/pad.lisp

Exported Definitions

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

4.1.45 croatoan/ncurses/refresh.lisp

Parent

ncurses (module)

Location

ncurses/refresh.lisp

Exported Definitions

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

4.1.46 croatoan/ncurses/resizeterm.lisp

Parent

ncurses (module)

Location

ncurses/resizeterm.lisp

Exported Definitions

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

4.1.47 croatoan/ncurses/scroll.lisp

Parent

ncurses (module)

Location

ncurses/scroll.lisp

Exported Definitions

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

4.1.48 croatoan/ncurses/slk.lisp

Parent

ncurses (module)

Location

ncurses/slk.lisp

Exported Definitions

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

4.1.49 croatoan/ncurses/termattrs.lisp

Parent

ncurses (module)

Location

ncurses/termattrs.lisp

Exported Definitions

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

4.1.50 croatoan/ncurses/touch.lisp

Parent

ncurses (module)

Location

ncurses/touch.lisp

Exported Definitions

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

4.1.51 croatoan/ncurses/util.lisp

Parent

ncurses (module)

Location

ncurses/util.lisp

Exported Definitions
Internal Definitions

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

4.1.52 croatoan/ncurses/variables.lisp

Parent

ncurses (module)

Location

ncurses/variables.lisp

Exported Definitions
Internal Definitions

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

4.1.53 croatoan/ncurses/window.lisp

Parent

ncurses (module)

Location

ncurses/window.lisp

Exported Definitions

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

4.1.54 croatoan/ncurses/wresize.lisp

Parent

ncurses (module)

Location

ncurses/wresize.lisp

Exported Definitions

%wresize (function)


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

4.1.55 croatoan/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

de.anvi.croatoan


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

4.1.56 croatoan/source/croatoan.lisp

Parent

source (module)

Location

source/croatoan.lisp

Exported Definitions

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

4.1.57 croatoan/source/classes.lisp

Parent

source (module)

Location

source/classes.lisp

Exported Definitions
Internal Definitions

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

4.1.58 croatoan/source/gray_streams.lisp

Parent

source (module)

Location

source/gray_streams.lisp


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

4.1.59 croatoan/source/utf8.lisp

Parent

source (module)

Location

source/utf8.lisp

Internal Definitions

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

4.1.60 croatoan/source/addch.lisp

Parent

source (module)

Location

source/addch.lisp

Exported Definitions
Internal Definitions

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

4.1.61 croatoan/source/add_wch.lisp

Parent

source (module)

Location

source/add_wch.lisp

Exported Definitions
Internal Definitions

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

4.1.62 croatoan/source/addstr.lisp

Parent

source (module)

Location

source/addstr.lisp

Exported Definitions

add-string (function)


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

4.1.63 croatoan/source/attr.lisp

Parent

source (module)

Location

source/attr.lisp

Exported Definitions
Internal Definitions

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

4.1.64 croatoan/source/beep.lisp

Parent

source (module)

Location

source/beep.lisp

Exported Definitions

alert (function)


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

4.1.65 croatoan/source/bkgd.lisp

Parent

source (module)

Location

source/bkgd.lisp

Internal Definitions

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

4.1.66 croatoan/source/bkgrnd.lisp

Parent

source (module)

Location

source/bkgrnd.lisp

Internal Definitions

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

4.1.67 croatoan/source/border.lisp

Parent

source (module)

Location

source/border.lisp

Exported Definitions

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

4.1.68 croatoan/source/border_set.lisp

Parent

source (module)

Location

source/border_set.lisp

Exported Definitions

draw-wide-border (function)


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

4.1.69 croatoan/source/clear.lisp

Parent

source (module)

Location

source/clear.lisp

Exported Definitions

clear (function)


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

4.1.70 croatoan/source/color.lisp

Parent

source (module)

Location

source/color.lisp

Internal Definitions

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

4.1.71 croatoan/source/delch.lisp

Parent

source (module)

Location

source/delch.lisp

Exported Definitions

delete-char (function)


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

4.1.72 croatoan/source/deleteln.lisp

Parent

source (module)

Location

source/deleteln.lisp

Exported Definitions

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

4.1.73 croatoan/source/getch.lisp

Parent

source (module)

Location

source/getch.lisp

Exported Definitions
Internal Definitions

*key-alist* (special variable)


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

4.1.74 croatoan/source/get_wch.lisp

Parent

source (module)

Location

source/get_wch.lisp

Exported Definitions

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

4.1.75 croatoan/source/getstr.lisp

Parent

source (module)

Location

source/getstr.lisp

Exported Definitions

get-string (function)


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

4.1.76 croatoan/source/initscr.lisp

Parent

source (module)

Location

source/initscr.lisp

Exported Definitions

end-screen (function)

Internal Definitions

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

4.1.77 croatoan/source/inopts.lisp

Parent

source (module)

Location

source/inopts.lisp

Internal Definitions

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

4.1.78 croatoan/source/inch.lisp

Parent

source (module)

Location

source/inch.lisp

Exported Definitions

extract-char (function)


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

4.1.79 croatoan/source/in_wch.lisp

Parent

source (module)

Location

source/in_wch.lisp

Exported Definitions

extract-wide-char (function)


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

4.1.80 croatoan/source/inwstr.lisp

Parent

source (module)

Location

source/inwstr.lisp

Exported Definitions

extract-wide-string (function)


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

4.1.81 croatoan/source/inchstr.lisp

Parent

source (module)

Location

source/inchstr.lisp

Exported Definitions

extract-complex-string (function)


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

4.1.82 croatoan/source/insch.lisp

Parent

source (module)

Location

source/insch.lisp

Exported Definitions

insert-char (function)


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

4.1.83 croatoan/source/ins_wch.lisp

Parent

source (module)

Location

source/ins_wch.lisp

Exported Definitions

insert-wide-char (function)


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

4.1.84 croatoan/source/insstr.lisp

Parent

source (module)

Location

source/insstr.lisp

Exported Definitions

insert-string (function)


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

4.1.85 croatoan/source/instr.lisp

Parent

source (module)

Location

source/instr.lisp

Exported Definitions

extract-string (function)


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

4.1.86 croatoan/source/kernel.lisp

Parent

source (module)

Location

source/kernel.lisp

Internal Definitions

set-cursor-visibility (function)


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

4.1.87 croatoan/source/mouse.lisp

Parent

source (module)

Location

source/mouse.lisp

Exported Definitions
Internal Definitions

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

4.1.88 croatoan/source/move.lisp

Parent

source (module)

Location

source/move.lisp

Exported Definitions

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

4.1.89 croatoan/source/panel.lisp

Parent

source (module)

Location

source/panel.lisp

Exported Definitions
Internal Definitions

rotate (function)


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

4.1.90 croatoan/source/refresh.lisp

Parent

source (module)

Location

source/refresh.lisp

Exported Definitions

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

4.1.91 croatoan/source/touch.lisp

Parent

source (module)

Location

source/touch.lisp

Exported Definitions

touch (function)


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

4.1.92 croatoan/source/wresize.lisp

Parent

source (module)

Location

source/wresize.lisp

Exported Definitions

resize (function)


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

4.1.93 croatoan/source/form.lisp

Parent

source (module)

Location

source/form.lisp

Exported Definitions

edit (function)

Internal Definitions

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

4.1.94 croatoan/source/menu.lisp

Parent

source (module)

Location

source/menu.lisp

Exported Definitions
Internal Definitions

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

4.1.95 croatoan/tests/package.lisp

Parent

tests (module)

Location

tests/package.lisp

Packages

de.anvi.croatoan.tests


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

4.1.96 croatoan/tests/ncurses.lisp

Parent

tests (module)

Location

tests/ncurses.lisp

Exported Definitions

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

4.1.97 croatoan/tests/unicode.lisp

Parent

tests (module)

Location

tests/unicode.lisp

Exported Definitions

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

4.1.98 croatoan/tests/clos.lisp

Parent

tests (module)

Location

tests/clos.lisp

Exported Definitions
Internal Definitions

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

4.1.99 croatoan/tests/evolution.lisp

Parent

tests (module)

Location

tests/evolution.lisp

Exported Definitions

evolve5 (function)

Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 de.anvi.ncurses

Low-level CFFI bindings to the Ncurses C API. Not meant to be used directly.

Source

package.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

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

5.2 de.anvi.croatoan

High-level Lisp interface to the basic CFFI Ncurses API.

Source

package.lisp (file)

Nickname

croatoan

Use List
Used By List

de.anvi.croatoan.tests

Exported Definitions
Internal Definitions

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

5.3 de.anvi.croatoan.tests

Tests and examples demonstrating the use of the Croatoan API.

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Constants

Constant: %color_black
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_blue
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_cyan
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_green
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_magenta
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_red
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_white
Package

de.anvi.ncurses

Source

color.lisp (file)

Constant: %color_yellow
Package

de.anvi.ncurses

Source

color.lisp (file)


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

6.1.2 Special variables

Special Variable: *ansi-color-list*
Package

de.anvi.croatoan

Source

attr.lisp (file)


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

6.1.3 Symbol macros

Symbol Macro: %color-pairs
Package

de.anvi.ncurses

Source

variables.lisp (file)

Expansion

(de.anvi.ncurses::%var-accessor-%color-pairs)

Symbol Macro: %colors
Package

de.anvi.ncurses

Source

variables.lisp (file)

Expansion

(de.anvi.ncurses::%var-accessor-%colors)

Symbol Macro: %cols
Package

de.anvi.ncurses

Source

variables.lisp (file)

Expansion

(de.anvi.ncurses::%var-accessor-%cols)

Symbol Macro: %escdelay
Package

de.anvi.ncurses

Source

variables.lisp (file)

Expansion

(de.anvi.ncurses::%var-accessor-%escdelay)

Symbol Macro: %lines
Package

de.anvi.ncurses

Source

variables.lisp (file)

Expansion

(de.anvi.ncurses::%var-accessor-%lines)

Symbol Macro: %tabsize
Package

de.anvi.ncurses

Source

variables.lisp (file)

Expansion

(de.anvi.ncurses::%var-accessor-%tabsize)


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

6.1.4 Macros

Macro: event-case (WINDOW EVENT &optional MOUSE-Y MOUSE-X) &body BODY

Window event loop, events are handled by an implicit case form.

For now, it is limited to events generated in a single window. So events from multiple windows have to be handled separately.

In order for event-handling to work, input-reading has to be unbuffered.

If input-blocking is nil, we can handle the (nil) event, i.e. what happens between key presses.

If input-blocking is t, the (nil) event is never returned.

The main window event loop name is hard coded to event-case to be used with return-from.

Instead of ((nil) nil), which eats 100% CPU, use input-blocking t.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: save-excursion WINDOW &body BODY

After executing body, return the cursor in window to its initial position.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: with-screen (SCREEN &key INPUT-READING INPUT-BLOCKING INPUT-ECHOING ENABLE-FKEYS ENABLE-COLORS USE-DEFAULT-COLORS CURSOR-VISIBILITY STACKED) &body BODY

Create a screen, evaluate the forms in the body, then cleanly close the screen.

Pass any arguments to the initialisation of the screen object. The screen
is cleared immediately after initialisation.

This macro is the main entry point for writing ncurses programs with the croatoan library. Do not run more than one screen at the same time.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: with-window (WIN &rest OPTIONS) &body BODY

Create a window, evaluate the forms in the body, then cleanly close the window.

Pass any arguments to the initialisation of the window object.

Example:

(with-window (win :input-echoing t
body)

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: with-windows BINDINGS &body BODY

Create one or more windows, evaluate the forms in the body, then cleanly close the windows.

Pass any arguments to the initialisation of the window objects.

Example:

(with-windows ((win1 :input-echoing t)
(win2 :input-echoing t))
body)

Package

de.anvi.croatoan

Source

croatoan.lisp (file)


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

6.1.5 Functions

Function: %add-wch WCH
Package

de.anvi.ncurses

Source

add_wch.lisp (file)

Function: %addch CH
Package

de.anvi.ncurses

Source

addch.lisp (file)

Function: %addnstr STR N
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %addstr STR
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %assume-default-colors FG BG
Package

de.anvi.ncurses

Source

default_colors.lisp (file)

Function: %attr-get ATTRS PAIR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %attr-off ATTRS OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %attr-on ATTRS OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %attr-set ATTRS PAIR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %attroff ATTRS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %attron ATTRS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %attrset ATTRS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %baudrate ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %beep ()
Package

de.anvi.ncurses

Source

beep.lisp (file)

Function: %bkgd CH
Package

de.anvi.ncurses

Source

bkgd.lisp (file)

Function: %bkgdset CH
Package

de.anvi.ncurses

Source

bkgd.lisp (file)

Function: %bkgrnd WCH
Package

de.anvi.ncurses

Source

bkgrnd.lisp (file)

Function: %bkgrndset WCH
Package

de.anvi.ncurses

Source

bkgrnd.lisp (file)

Function: %border LS RS TS BS TL TR BL BR
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %border-set LS RS TS BS TL TR BL BR
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %box WIN VERCH HORCH
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %box-set WIN VERCH HORCH
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %can-change-color ()
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %cbreak ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %chgat N ATTR COLOR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %clear ()
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %clearok WIN BF
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %clrtobot ()
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %clrtoeol ()
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %color-content COLOR R G B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %color-extended-content COLOR R G B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %color-pair N
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %color-set COLOR-PAIR-NUMBER OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %curs-set VISIBILITY
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %curses-version ()
Package

de.anvi.ncurses

Source

extend.lisp (file)

Function: %def-prog-mode ()
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %def-shell-mode ()
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %define-key DEFINITION KEYCODE
Package

de.anvi.ncurses

Source

define_key.lisp (file)

Function: %delay-output MS
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %delch ()
Package

de.anvi.ncurses

Source

delch.lisp (file)

Function: %deleteln ()
Package

de.anvi.ncurses

Source

deleteln.lisp (file)

Function: %delscreen SP
Package

de.anvi.ncurses

Source

initscr.lisp (file)

Function: %delwin WIN
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %derwin ORIG NLINES NCOLS BEGIN_Y BEGIN_X
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %doupdate ()
Package

de.anvi.ncurses

Source

refresh.lisp (file)

Function: %dupwin WIN
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %echo ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %echo-wchar WCH
Package

de.anvi.ncurses

Source

add_wch.lisp (file)

Function: %echochar CH
Package

de.anvi.ncurses

Source

addch.lisp (file)

Function: %endwin ()
Package

de.anvi.ncurses

Source

initscr.lisp (file)

Function: %erase ()
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %erasechar ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %filter ()
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %flash ()
Package

de.anvi.ncurses

Source

beep.lisp (file)

Function: %flushinp ()
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %get-wch WCH
Package

de.anvi.ncurses

Source

get_wch.lisp (file)

Function: %getbegx WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getbegy WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getbkgd WIN
Package

de.anvi.ncurses

Source

bkgd.lisp (file)

Function: %getbkgrnd WCH
Package

de.anvi.ncurses

Source

bkgrnd.lisp (file)

Function: %getcchar WCVAL WCH ATTRS COLOR_PAIR OPTS
Package

de.anvi.ncurses

Source

getcchar.lisp (file)

Function: %getch ()
Package

de.anvi.ncurses

Source

getch.lisp (file)

Function: %getcurx WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getcury WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getmaxx WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getmaxy WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getmouse EVENT
Package

de.anvi.ncurses

Source

mouse.lisp (file)

Function: %getnstr STR N
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %getparx WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getpary WIN
Package

de.anvi.ncurses

Source

legacy.lisp (file)

Function: %getstr STR
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %getsyx Y X
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %getwin FILEP
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %halfdelay TENTHS
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %has-colors ()
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %has-ic ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %has-il ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %has-key CH
Package

de.anvi.ncurses

Source

getch.lisp (file)

Function: %hline CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %hline-set WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %idcok WIN BF
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %idlok WIN BF
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %immedok WIN BF
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %in-wch WCVAL
Package

de.anvi.ncurses

Source

in_wch.lisp (file)

Function: %inch ()
Package

de.anvi.ncurses

Source

inch.lisp (file)

Function: %inchnstr CHSTR N
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %inchstr CHSTR
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %init-color COLOR R G B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %init-extended-color COLOR R G B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %init-extended-pair PAIR F B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %init-pair PAIR F B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %initscr ()
Package

de.anvi.ncurses

Source

initscr.lisp (file)

Function: %innstr STR N
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %innwstr STR N
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %ins-wch WCH
Package

de.anvi.ncurses

Source

ins_wch.lisp (file)

Function: %insch CH
Package

de.anvi.ncurses

Source

insch.lisp (file)

Function: %insdelln N
Package

de.anvi.ncurses

Source

deleteln.lisp (file)

Function: %insertln ()
Package

de.anvi.ncurses

Source

deleteln.lisp (file)

Function: %insnstr STR N
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %insstr STR
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %instr STR
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %intrflush WIN BF
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %inwstr STR
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %is-cleared WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-idcok WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-idlok WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-immedok WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-keypad WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-leaveok WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-linetouched WIN LINE
Package

de.anvi.ncurses

Source

touch.lisp (file)

Function: %is-nodelay WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-notimeout WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-pad WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-scrollok WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-subwin WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-syncok WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %is-term-resized LINES COLUMNS
Package

de.anvi.ncurses

Source

resizeterm.lisp (file)

Function: %is-wintouched WIN
Package

de.anvi.ncurses

Source

touch.lisp (file)

Function: %isendwin ()
Package

de.anvi.ncurses

Source

initscr.lisp (file)

Function: %key-defined DEFINITION
Package

de.anvi.ncurses

Source

key_defined.lisp (file)

Function: %keybound KEYCODE COUNT
Package

de.anvi.ncurses

Source

keybound.lisp (file)

Function: %keyname C
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %keypad WIN BF
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %killchar ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %leaveok WIN BF
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %longname ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %meta WIN BF
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %mousemask NEWMASK OLDMASK
Package

de.anvi.ncurses

Source

mouse.lisp (file)

Function: %move Y X
Package

de.anvi.ncurses

Source

move.lisp (file)

Function: %mvadd-wch Y X WCH
Package

de.anvi.ncurses

Source

add_wch.lisp (file)

Function: %mvaddch Y X CH
Package

de.anvi.ncurses

Source

addch.lisp (file)

Function: %mvaddnstr Y X STR N
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %mvaddstr Y X STR
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %mvchgat Y X N ATTR COLOR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %mvdelch Y X
Package

de.anvi.ncurses

Source

delch.lisp (file)

Function: %mvderwin WIN PAR_Y PAR_X
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %mvget-wch Y X WCH
Package

de.anvi.ncurses

Source

get_wch.lisp (file)

Function: %mvgetch Y X
Package

de.anvi.ncurses

Source

getch.lisp (file)

Function: %mvgetnstr Y X STR N
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %mvgetstr Y X STR
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %mvhline Y X CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %mvhline-set Y X WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %mvin-wch Y X WCVAL
Package

de.anvi.ncurses

Source

in_wch.lisp (file)

Function: %mvinch Y X
Package

de.anvi.ncurses

Source

inch.lisp (file)

Function: %mvinchnstr Y X CHSTR N
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %mvinchstr Y X CHSTR
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %mvinnstr Y X STR N
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %mvinnwstr Y X STR N
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %mvins-wch Y X WCH
Package

de.anvi.ncurses

Source

ins_wch.lisp (file)

Function: %mvinsch Y X CH
Package

de.anvi.ncurses

Source

insch.lisp (file)

Function: %mvinsnstr Y X STR N
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %mvinsstr Y X STR
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %mvinstr Y X STR
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %mvinwstr Y X STR
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %mvvline Y X CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %mvvline-set Y X WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %mvwadd-wch WIN Y X WCH
Package

de.anvi.ncurses

Source

add_wch.lisp (file)

Function: %mvwaddch WIN Y X CH
Package

de.anvi.ncurses

Source

addch.lisp (file)

Function: %mvwaddnstr WIN Y X STR N
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %mvwaddstr WIN Y X STR
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %mvwchgat WIN Y X N ATTR COLOR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %mvwdelch WIN Y X
Package

de.anvi.ncurses

Source

delch.lisp (file)

Function: %mvwget-wch WIN Y X WCH
Package

de.anvi.ncurses

Source

get_wch.lisp (file)

Function: %mvwgetch WIN Y X
Package

de.anvi.ncurses

Source

getch.lisp (file)

Function: %mvwgetnstr WIN Y X STR N
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %mvwgetstr WIN Y X STR
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %mvwhline WIN Y X CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %mvwhline-set WIN Y X WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %mvwin WIN Y X
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %mvwin-wch WIN Y X WCVAL
Package

de.anvi.ncurses

Source

in_wch.lisp (file)

Function: %mvwinch WIN Y X
Package

de.anvi.ncurses

Source

inch.lisp (file)

Function: %mvwinchnstr WIN Y X CHSTR N
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %mvwinchstr WIN Y X CHSTR
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %mvwinnstr WIN Y X STR N
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %mvwinnwstr WIN Y X STR N
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %mvwins-wch WIN Y X WCH
Package

de.anvi.ncurses

Source

ins_wch.lisp (file)

Function: %mvwinsch WIN Y X CH
Package

de.anvi.ncurses

Source

insch.lisp (file)

Function: %mvwinsnstr WIN Y X STR N
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %mvwinsstr WIN Y X STR
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %mvwinstr WIN Y X STR
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %mvwinwstr WIN Y X STR
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %mvwvline WIN Y X CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %mvwvline-set WIN Y X WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %napms MS
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %newpad NLINES NCOLS
Package

de.anvi.ncurses

Source

pad.lisp (file)

Function: %newterm TYPE OUTFD INFD
Package

de.anvi.ncurses

Source

initscr.lisp (file)

Function: %newwin NLINES NCOLS BEGIN_Y BEGIN_X
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %nl ()
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %nocbreak ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %nodelay WIN BF
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %noecho ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %nofilter ()
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %nonl ()
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %noqiflush ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %noraw ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %notimeout WIN BF
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %pair-content PAIR F B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %pair-extended-content PAIR F B
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %pair-number ATTRS
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %pecho-wchar PAD WCH
Package

de.anvi.ncurses

Source

pad.lisp (file)

Function: %pechochar PAD CH
Package

de.anvi.ncurses

Source

pad.lisp (file)

Function: %pnoutrefresh PAD PMINROW PMINCOL SMINROW SMINCOL SMAXROW SMAXCOL
Package

de.anvi.ncurses

Source

pad.lisp (file)

Function: %prefresh PAD PMINROW PMINCOL SMINROW SMINCOL SMAXROW SMAXCOL
Package

de.anvi.ncurses

Source

pad.lisp (file)

Function: %putwin WIN FILEP
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %qiflush ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %raw ()
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %redrawwin WIN
Package

de.anvi.ncurses

Source

refresh.lisp (file)

Function: %refresh ()
Package

de.anvi.ncurses

Source

refresh.lisp (file)

Function: %reset-prog-mode ()
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %reset-shell-mode ()
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %resetty ()
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %resize-term LINES COLUMNS
Package

de.anvi.ncurses

Source

resizeterm.lisp (file)

Function: %resizeterm LINES COLUMNS
Package

de.anvi.ncurses

Source

resizeterm.lisp (file)

Function: %ripoffline LINE INIT
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %savetty ()
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %scrl N
Package

de.anvi.ncurses

Source

scroll.lisp (file)

Function: %scroll WIN
Package

de.anvi.ncurses

Source

scroll.lisp (file)

Function: %scrollok WIN BF
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %set-term NEW
Package

de.anvi.ncurses

Source

initscr.lisp (file)

Function: %setcchar WCVAL WCH ATTRS COLOR_PAIR OPTS
Package

de.anvi.ncurses

Source

getcchar.lisp (file)

Function: %setscrreg TOP BOT
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %setsyx Y X
Package

de.anvi.ncurses

Source

kernel.lisp (file)

Function: %slk-attr ()
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-attr-off ATTRS OPTS
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-attr-on ATTRS OPTS
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-attr-set ATTRS COLOR-PAIR OPTS
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-attroff ATTRS
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-attron ATTRS
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-attrset ATTRS
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-clear ()
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-color COLOR-PAIR
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-init FMT
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-label LABNUM
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-noutrefresh ()
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-refresh ()
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-restore ()
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-set LABNUM LABEL FMT
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %slk-touch ()
Package

de.anvi.ncurses

Source

slk.lisp (file)

Function: %standend ()
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %standout ()
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %start-color ()
Package

de.anvi.ncurses

Source

color.lisp (file)

Function: %subpad ORIG NLINES NCOLS BEGIN_Y BEGIN_X
Package

de.anvi.ncurses

Source

pad.lisp (file)

Function: %subwin ORIG NLINES NCOLS BEGIN_Y BEGIN_X
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %syncok WIN BF
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %term-attrs ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %termattrs ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %termname ()
Package

de.anvi.ncurses

Source

termattrs.lisp (file)

Function: %timeout DELAY
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %touchline WIN START COUNT
Package

de.anvi.ncurses

Source

touch.lisp (file)

Function: %touchwin WIN
Package

de.anvi.ncurses

Source

touch.lisp (file)

Function: %typeahead FD
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %unctrl C
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %unget-wch WCH
Package

de.anvi.ncurses

Source

get_wch.lisp (file)

Function: %ungetch CH
Package

de.anvi.ncurses

Source

getch.lisp (file)

Function: %untouchwin WIN
Package

de.anvi.ncurses

Source

touch.lisp (file)

Function: %use-default-colors ()
Package

de.anvi.ncurses

Source

default_colors.lisp (file)

Function: %use-env F
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %use-extended-names ENABLE
Package

de.anvi.ncurses

Source

extend.lisp (file)

Function: %use-legacy-coding LEVEL
Package

de.anvi.ncurses

Source

legacy_coding.lisp (file)

Function: %vline CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %vline-set WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %wadd-wch WIN WCH
Package

de.anvi.ncurses

Source

add_wch.lisp (file)

Function: %waddch WIN CH
Package

de.anvi.ncurses

Source

addch.lisp (file)

Function: %waddnstr WIN STR N
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %waddstr WIN STR
Package

de.anvi.ncurses

Source

addstr.lisp (file)

Function: %wattr-get WIN ATTRS PAIR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wattr-off WIN ATTRS OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wattr-on WIN ATTRS OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wattr-set WIN ATTRS PAIR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wattroff WIN ATTRS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wattron WIN ATTRS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wattrset WIN ATTRS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wbkgd WIN CH
Package

de.anvi.ncurses

Source

bkgd.lisp (file)

Function: %wbkgdset WIN CH
Package

de.anvi.ncurses

Source

bkgd.lisp (file)

Function: %wbkgrnd WIN WCH
Package

de.anvi.ncurses

Source

bkgrnd.lisp (file)

Function: %wbkgrndset WIN WCH
Package

de.anvi.ncurses

Source

bkgrnd.lisp (file)

Function: %wborder WIN LS RS TS BS TL TR BL BR
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %wborder-set WIN LS RS TS BS TL TR BL BR
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %wchgat WIN N ATTR COLOR OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wclear WIN
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %wclrtobot WIN
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %wclrtoeol WIN
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %wcolor-set WIN COLOR-PAIR-NUMBER OPTS
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wcursyncup WIN
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %wdelch WIN
Package

de.anvi.ncurses

Source

delch.lisp (file)

Function: %wdeleteln WIN
Package

de.anvi.ncurses

Source

deleteln.lisp (file)

Function: %wecho-wchar WIN WCH
Package

de.anvi.ncurses

Source

add_wch.lisp (file)

Function: %wechochar WIN CH
Package

de.anvi.ncurses

Source

addch.lisp (file)

Function: %werase WIN
Package

de.anvi.ncurses

Source

clear.lisp (file)

Function: %wget-wch WIN WCH
Package

de.anvi.ncurses

Source

get_wch.lisp (file)

Function: %wgetbkgrnd WIN WCH
Package

de.anvi.ncurses

Source

bkgrnd.lisp (file)

Function: %wgetch WIN
Package

de.anvi.ncurses

Source

getch.lisp (file)

Function: %wgetnstr WIN STR N
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %wgetparent WIN
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %wgetscrreg WIN TOP BOTTOM
Package

de.anvi.ncurses

Source

opaque.lisp (file)

Function: %wgetstr WIN STR
Package

de.anvi.ncurses

Source

getstr.lisp (file)

Function: %whline WIN CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %whline-set WIN WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: %win-wch WIN WCVAL
Package

de.anvi.ncurses

Source

in_wch.lisp (file)

Function: %winch WIN
Package

de.anvi.ncurses

Source

inch.lisp (file)

Function: %winchnstr WIN CHSTR N
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %winchstr WIN CHSTR
Package

de.anvi.ncurses

Source

inchstr.lisp (file)

Function: %winnstr WIN STR N
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %winnwstr WIN STR N
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %wins-wch WIN WCH
Package

de.anvi.ncurses

Source

ins_wch.lisp (file)

Function: %winsch WIN CH
Package

de.anvi.ncurses

Source

insch.lisp (file)

Function: %winsdelln WIN N
Package

de.anvi.ncurses

Source

deleteln.lisp (file)

Function: %winsertln WIN
Package

de.anvi.ncurses

Source

deleteln.lisp (file)

Function: %winsnstr WIN STR N
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %winsstr WIN STR
Package

de.anvi.ncurses

Source

insstr.lisp (file)

Function: %winstr WIN STR
Package

de.anvi.ncurses

Source

instr.lisp (file)

Function: %winwstr WIN STR
Package

de.anvi.ncurses

Source

inwstr.lisp (file)

Function: %wmove WIN Y X
Package

de.anvi.ncurses

Source

move.lisp (file)

Function: %wnoutrefresh WIN
Package

de.anvi.ncurses

Source

refresh.lisp (file)

Function: %wredrawln WIN BEG-LINE NUM-LINES
Package

de.anvi.ncurses

Source

refresh.lisp (file)

Function: %wrefresh WIN
Package

de.anvi.ncurses

Source

refresh.lisp (file)

Function: %wresize WIN LINES COLUMNS
Package

de.anvi.ncurses

Source

wresize.lisp (file)

Function: %wscrl WIN N
Package

de.anvi.ncurses

Source

scroll.lisp (file)

Function: %wsetscrreg WIN TOP BOT
Package

de.anvi.ncurses

Source

outopts.lisp (file)

Function: %wstandend WIN
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wstandout WIN
Package

de.anvi.ncurses

Source

attr.lisp (file)

Function: %wsyncdown WIN
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %wsyncup WIN
Package

de.anvi.ncurses

Source

window.lisp (file)

Function: %wtimeout WIN DELAY
Package

de.anvi.ncurses

Source

inopts.lisp (file)

Function: %wtouchln WIN Y N CHANGED
Package

de.anvi.ncurses

Source

touch.lisp (file)

Function: %wvline WIN CH N
Package

de.anvi.ncurses

Source

border.lisp (file)

Function: %wvline-set WIN WCH N
Package

de.anvi.ncurses

Source

border_set.lisp (file)

Function: acs CHAR-NAME

Take a symbol, return the integer representing the acs char.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: add WINDOW OBJECT &key ATTRIBUTES COLOR-PAIR Y X N

Add the object (char or string) to the window, then advance the cursor.

If the destination coordinates y (row) and x (column) are given, move the cursor to the destination first and then add the object (char or string).

If n is given for a char, write n chars. If n is -1, as many chars will be added as will fit on the line.

If n is given for a string, write at most n chars from the string. If n is -1, as many chars will be added as will fit on the line.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: add-attributes WIN ATTRIBUTES

Takes a list of keywords and turns the appropriate attributes on.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: add-char WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X N

Add the char to the window, then advance the cursor.

If the destination coordinates y and x are given, move the cursor to the destination first and then add the character.

If n is given, write n chars. If n is -1, as many chars will be added as will fit on the line.

Example: (add-char scr #a :attributes ’(:bold) :color-pair ’(:red :yellow))

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: add-string WINDOW STRING &key ATTRIBUTES COLOR-PAIR Y X N

Add the unrendered string to the window.

If n is given, write at most n chars from the string. If n is -1, as many chars will be added that will fit on the line.

If the coordinates y and x are given, move to the destination first and then add the string.

Package

de.anvi.croatoan

Source

addstr.lisp (file)

Function: add-wide-char WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X N

Add the wide (multi-byte) char to the window, then advance the cursor.

If the destination coordinates y and x are given, move the cursor to the destination first and then add the character.

If n is given, write n chars. If n is -1, as many chars will be added as will fit on the line.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: add-wide-char-utf-8 WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X N

Add the wide (multi-byte) char to the window, then advance the cursor.

If the destination coordinates y and x are given, move the cursor to the destination first and then add the character.

If n is given, write n chars. If n is -1, as many chars will be added as will fit on the line.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: alert &optional TYPE
Package

de.anvi.croatoan

Source

beep.lisp (file)

Function: box WINDOW &optional HLINE-CHAR VLINE-CHAR

Draw a border around the window.

If any parameter is nil or zero, the default ACS char will be used.

Package

de.anvi.croatoan

Source

border.lisp (file)

Function: change-attributes WIN N ATTRIBUTES &key COLOR-PAIR Y X

Change the attributes of n chars starting at the current cursor position.

If n is -1, as many chars will be added as will fit on the line.

If the destination coordinates y and x are given, the attributes are changed from the given point without moving the cursor position.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: clear WINDOW &key REDRAW TARGET

Clear the window by overwriting it with blanks.

If the keyword redraw is t, first copy blanks to every position in the window, then set the clear-redraw-flag to have the window redrawn from scratch on the next refresh.

If target is :end-of-line, clear the window from the cursor to the end of the current line.

If target is :bottom, clear the window from the cursor to the end of the current line and all lines below.

Package

de.anvi.croatoan

Source

clear.lisp (file)

Function: current-item MENU

Return the currently selected item of the given menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: delete-char WINDOW &key Y X

Delete the character under the cursor.

All characters to the right of the cursor on the same line are moved to the left one position and the last character on the line is filled with a blank. The cursor position does not change after moving
to (y,x), if specified.

Package

de.anvi.croatoan

Source

delch.lisp (file)

Function: delete-line WINDOW &key N

Delete n lines starting with the one under the cursor.

The remaining lines are moved up. The bottom n lines are cleared.

The current cursor position does not change.

Package

de.anvi.croatoan

Source

deleteln.lisp (file)

Function: draw-border WINDOW &key LEFT RIGHT TOP BOTTOM TOP-LEFT TOP-RIGHT BOTTOM-LEFT BOTTOM-RIGHT

Draw a border around the window using single-byte line-drawing characters.

If no border chars are given, the default ncurses ACS chars will be used.

Package

de.anvi.croatoan

Source

border.lisp (file)

Function: draw-wide-border WINDOW &key LEFT RIGHT TOP BOTTOM TOP-LEFT TOP-RIGHT BOTTOM-LEFT BOTTOM-RIGHT

Draw a border around the window using (wide) unicode line-drawing characters.

If no border chars are given, the default ncurses WACS chars will be used.

Package

de.anvi.croatoan

Source

border_set.lisp (file)

Function: echo WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X

Add one rendered character to the window, then refresh the window.

If the destination coordinates Y and X are given, move to the destination first and then echo the character.

The only difference to add-char and a subsequent refresh is a performance gain if we know that we only need to output a single character.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: echo-wide-char WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X

Add one rendered character to the window, then refresh the window.

If the destination coordinates Y and X are given, move to the destination first and then echo the character.

The only difference to add-wide-char and a subsequent refresh is a performance gain if we know that we only need to output a single character.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: edit WIN FIELD

Let the user edit the field, then return the contents.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: empty-stack ()

Remove all windows from the stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: end-screen ()

Clean shutdown of the curses display.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Function: evolve5 ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: extract-char WINDOW &key Y X

Extract and return the single-byte complex char from the window.

If the destination coordinates y and x are given, move the cursor there first.

Package

de.anvi.croatoan

Source

inch.lisp (file)

Function: extract-complex-string WINDOW &key Y X N

Extract and return a complex string from the window.

Start at the current cursor position and end at the right margin of window.

If n is given explicitely, read at most n chars.

If the destination coordinates y and x are given, move the cursor first.

Package

de.anvi.croatoan

Source

inchstr.lisp (file)

Function: extract-string WINDOW &key Y X N

Extract and return a string from window.

Any attributes are stripped from the characters before the string is returned.

Start at the current cursor position and end at the right margin of window. If n is given, read at most n chars.

If the destination coordinates y and x are given, move the cursor to the destination first.

Package

de.anvi.croatoan

Source

instr.lisp (file)

Function: extract-wide-char WINDOW &key Y X

Extract and return a single wide (complex) character from the window.

This includes wide characters (code > 255), and requires the ncursesw library.

If the destination coordinates y and x are given, move the cursor first.

Package

de.anvi.croatoan

Source

in_wch.lisp (file)

Function: extract-wide-string WINDOW &key Y X N

Extract and return a string from window.

Any attributes are stripped from the characters before the string is returned.

Start at the current cursor position and end at the right margin of window.

If n is given explicitely, read at most n chars.

If the destination coordinates y and x are given, move the cursor
to the destination first.

Package

de.anvi.croatoan

Source

inwstr.lisp (file)

Function: function-key NUMBER
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: function-key-p NUMBER
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-char WINDOW &key Y X

Read in a C char (single byte) from the keyboard and return it.

If the destination coordinates y (row) and x (column) are given, move the cursor to the destination first and then read a single byte.

The window from which the char is read is automatically refreshed.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-event WINDOW
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-mouse-event ()
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: get-string WINDOW N &key Y X

Read a string from the keyboard and return it.

Reading is performed until a newline or carriage return is received. The terminating character is not included in the returned string.

If n is given, read at most n chars, to prevent a possible input buffer overflow.

If the destination coordinates y and x are given, move the cursor there first.

Package

de.anvi.croatoan

Source

getstr.lisp (file)

Function: get-wide-char WINDOW &key Y X

Read in a wide C wchar_t (multi-byte) from the keyboard and return it.

If the destination coordinates y (row) and x (column) are given, move the cursor to the destination first and then read a multi-byte char.

The window from which the char is read is automatically refreshed.

Package

de.anvi.croatoan

Source

get_wch.lisp (file)

Function: get-wide-event WINDOW

Return a single user input event.

An event can be a lisp character or a keyword representing a function or mouse key.

If input-blocking is nil for the window, return nil if no key was typed.

Package

de.anvi.croatoan

Source

get_wch.lisp (file)

Function: insert-char WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X

Insert char into window before the character currently under the cursor.

Chars right of the cursor are moved one position to the right.
The rightmost character on the line may be lost. The position of the cursor is not changed.

If the destination coordinates y and x are given, move the cursor there first.

Package

de.anvi.croatoan

Source

insch.lisp (file)

Function: insert-line WINDOW &key N

Insert n lines above the current line.

The current line and the lines below are moved down. The n bottom lines are lost.

The current cursor position does not change.

Package

de.anvi.croatoan

Source

deleteln.lisp (file)

Function: insert-string WINDOW STRING &key Y X N

Insert string at the current position in window.

Chars right of the cursor are moved to the right. The rightmost chars on the line may be lost. The cursor position is not changed.

If n is given, insert n chars. If (<= n 0) insert the whole string.

If the destination coordinates y and x are given, move the cursor there first.

Package

de.anvi.croatoan

Source

insstr.lisp (file)

Function: insert-wide-char WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X N

Insert char into window before the character currently under the cursor.

Chars right of the cursor are moved one position to the right.
The rightmost character on the line may be lost. The position of the cursor is not changed.

If the destination coordinates y and x are given, move the cursor there first.

If n is given, insert n chars.

Package

de.anvi.croatoan

Source

ins_wch.lisp (file)

Function: key-pressed-p WINDOW
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: key-supported-p KEY-CHAR
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: lower WIN

Lower window one position in the stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: lower-to-bottom WIN

Lower window to the bottom of the window stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: mark-for-redraw WINDOW &key FIRST-LINE NO-OF-LINES

Mark a whole window or a number of lines to be completely redrawn on the next refresh.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: mark-for-refresh WIN &optional PAD-MIN-Y PAD-MIN-X SCREEN-MIN-Y SCREEN-MIN-X SCREEN-MAX-Y SCREEN-MAX-X

Mark a window for a later batch-refresh.

Copy a window to the virtual screen, but do not display it on the visible physical screen. Call batch-refresh to display all marked refreshes.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: matrix ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: move WINDOW Y X &key RELATIVE

Move cursor to row y and column x.

If relative is t, move the cursor by y rows and x columns.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: move-to WINDOW DIRECTION &optional N

Move cursor in the given direction by n cells.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: move-window WINDOW Y X &key RELATIVE

Move top left corner of the window to row y and column x.

If relative is t, move the window by y rows and x columns.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: nctest ()
Package

de.anvi.croatoan.tests

Source

ncurses.lisp (file)

Function: nctest2 ()
Package

de.anvi.croatoan.tests

Source

ncurses.lisp (file)

Function: nctest3 ()
Package

de.anvi.croatoan.tests

Source

ncurses.lisp (file)

Function: nctest4 ()

Test low-level cchar_t reading and writing.

The output is:

a rendered cchar_t
97 code of character #a
1 color pair 1
00020100 attribute underline #x00020000 OR-ed with bit-shifted color pair 1

We see that the attr_t slot contains _both_ the attribute _and_ the bit-shifted color pair, as if it were a chtype in ABI5.

When ABI6 is used, the separate color-pair slot contains the same color pair number.

The goal is obviously to make the cchar_t usable under both ABI5 and ABI6.

Package

de.anvi.croatoan.tests

Source

ncurses.lisp (file)

Function: new-line WINDOW &optional COUNT

Insert count newline characters into window.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: pipes ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: raise WIN

Raise window one position in the stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: raise-to-top WIN

Raise window to the top of the window stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: refresh WIN &optional PAD-MIN-Y PAD-MIN-X SCREEN-MIN-Y SCREEN-MIN-X SCREEN-MAX-Y SCREEN-MAX-X

Redisplay the window after changes have been made to it.

Copies a window to the virtual screen, then updates the visible physical screen by the contents of the virtual screen.

Only updates the changed parts of the window. In order to redraw the whole window, it has to be explicitely touched or marked for redraw.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: refresh-marked ()

Refresh windows marked for refresh.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: refresh-stack ()

Touch and refresh visible windows in the window stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: remove-attributes WIN ATTRIBUTES

Takes a list of keywords and turns the appropriate attributes off.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: resize WINDOW HEIGHT WIDTH
Package

de.anvi.croatoan

Source

wresize.lisp (file)

Function: select-item MENU

Display a menu, let the user select an item, return the selected item.

If the item is itself a menu, recursively display the sub menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: set-mouse-event KEYWORD-LIST

Take a list of mouse events, activate tracking of those events.

Returns an integer bitmask. An empty list turns off mouse tracking.

Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: snake ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t00 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t01 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t02 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03a2 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03b2 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03b3 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03c ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03d ()

Read and display wide (multi-byte) characters until q is pressed.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t03d2 ()

Use gray stream functions to read and display wide (multi-byte) characters until q is pressed.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t04 &optional NAME
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t04a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t04b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t05 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t06 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t06a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t07 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t07a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t08 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t08a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t08b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t08c ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t09 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t09a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t09b ()

Use with-screen, event-case and mapc to simplify t09a.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t09c ()

Use a window stack to manage overlapping windows.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t10 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t10a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t11 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t12 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t12a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t12b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t12c ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t12c2 ()

ACS chars not available on all terminals: thick and double line drawing characters.

Tested with xterm, gnome-terminal, st. Doesn’t work in the linux console, aterm, eterm.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t12d ()

Print all graphic alternative chars supported by the non-wide acs_map[128] array.

Only the chars 33 to 126 are graphic, and not all are accessible through the keywords provided by ncurses, and the supported chars are terminal dependent.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t13 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t14 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t14a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t14b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t14c ()

Print all mouse events.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t15 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t15a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t15b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t16 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t16a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t16b ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t16c ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t16d ()

Use an input buffer instead of extracting the string from the window. Create windows using the with-windows macro.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t17 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t17a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t18 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t18a ()

Display misc quicklisp information.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19a ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19b ()

Use the menu class, draw-menu and select-item functions.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19c ()

Improved t19b, the menu can be called repeatedly with the key a.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19c2 ()

Test the menu-item class for submenus.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19d ()

Use the arrow keys to pick a value from an 2D array menu, given as a layout parameter.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19e ()

A one-line menu without a title and border resembling a menu bar.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19f ()

A more fancy version of t19a, a yes-no dialog using the class dialog-window.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t19g ()

A checkbox dialog.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t20 ()

Display a randomly created carpet of the seven default colors, except for black.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t20a ()

Display the 256 supported colors. This only works with TERM=xterm-256color in xterm and gnome-terminal.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t21 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t22 ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t23 ()

Use save-excursion to return the cursor to its initial position.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t24 ()

Test usage of insert-line and delete-line.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t25 ()

Test initialisation and refreshing of pads and sub-pads.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: t26 ()

Test accessors of window and cursor positions.

Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: tetris ()
Package

de.anvi.croatoan.tests

Source

clos.lisp (file)

Function: touch WINDOW

Make the next call to refresh rewrite whe whole window by marking the whole window as changed.

Makes it possible to raise unchanged overlapping windows by refreshing.

Package

de.anvi.croatoan

Source

touch.lisp (file)

Function: unget-char CHTYPE
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: update-menu MENU EVENT

Take a menu and an event, update in-place the current item of the menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: ut01 ()
Package

de.anvi.croatoan.tests

Source

unicode.lisp (file)

Function: ut02 ()
Package

de.anvi.croatoan.tests

Source

unicode.lisp (file)

Function: ut02b ()
Package

de.anvi.croatoan.tests

Source

unicode.lisp (file)

Function: ut03 ()
Package

de.anvi.croatoan.tests

Source

unicode.lisp (file)

Function: ut04 ()
Package

de.anvi.croatoan.tests

Source

unicode.lisp (file)

Function: wacs CHAR-NAME

Take a keyword symbol, return the wide unicode integer representing the ACS char.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)


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

6.1.6 Generic functions

Generic Function: .attributes OBJECT
Generic Function: (setf .attributes) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .attributes (WINDOW window)
Method: (setf .attributes) ATTRIBUTES (WIN window)
Source

classes.lisp (file)

Method: .attributes (COMPLEX-CHAR complex-char)
Method: (setf .attributes) NEW-VALUE (COMPLEX-CHAR complex-char)

List of keywords denoting attributes.

Source

classes.lisp (file)

Generic Function: .background WINDOW
Generic Function: (setf .background) CHAR WINDOW &optional APPLY
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .background (WIN window)
Method: (setf .background) CHAR (WINDOW window) &optional APPLY
Generic Function: .border OBJECT
Package

de.anvi.croatoan

Methods
Method: .border (WINDOW window)

Enable (t) or disable (nil, default) an initial border around a window.

Source

classes.lisp (file)

Generic Function: .buffer OBJECT
Generic Function: (setf .buffer) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .buffer (FIELD field)
Method: (setf .buffer) NEW-VALUE (FIELD field)

List containing the characters in the field.

Source

classes.lisp (file)

Generic Function: .checklist OBJECT
Generic Function: (setf .checklist) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .checklist (MENU-WINDOW menu-window)
Method: (setf .checklist) NEW-VALUE (MENU-WINDOW menu-window)

List holding information about which items have been checked in a checklist menu or dialog. Is created during object initialization.

Source

classes.lisp (file)

Generic Function: .closed-p S

Check whether the screen has been closed, without a subsequent call to refresh to reactivate it.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .closed-p (S screen)
Generic Function: .color-pair OBJECT
Generic Function: (setf .color-pair) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .color-pair (WINDOW window)
Method: (setf .color-pair) COLOR-PAIR (WINDOW window)
Source

classes.lisp (file)

Method: .color-pair (COMPLEX-CHAR complex-char)
Method: (setf .color-pair) NEW-VALUE (COMPLEX-CHAR complex-char)

Two element list of keywords denoting a foreground and background color of the char.

Source

classes.lisp (file)

Generic Function: .complex-char-array OBJECT
Generic Function: (setf .complex-char-array) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .complex-char-array (COMPLEX-STRING complex-string)
Method: (setf .complex-char-array) NEW-VALUE (COMPLEX-STRING complex-string)

Lisp primitive string type.

Source

classes.lisp (file)

Generic Function: .current-item-mark OBJECT
Package

de.anvi.croatoan

Methods
Method: .current-item-mark (MENU-WINDOW menu-window)

A string prefixed to the current item in the menu.

Source

classes.lisp (file)

Generic Function: .current-item-number OBJECT
Generic Function: (setf .current-item-number) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .current-item-number (MENU-WINDOW menu-window)
Method: (setf .current-item-number) NEW-VALUE (MENU-WINDOW menu-window)

Number of the currently selected item.

Source

classes.lisp (file)

Generic Function: .cursor-position WINDOW
Generic Function: (setf .cursor-position) COORDINATES WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .cursor-position (WINDOW window)
Method: (setf .cursor-position) COORDINATES (W window)
Generic Function: .cursor-position-x WINDOW
Generic Function: (setf .cursor-position-x) X WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .cursor-position-x (WIN window)
Method: (setf .cursor-position-x) X (WIN window)
Generic Function: .cursor-position-y WINDOW
Generic Function: (setf .cursor-position-y) Y WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .cursor-position-y (WIN window)
Method: (setf .cursor-position-y) Y (WIN window)
Generic Function: .cursor-visibility WINDOW
Generic Function: (setf .cursor-visibility) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .cursor-visibility (SCREEN screen)
Method: (setf .cursor-visibility) STATUS (SCREEN screen)
Generic Function: .cyclic-selection OBJECT
Package

de.anvi.croatoan

Methods
Method: .cyclic-selection (MENU-WINDOW menu-window)

Wrap around when the end of a non-scrolled menu is reached.

Source

classes.lisp (file)

Generic Function: .enable-fkeys WINDOW
Generic Function: (setf .enable-fkeys) STATUS WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .enable-fkeys (WINDOW window)
Method: (setf .enable-fkeys) STATUS (WINDOW window)
Generic Function: .enable-scrolling WINDOW
Generic Function: (setf .enable-scrolling) STATUS WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .enable-scrolling (WINDOW window)
Method: (setf .enable-scrolling) STATUS (WINDOW window)
Generic Function: .fill-pointer OBJECT
Generic Function: (setf .fill-pointer) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .fill-pointer (FIELD field)
Method: (setf .fill-pointer) NEW-VALUE (FIELD field)

The current position in the input buffer to which the next character will be written.

Source

classes.lisp (file)

Generic Function: .height WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Writer

(setf .height) (generic function)

Methods
Method: .height (WINDOW window)
Method: .height (FIELD field)

The height (number of lines) of the field. The default is 1, a single-line field.

Generic Function: (setf .height) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Reader

.height (generic function)

Methods
Method: (setf .height) NEW-VALUE (FIELD field)

The height (number of lines) of the field. The default is 1, a single-line field.

Source

classes.lisp (file)

Generic Function: .input-blocking WINDOW
Generic Function: (setf .input-blocking) STATUS WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .input-blocking (WINDOW window)
Method: (setf .input-blocking) STATUS (WINDOW window)
Generic Function: .input-echoing SCREEN
Generic Function: (setf .input-echoing) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .input-echoing (SCREEN screen)
Method: (setf .input-echoing) STATUS (SCREEN screen)
Generic Function: .input-reading SCREEN
Generic Function: (setf .input-reading) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .input-reading (SCREEN screen)
Method: (setf .input-reading) STATUS (SCREEN screen)
Generic Function: .insert-enabled OBJECT
Generic Function: (setf .insert-enabled) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .insert-enabled (WINDOW window)
Method: (setf .insert-enabled) NEW-VALUE (WINDOW window)

Printing a new char will insert (t) it before the character under the cursor instead of overwriting (nil) it.

Source

classes.lisp (file)

Generic Function: .items OBJECT
Generic Function: (setf .items) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .items (MENU-WINDOW menu-window)
Method: (setf .items) NEW-VALUE (MENU-WINDOW menu-window)

List of menu items. Item types can be strings, symbols, other menus or (not yet implemented) functions.

Source

classes.lisp (file)

Generic Function: .max-item-length OBJECT
Package

de.anvi.croatoan

Methods
Method: .max-item-length (MENU-WINDOW menu-window)

Max number of characters displayed for a single item.

Source

classes.lisp (file)

Generic Function: .message-height OBJECT
Package

de.anvi.croatoan

Methods
Method: .message-height (DIALOG-WINDOW dialog-window)

Max number of lines reserved for the optional message text.

Source

classes.lisp (file)

Generic Function: .message-pad OBJECT
Package

de.anvi.croatoan

Methods
Method: .message-pad (DIALOG-WINDOW dialog-window)

Passive content window, for example for menu descriptions.

Source

classes.lisp (file)

Generic Function: .message-pad-coordinates OBJECT
Package

de.anvi.croatoan

Methods
Method: .message-pad-coordinates (DIALOG-WINDOW dialog-window)

List of four coordinates where to refresh/display the message pad: min-y min-x max-y max-x.

Source

classes.lisp (file)

Generic Function: .message-text OBJECT
Generic Function: (setf .message-text) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .message-text (DIALOG-WINDOW dialog-window)
Method: (setf .message-text) NEW-VALUE (DIALOG-WINDOW dialog-window)

Optional message text to describe the choices in the menu below.

Source

classes.lisp (file)

Generic Function: .name OBJECT
Package

de.anvi.croatoan

Methods
Method: .name (MENU-ITEM menu-item)

Short name of a menu item displayed in the menu.

Source

classes.lisp (file)

Generic Function: .position WINDOW
Generic Function: (setf .position) COORDINATES WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .position (WIN sub-window)
Method: .position (WINDOW window)
Method: (setf .position) COORDINATES (W window)
Method: .position (FIELD field)
Method: (setf .position) NEW-VALUE (FIELD field)

A two-element list (y=row x=column) containing the coordinate of the top left corner of the field.

Generic Function: .position-x WINDOW
Generic Function: (setf .position-x) X WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .position-x (WIN sub-window)
Method: .position-x (WIN window)
Method: (setf .position-x) X (WIN window)
Generic Function: .position-y WINDOW
Generic Function: (setf .position-y) Y WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .position-y (WIN sub-window)
Method: .position-y (WIN window)
Method: (setf .position-y) Y (WIN window)
Generic Function: .scrolling-region WINDOW
Generic Function: (setf .scrolling-region) LIST WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: .scrolling-region (WINDOW window)
Method: (setf .scrolling-region) LIST (WINDOW window)
Generic Function: .simple-char OBJECT
Generic Function: (setf .simple-char) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .simple-char (COMPLEX-CHAR complex-char)
Method: (setf .simple-char) NEW-VALUE (COMPLEX-CHAR complex-char)

Lisp primitive character type, like #a.

Source

classes.lisp (file)

Generic Function: (setf .source) COORDINATES SUB-WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: (setf .source) COORDINATES (W sub-window)
Generic Function: .stacked WIN
Generic Function: (setf .stacked) STACKED WIN
Package

de.anvi.croatoan

Methods
Method: .stacked (WIN window)
Method: (setf .stacked) STACKED (WIN window)
Source

classes.lisp (file)

Generic Function: .sub-window OBJECT
Package

de.anvi.croatoan

Methods
Method: .sub-window (DECORATED-WINDOW decorated-window)

Active content window, for example for menu items.

Source

classes.lisp (file)

Generic Function: .type OBJECT
Generic Function: (setf .type) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .type (MENU-WINDOW menu-window)
Method: (setf .type) NEW-VALUE (MENU-WINDOW menu-window)

Types of menus: :selection (default, can contain strings, symbols, menus) or :checklist.

Source

classes.lisp (file)

Method: .type (MENU-ITEM menu-item)

Keyword describing the type of the item: :string :symbol :menu :function

Source

classes.lisp (file)

Generic Function: .value OBJECT
Package

de.anvi.croatoan

Methods
Method: .value (MENU-ITEM menu-item)

If the item is not a string, it can be a sub menu or (not yet implemented) a function.

Source

classes.lisp (file)

Generic Function: .visible OBJECT
Generic Function: (setf .visible) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: .visible (WINDOW window)
Method: (setf .visible) NEW-VALUE (WINDOW window)

If visible is nil, do not refresh the window when refreshing the window stack.

Source

classes.lisp (file)

Generic Function: .width WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Writer

(setf .width) (generic function)

Methods
Method: .width (WINDOW window)
Method: .width (FIELD field)

The width of the field.

Generic Function: (setf .width) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Reader

.width (generic function)

Methods
Method: (setf .width) NEW-VALUE (FIELD field)

The width of the field.

Source

classes.lisp (file)

Generic Function: .winptr OBJECT
Package

de.anvi.croatoan

Methods
Method: .winptr (WINDOW window)

Pointer to a C/ncurses WINDOW structure after the window is created.

Source

classes.lisp (file)

Generic Function: convert-char CHAR RESULT-TYPE

Take a char and convert it to a char of result-type.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Methods
Method: convert-char (CHAR integer) RESULT-TYPE
Method: convert-char (CHAR character) RESULT-TYPE
Method: convert-char (CHAR complex-char) RESULT-TYPE
Generic Function: draw-menu S

Draw a menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Methods
Method: draw-menu (MENU dialog-window)
Method: draw-menu (MENU menu-window)

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

6.1.7 Classes

Class: complex-char ()

A complex char consists of a simple char, a list of attribute keywords and a pair of color keywords.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: simple-char

Lisp primitive character type, like #a.

Type

(or null integer character keyword)

Initargs

:simple-char

Readers

.simple-char (generic function)

Writers

(setf .simple-char) (generic function)

Slot: attributes

List of keywords denoting attributes.

Type

(or null cons)

Initargs

:attributes

Initform

(quote nil)

Readers

.attributes (generic function)

Writers

(setf .attributes) (generic function)

Slot: color-pair

Two element list of keywords denoting a foreground and background color of the char.

Type

(or null cons)

Initargs

:color-pair

Readers

.color-pair (generic function)

Writers

(setf .color-pair) (generic function)

Class: complex-string ()

A complex string consists of an array of complex characters.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • print-object (method)
  • initialize-instance (method)
  • .complex-char-array (method)
  • .complex-char-array (method)
Direct slots
Slot: complex-char-array

Lisp primitive string type.

Type

vector

Initargs

:complex-char-array

Initform

(make-array 0 :element-type (quote de.anvi.croatoan:complex-char) :fill-pointer 0 :adjustable t)

Readers

.complex-char-array (generic function)

Writers

(setf .complex-char-array) (generic function)

Class: decorated-window ()

A decorated-window is a window consisting of a background window for a border and a content window.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct subclasses
Direct methods
  • close (method)
  • initialize-instance (method)
  • .title (method)
  • .title (method)
  • .sub-window (method)
Direct slots
Slot: sub-window

Active content window, for example for menu items.

Type

(or null de.anvi.croatoan:sub-window)

Initargs

:sub-window

Readers

.sub-window (generic function)

Slot: title

Title of the window displayed over the border.

Type

(or null string)

Initargs

:title

Readers

.title (generic function)

Writers

(setf .title) (generic function)

Class: dialog-window ()

A dialog is a decorated menu with a title, a message and items.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

menu-window (class)

Direct methods
Direct slots
Slot: message-pad

Passive content window, for example for menu descriptions.

Type

(or null de.anvi.croatoan:pad)

Readers

.message-pad (generic function)

Slot: message-text

Optional message text to describe the choices in the menu below.

Type

(or null string)

Initargs

:message-text

Readers

.message-text (generic function)

Writers

(setf .message-text) (generic function)

Slot: message-height

Max number of lines reserved for the optional message text.

Type

integer

Initargs

:message-height

Initform

0

Readers

.message-height (generic function)

Slot: message-pad-coordinates

List of four coordinates where to refresh/display the message pad: min-y min-x max-y max-x.

Type

(or null cons)

Readers

.message-pad-coordinates (generic function)

Class: field ()
Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: position

A two-element list (y=row x=column) containing the coordinate of the top left corner of the field.

Type

(or null cons)

Initargs

:position

Readers

.position (generic function)

Writers

(setf .position) (generic function)

Slot: height

The height (number of lines) of the field. The default is 1, a single-line field.

Type

(or null integer)

Initargs

:height

Initform

1

Readers

.height (generic function)

Writers

(setf .height) (generic function)

Slot: width

The width of the field.

Type

(or null integer)

Initargs

:width

Readers

.width (generic function)

Writers

(setf .width) (generic function)

Slot: buffer

List containing the characters in the field.

Type

(or null list)

Readers

.buffer (generic function)

Writers

(setf .buffer) (generic function)

Slot: fill-pointer

The current position in the input buffer to which the next character will be written.

Type

integer

Initform

0

Readers

.fill-pointer (generic function)

Writers

(setf .fill-pointer) (generic function)

Class: form-window ()
Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

decorated-window (class)

Direct methods
Direct slots
Slot: fields

List of fields.

Type

(or null cons)

Initargs

:fields

Readers

.fields (generic function)

Writers

(setf .fields) (generic function)

Slot: current-field-number

Number of the currently selected field.

Type

integer

Initform

0

Readers

.current-field-number (generic function)

Writers

(setf .current-field-number) (generic function)

Class: menu-item ()

A menu consists of a list of menut items.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name

Short name of a menu item displayed in the menu.

Type

(or null string)

Initargs

:name

Readers

.name (generic function)

Slot: type

Keyword describing the type of the item: :string :symbol :menu :function

Type

(or null keyword)

Initargs

:type

Readers

.type (generic function)

Slot: value

If the item is not a string, it can be a sub menu or (not yet implemented) a function.

Type

(or string de.anvi.croatoan:menu-window function)

Initargs

:value

Readers

.value (generic function)

Class: menu-window ()

A menu is a window providing a list of items to be selected by the user.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

decorated-window (class)

Direct subclasses

dialog-window (class)

Direct methods
Direct slots
Slot: items

List of menu items. Item types can be strings, symbols, other menus or (not yet implemented) functions.

Type

(or null cons)

Initargs

:items

Readers

.items (generic function)

Writers

(setf .items) (generic function)

Slot: checklist

List holding information about which items have been checked in a checklist menu or dialog. Is created during object initialization.

Type

(or null cons)

Readers

.checklist (generic function)

Writers

(setf .checklist) (generic function)

Slot: type

Types of menus: :selection (default, can contain strings, symbols, menus) or :checklist.

Type

keyword

Initargs

:type

Initform

:selection

Readers

.type (generic function)

Writers

(setf .type) (generic function)

Slot: current-item-number

Number of the currently selected item.

Type

integer

Initform

0

Readers

.current-item-number (generic function)

Writers

(setf .current-item-number) (generic function)

Slot: current-item-mark

A string prefixed to the current item in the menu.

Type

string

Initargs

:current-item-mark

Initform

""

Readers

.current-item-mark (generic function)

Slot: cyclic-selection

Wrap around when the end of a non-scrolled menu is reached.

Type

boolean

Initargs

:cyclic-selection

Readers

.cyclic-selection (generic function)

Slot: max-item-length

Max number of characters displayed for a single item.

Type

integer

Initargs

:max-item-length

Initform

15

Readers

.max-item-length (generic function)

Slot: layout

Layout (no-of-rows no-of-columns) of the items in the menu. If nil, we have a vertical list.

Type

(or null cons)

Initargs

:layout

Readers

.layout (generic function)

Writers

(setf .layout) (generic function)

Slot: scrolled-layout

Layout (no-of-rows no-of-columns) of the menu items actually displayed on screen.

Type

(or null cons)

Initargs

:scrolled-layout

Readers

.scrolled-layout (generic function)

Writers

(setf .scrolled-layout) (generic function)

Slot: scrolled-region-start

A 2-element list tracking the starting row/y and column/x of the displayed menu region.

Type

(or null cons)

Initform

(list 0 0)

Readers

.scrolled-region-start (generic function)

Writers

(setf .scrolled-region-start) (generic function)

Class: pad ()

A pad is a window without a specified position on screen, which is specified dynamically during refresh.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct subclasses

sub-pad (class)

Direct methods

initialize-instance (method)

Class: screen ()

Represents the main window created upon screen initialisation.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct methods
Direct slots
Slot: enable-colors

Enable (t) or disable (nil) display of colors, if the terminal supports it.

Type

boolean

Initargs

:enable-colors

Slot: use-default-colors

Use (t) the default colors of the terminal, instead of the ncurses default white on black.

Type

boolean

Initargs

:use-default-colors

Slot: cursor-visibility

Enable (t) or disable (nil) displaying a visible cursor.

Type

boolean

Initargs

:cursor-visibility

Initform

t

Slot: input-echoing

Enable (t) or disable (nil) echoing of chars during keyboard input.

Type

boolean

Initargs

:input-echoing

Initform

t

Slot: input-reading

Set whether typed characters will be line :buffered or directly passed as :unbuffered or :unbuffered-raw.

Type

keyword

Initargs

:input-reading

Initform

:unbuffered

Slot: closed-p

Check whether the screen has been closed, without a subsequent call to refresh to reactivate it.

Type

boolean

Class: sub-pad ()

A sub-pad shares the memory and the display with a parent pad and has to be contained within it.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

pad (class)

Direct methods

initialize-instance (method)

Direct slots
Slot: parent

The parent pad which will contain the sub-pad.

Type

(or null de.anvi.croatoan:pad)

Initargs

:parent

Class: sub-window ()

A sub-window shares the memory and the display with and has to be contained within a parent window.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct methods
Direct slots
Slot: parent

The parent window which will contain the sub-window.

Type

(or null de.anvi.croatoan:window)

Initargs

:parent

Slot: relative

The position of the sub-window is relative to the parent window (t) or to the screen (nil, default).

Type

boolean

Initargs

:relative

Slot: source

Position (y x) of the area of the parent window, which is mapped to the subwindow. By default it is identical to the position of the subwindow.

Type

(or null cons)

Initargs

:source

Class: window ()

A curses window object as returned by newwin.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses
  • fundamental-character-output-stream (class)
  • fundamental-character-input-stream (class)
Direct subclasses
Direct methods
Direct slots
Slot: position

The (y=row x=column) coordinate of the top left corner of the window.

Type

cons

Initargs

:position

Initform

(quote (0 0))

Slot: width

The width (second, horizontal, x dimension) of the window.

Type

(or null integer)

Initargs

:width

Slot: height

The height (first, vertical, y dimension) of the window.

Type

(or null integer)

Initargs

:height

Slot: cursor-position

The current cursor position coordinates in the form (y x).

Type

cons

Slot: input-blocking

Input mode: blocking (t), non-blocking (nil) or blocking duration in (positive integer) miliseconds.

Type

(or boolean integer)

Initargs

:input-blocking

Initform

t

Slot: enable-fkeys

Enable (t) or disable (nil) support for function keys.

Type

boolean

Initargs

:enable-fkeys

Slot: enable-scrolling

Enable (t) or disable (nil) support for window scrolling.

Type

boolean

Initargs

:enable-scrolling

Slot: scrolling-region

When scrolling is enabled, only scroll the window region from line y1 to y2 given as the list (y1 y2).

Type

(or null cons)

Initargs

:scrolling-region

Slot: insert-enabled

Printing a new char will insert (t) it before the character under the cursor instead of overwriting (nil) it.

Type

boolean

Initargs

:insert-enabled

Readers

.insert-enabled (generic function)

Writers

(setf .insert-enabled) (generic function)

Slot: background

Sets a complex char as the background of the window. It does not change the colors or attributes of existing complex chars. A newline sets the background till the end of the line.

Type

(or null de.anvi.croatoan:complex-char)

Initargs

:background

Slot: attributes

A list of keywords denoting attributes of new characters added to a window.

Type

(or null cons)

Initargs

:attributes

Slot: color-pair

A two element list of keywords denoting the foreground and background color of new characters added to a window.

Type

(or null cons)

Initargs

:color-pair

Slot: border

Enable (t) or disable (nil, default) an initial border around a window.

Type

boolean

Initargs

:border

Readers

.border (generic function)

Slot: stacked

If stacked is t, the window is added to the global window stack, so overlapping windows can be refreshed in the stacking order.

Type

boolean

Initargs

:stacked

Slot: visible

If visible is nil, do not refresh the window when refreshing the window stack.

Type

boolean

Initargs

:visible

Initform

t

Readers

.visible (generic function)

Writers

(setf .visible) (generic function)

Slot: winptr

Pointer to a C/ncurses WINDOW structure after the window is created.

Readers

.winptr (generic function)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *animals*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *bitmask-alist*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *color-pair-alist*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *height*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *jungle*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *key-alist*
Package

de.anvi.croatoan

Source

getch.lisp (file)

Special Variable: *mouse-button-event-bitmask-alist*
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Special Variable: *mouse-event-bitmask-alist*
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Special Variable: *plant-energy*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *plants*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *reproduction-energy*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *valid-attributes*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *width*
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Special Variable: *window-stack*
Package

de.anvi.croatoan

Source

classes.lisp (file)

Special Variable: *xterm-color-hex-list*
Package

de.anvi.croatoan

Source

color.lisp (file)

Special Variable: *xterm-color-name-list*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: acs-alist
Package

de.anvi.croatoan

Source

addch.lisp (file)

Special Variable: acs-map-array
Package

de.anvi.croatoan

Source

addch.lisp (file)

Special Variable: wide-acs-alist
Package

de.anvi.croatoan

Source

add_wch.lisp (file)


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

6.2.2 Macros

Macro: mouse-bitmask BUTTON EVENT
Package

de.anvi.croatoan

Source

mouse.lisp (file)


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

6.2.3 Functions

Function: %has-mouse ()
Package

de.anvi.ncurses

Source

mouse.lisp (file)

Function: %key_name W
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: %ungetmouse EVENT
Package

de.anvi.ncurses

Source

mouse.lisp (file)

Function: %var-accessor-%color-pairs ()
Function: (setf %var-accessor-%color-pairs) VALUE
Package

de.anvi.ncurses

Source

variables.lisp (file)

Function: %var-accessor-%colors ()
Function: (setf %var-accessor-%colors) VALUE
Package

de.anvi.ncurses

Source

variables.lisp (file)

Function: %var-accessor-%cols ()
Function: (setf %var-accessor-%cols) VALUE
Package

de.anvi.ncurses

Source

variables.lisp (file)

Function: %var-accessor-%escdelay ()
Function: (setf %var-accessor-%escdelay) VALUE
Package

de.anvi.ncurses

Source

variables.lisp (file)

Function: %var-accessor-%lines ()
Function: (setf %var-accessor-%lines) VALUE
Package

de.anvi.ncurses

Source

variables.lisp (file)

Function: %var-accessor-%tabsize ()
Function: (setf %var-accessor-%tabsize) VALUE
Package

de.anvi.ncurses

Source

variables.lisp (file)

Function: %wunctrl C
Package

de.anvi.ncurses

Source

util.lisp (file)

Function: add-plants ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: animal-dir INSTANCE
Function: (setf animal-dir) VALUE INSTANCE
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: animal-energy INSTANCE
Function: (setf animal-energy) VALUE INSTANCE
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: animal-genes INSTANCE
Function: (setf animal-genes) VALUE INSTANCE
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: animal-p OBJECT
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

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

de.anvi.croatoan.tests

Source

evolution.lisp (file)

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

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: ascii-byte-p OCTET

Return t if octet is a single-byte 7-bit ASCII char.

The most significant bit is 0, so the allowed pattern is 0xxx xxxx.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: attrs2chtype ATTRS

Take a list of attribute keywords, return a chtype with the attribute bits set.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: bitmask-to-keyword BITMASK
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: char2chtype CHAR

Take a character in different forms, return a chtype containing that character.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: chtype2attrs CH

Take a chtype, return a list of used attribute keywords.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: chtype2colors CH

Take a chtype or attr_t integer, return a list of two keywords denoting a color pair.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: chtype2xchar CH

Converts a ncurses chtype to croatoan complex-char.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: clear-field WIN FIELD

Do what (clear win) does, but for a single field.

clear = write space combined with the background char.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: closest-gray RGB

Take an integer 0-255 denoting a gray color intensity, return the closest gray from the xterm palette.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: color-1k-to-8bit INTEGER

Convert the ncurses color intensity 0-1000 to the 8bit range 0-255.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: color-8bit-to-1k INTEGER

Convert the 8bit range 0-255 to the ncurses color intensity 0-1000.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: color-name-to-number COLOR-NAME

Take a keyword denoting a color name, return the color number.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: color-to-number COLOR

Takes a color in various notations, converts that notation to the exact or most appropriate color number.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: colors2chtype COLOR-PAIR

Take a list of a color pair, return a chtype with the color attribute set.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: copy-animal INSTANCE
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: distance-to-bottom WINDOW

Return the number of lines from the cursor position to the bottom of the window.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: distance-to-eol WINDOW

Return the number of columns from the cursor position to the end of the line in the window.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: draw-field WIN FIELD

Clear and redraw the field and its contents and background.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: draw-world ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: draw-world-croatoan SCR
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: eat ANIMAL
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: enable-8bit-char-input WINDOW FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: end-refreshed-p ()

Checks whether a refresh has been called after end-screen.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Function: escape-sequence-delay WINDOW FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: evolution ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: evolve ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: evolve2 ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: evolve3 ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: evolve4 ()
Package

de.anvi.croatoan.tests

Source

evolution.lisp (file)

Function: flush-on-interrupt WINDOW FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: format-menu-item MENU ITEM-NUMBER
Package

de.anvi.croatoan

</