The cl-drawille Reference Manual

This is the cl-drawille Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:50:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-drawille

cl-drawille: Drawing in terminal with Unicode Braille characters.

Author

Goheeca <>

License

MIT

Version

1.0.0

Dependencies
  • cffi (system).
  • osicat (system).
  • alexandria (system).
Source

cl-drawille.asd.

Child Component

drawille.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-drawille/cl-drawille.asd

Source

cl-drawille.asd.

Parent Component

cl-drawille (system).

ASDF Systems

cl-drawille.


3.1.2 cl-drawille/drawille.lisp

Source

cl-drawille.asd.

Parent Component

cl-drawille (system).

Packages

cl-drawille.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-drawille

Source

drawille.lisp.

Use List
  • alexandria.
  • cffi.
  • common-lisp.
  • osicat.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-canvas ()
Package

cl-drawille.

Source

drawille.lisp.

Function: make-turtle (&optional pos-x pos-y)
Package

cl-drawille.

Source

drawille.lisp.

Function: terminal-size ()
Package

cl-drawille.

Source

drawille.lisp.


5.1.2 Generic functions

Generic Function: back (tur step)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: back ((tur turtle) step)
Generic Function: clear (c)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: clear ((c canvas))
Generic Function: down (tur)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: down ((tur turtle))
Generic Function: forward (tur step)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: forward ((tur turtle) step)
Generic Function: frame (c &key min-x min-y max-x max-y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: frame ((c canvas) &key min-x min-y max-x max-y)
Generic Function: left (tur angle)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: left ((tur turtle) angle)
Generic Function: move (tur x y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: move ((tur turtle) x y)
Generic Function: right (tur angle)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: right ((tur turtle) angle)
Generic Function: rows (c &key min-x min-y max-x max-y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: rows ((c canvas) &key min-x min-y max-x max-y)
Generic Function: set-pixel (c x y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: set-pixel ((c canvas) x y)
Generic Function: set-text (c x y text)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: set-text ((c canvas) x y text)
Generic Function: toggle-pixel (c x y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: toggle-pixel ((c canvas) x y)
Generic Function: unset-pixel (c x y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: unset-pixel ((c canvas) x y)
Generic Function: up (tur)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: up ((tur turtle))

5.2 Internals


5.2.1 Constants

Constant: +braille-offset+
Package

cl-drawille.

Source

drawille.lisp.

Constant: +pixel-map+
Package

cl-drawille.

Source

drawille.lisp.


5.2.2 Macros

Macro: access-char (&body body)
Package

cl-drawille.

Source

drawille.lisp.

Macro: process-char (&body body)
Package

cl-drawille.

Source

drawille.lisp.


5.2.3 Ordinary functions

Function: get-pos (x y)
Package

cl-drawille.

Source

drawille.lisp.

Function: line (x1 y1 x2 y2)
Package

cl-drawille.

Source

drawille.lisp.

Function: normalize (coord)
Package

cl-drawille.

Source

drawille.lisp.

Function: pixel (x y)
Package

cl-drawille.

Source

drawille.lisp.

Function: polygon (&optional center-x center-y sides radius)
Package

cl-drawille.

Source

drawille.lisp.


5.2.4 Generic functions

Generic Reader: brush (object)
Package

cl-drawille.

Methods
Reader Method: brush ((turtle turtle))

automatically generated reader method

Source

drawille.lisp.

Target Slot

brush.

Generic Writer: (setf brush) (object)
Package

cl-drawille.

Methods
Writer Method: (setf brush) ((turtle turtle))

automatically generated writer method

Source

drawille.lisp.

Target Slot

brush.

Generic Reader: chars (object)
Package

cl-drawille.

Methods
Reader Method: chars ((canvas canvas))

automatically generated reader method

Source

drawille.lisp.

Target Slot

chars.

Generic Writer: (setf chars) (object)
Package

cl-drawille.

Methods
Writer Method: (setf chars) ((canvas canvas))

automatically generated writer method

Source

drawille.lisp.

Target Slot

chars.

Generic Function: get-char (c col row)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: get-char ((c canvas) col row)
Generic Function: get-pixel (c x y)
Package

cl-drawille.

Source

drawille.lisp.

Methods
Method: get-pixel ((c canvas) x y)
Generic Reader: pos-x (object)
Package

cl-drawille.

Methods
Reader Method: pos-x ((turtle turtle))

automatically generated reader method

Source

drawille.lisp.

Target Slot

pos-x.

Generic Writer: (setf pos-x) (object)
Package

cl-drawille.

Methods
Writer Method: (setf pos-x) ((turtle turtle))

automatically generated writer method

Source

drawille.lisp.

Target Slot

pos-x.

Generic Reader: pos-y (object)
Package

cl-drawille.

Methods
Reader Method: pos-y ((turtle turtle))

automatically generated reader method

Source

drawille.lisp.

Target Slot

pos-y.

Generic Writer: (setf pos-y) (object)
Package

cl-drawille.

Methods
Writer Method: (setf pos-y) ((turtle turtle))

automatically generated writer method

Source

drawille.lisp.

Target Slot

pos-y.

Generic Reader: rotation (object)
Package

cl-drawille.

Methods
Reader Method: rotation ((turtle turtle))

automatically generated reader method

Source

drawille.lisp.

Target Slot

rotation.

Generic Writer: (setf rotation) (object)
Package

cl-drawille.

Methods
Writer Method: (setf rotation) ((turtle turtle))

automatically generated writer method

Source

drawille.lisp.

Target Slot

rotation.


5.2.5 Classes

Class: canvas
Package

cl-drawille.

Source

drawille.lisp.

Direct subclasses

turtle.

Direct methods
Direct slots
Slot: chars
Initform

(make-hash-table :test (function equal))

Readers

chars.

Writers

(setf chars).

Class: turtle
Package

cl-drawille.

Source

drawille.lisp.

Direct superclasses

canvas.

Direct methods
Direct slots
Slot: pos-x
Initargs

:pos-x

Readers

pos-x.

Writers

(setf pos-x).

Slot: pos-y
Initargs

:pos-y

Readers

pos-y.

Writers

(setf pos-y).

Slot: rotation
Initform

0

Readers

rotation.

Writers

(setf rotation).

Slot: brush
Initform

t

Readers

brush.

Writers

(setf brush).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   F   G   L   M   N   P   R   S   T   U  
Index Entry  Section

(
(setf brush): Private generic functions
(setf brush): Private generic functions
(setf chars): Private generic functions
(setf chars): Private generic functions
(setf pos-x): Private generic functions
(setf pos-x): Private generic functions
(setf pos-y): Private generic functions
(setf pos-y): Private generic functions
(setf rotation): Private generic functions
(setf rotation): Private generic functions

A
access-char: Private macros

B
back: Public generic functions
back: Public generic functions
brush: Private generic functions
brush: Private generic functions

C
chars: Private generic functions
chars: Private generic functions
clear: Public generic functions
clear: Public generic functions

D
down: Public generic functions
down: Public generic functions

F
forward: Public generic functions
forward: Public generic functions
frame: Public generic functions
frame: Public generic functions
Function, get-pos: Private ordinary functions
Function, line: Private ordinary functions
Function, make-canvas: Public ordinary functions
Function, make-turtle: Public ordinary functions
Function, normalize: Private ordinary functions
Function, pixel: Private ordinary functions
Function, polygon: Private ordinary functions
Function, terminal-size: Public ordinary functions

G
Generic Function, (setf brush): Private generic functions
Generic Function, (setf chars): Private generic functions
Generic Function, (setf pos-x): Private generic functions
Generic Function, (setf pos-y): Private generic functions
Generic Function, (setf rotation): Private generic functions
Generic Function, back: Public generic functions
Generic Function, brush: Private generic functions
Generic Function, chars: Private generic functions
Generic Function, clear: Public generic functions
Generic Function, down: Public generic functions
Generic Function, forward: Public generic functions
Generic Function, frame: Public generic functions
Generic Function, get-char: Private generic functions
Generic Function, get-pixel: Private generic functions
Generic Function, left: Public generic functions
Generic Function, move: Public generic functions
Generic Function, pos-x: Private generic functions
Generic Function, pos-y: Private generic functions
Generic Function, right: Public generic functions
Generic Function, rotation: Private generic functions
Generic Function, rows: Public generic functions
Generic Function, set-pixel: Public generic functions
Generic Function, set-text: Public generic functions
Generic Function, toggle-pixel: Public generic functions
Generic Function, unset-pixel: Public generic functions
Generic Function, up: Public generic functions
get-char: Private generic functions
get-char: Private generic functions
get-pixel: Private generic functions
get-pixel: Private generic functions
get-pos: Private ordinary functions

L
left: Public generic functions
left: Public generic functions
line: Private ordinary functions

M
Macro, access-char: Private macros
Macro, process-char: Private macros
make-canvas: Public ordinary functions
make-turtle: Public ordinary functions
Method, (setf brush): Private generic functions
Method, (setf chars): Private generic functions
Method, (setf pos-x): Private generic functions
Method, (setf pos-y): Private generic functions
Method, (setf rotation): Private generic functions
Method, back: Public generic functions
Method, brush: Private generic functions
Method, chars: Private generic functions
Method, clear: Public generic functions
Method, down: Public generic functions
Method, forward: Public generic functions
Method, frame: Public generic functions
Method, get-char: Private generic functions
Method, get-pixel: Private generic functions
Method, left: Public generic functions
Method, move: Public generic functions
Method, pos-x: Private generic functions
Method, pos-y: Private generic functions
Method, right: Public generic functions
Method, rotation: Private generic functions
Method, rows: Public generic functions
Method, set-pixel: Public generic functions
Method, set-text: Public generic functions
Method, toggle-pixel: Public generic functions
Method, unset-pixel: Public generic functions
Method, up: Public generic functions
move: Public generic functions
move: Public generic functions

N
normalize: Private ordinary functions

P
pixel: Private ordinary functions
polygon: Private ordinary functions
pos-x: Private generic functions
pos-x: Private generic functions
pos-y: Private generic functions
pos-y: Private generic functions
process-char: Private macros

R
right: Public generic functions
right: Public generic functions
rotation: Private generic functions
rotation: Private generic functions
rows: Public generic functions
rows: Public generic functions

S
set-pixel: Public generic functions
set-pixel: Public generic functions
set-text: Public generic functions
set-text: Public generic functions

T
terminal-size: Public ordinary functions
toggle-pixel: Public generic functions
toggle-pixel: Public generic functions

U
unset-pixel: Public generic functions
unset-pixel: Public generic functions
up: Public generic functions
up: Public generic functions