The clog-terminal Reference Manual

This is the clog-terminal Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:02:41 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clog-terminal

CLOG Terminal

Author

<>

License

BSD

Version

0.1.0

Dependency

clog (system).

Source

clog-terminal.asd.

Child Component

clog-terminal.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 clog-terminal/clog-terminal.asd

Source

clog-terminal.asd.

Parent Component

clog-terminal (system).

ASDF Systems

clog-terminal.


3.1.2 clog-terminal/clog-terminal.lisp

Source

clog-terminal.asd.

Parent Component

clog-terminal (system).

Packages

clog-terminal.

Public Interface
Internals

on-test-clog-terminal (function).


4 Packages

Packages are listed by definition order.


4.1 clog-terminal

Source

clog-terminal.lisp.

Use List
  • clog.
  • common-lisp.
Public Interface
Internals

on-test-clog-terminal (function).


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: attach-clog-terminal (obj &key greetings prompt)
Package

clog-terminal.

Source

clog-terminal.lisp.

Function: init-clog-terminal (obj)
Package

clog-terminal.

Source

clog-terminal.lisp.

Function: start-test ()
Package

clog-terminal.

Source

clog-terminal.lisp.


5.1.2 Generic functions

Generic Function: clear (clog-terminal-element)

Clear text on terminal

Package

clog-terminal.

Source

clog-terminal.lisp.

Methods
Method: clear ((obj clog-terminal-element))
Generic Function: create-clog-terminal-element (clog-obj &key hidden class html-id auto-place greetings prompt)

Create a new clog-terminal-element as child of CLOG-OBJ.

Package

clog-terminal.

Source

clog-terminal.lisp.

Methods
Method: create-clog-terminal-element ((obj clog-obj) &key greetings prompt hidden class html-id auto-place)
Generic Function: echo (clog-terminal-element text)

Echo text to terminal

Package

clog-terminal.

Source

clog-terminal.lisp.

Methods
Method: echo ((obj clog-terminal-element) text)
Generic Function: exec (clog-terminal-element text)

Exec text as if command entered at terminal

Package

clog-terminal.

Source

clog-terminal.lisp.

Methods
Method: exec ((obj clog-terminal-element) text)
Generic Function: prompt (clog-terminal-element text)

Set prompt text for terminal (write only)

Package

clog-terminal.

Source

clog-terminal.lisp.

Methods
Method: prompt ((obj clog-terminal-element) text)
Generic Function: set-on-command (clog-terminal-element handler &key cancel-event one-time)

Set a HANDLER for clog-terminal commands on CLOG-OBJ.
If HANDLER is nil unbind all event handlers. Handler is called with a data parameter with what was entered on command line.

Package

clog-terminal.

Source

clog-terminal.lisp.

Methods
Method: set-on-command ((obj clog-terminal-element) handler &key cancel-event one-time)

5.1.3 Standalone methods

Method: reset ((obj clog-terminal-element))
Package

clog.

Source

clog-terminal.lisp.


5.1.4 Classes

Class: clog-terminal-element

CLOG Terminal Element Object.

Package

clog-terminal.

Source

clog-terminal.lisp.

Direct superclasses

clog-element.

Direct methods

5.2 Internals


5.2.1 Ordinary functions

Function: on-test-clog-terminal (body)
Package

clog-terminal.

Source

clog-terminal.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   E   F   G   I   M   O   P   R   S  
Index Entry  Section

A
attach-clog-terminal: Public ordinary functions

C
clear: Public generic functions
clear: Public generic functions
create-clog-terminal-element: Public generic functions
create-clog-terminal-element: Public generic functions

E
echo: Public generic functions
echo: Public generic functions
exec: Public generic functions
exec: Public generic functions

F
Function, attach-clog-terminal: Public ordinary functions
Function, init-clog-terminal: Public ordinary functions
Function, on-test-clog-terminal: Private ordinary functions
Function, start-test: Public ordinary functions

G
Generic Function, clear: Public generic functions
Generic Function, create-clog-terminal-element: Public generic functions
Generic Function, echo: Public generic functions
Generic Function, exec: Public generic functions
Generic Function, prompt: Public generic functions
Generic Function, set-on-command: Public generic functions

I
init-clog-terminal: Public ordinary functions

M
Method, clear: Public generic functions
Method, create-clog-terminal-element: Public generic functions
Method, echo: Public generic functions
Method, exec: Public generic functions
Method, prompt: Public generic functions
Method, reset: Public standalone methods
Method, set-on-command: Public generic functions

O
on-test-clog-terminal: Private ordinary functions

P
prompt: Public generic functions
prompt: Public generic functions

R
reset: Public standalone methods

S
set-on-command: Public generic functions
set-on-command: Public generic functions
start-test: Public ordinary functions


A.3 Variables