The trivial-toplevel-prompt Reference Manual

This is the trivial-toplevel-prompt Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:57:43 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-toplevel-prompt

Portability library to customize REPL prompts.

Author

Artyom Bologov

Home Page

https://github.com/aartaka/trivial-toplevel-prompt

Source Control

(GIT https://github.com/aartaka/trivial-toplevel-prompt.git)

Bug Tracker

https://github.com/aartaka/trivial-toplevel-prompt/issues

License

BSD-3 Clause

Version

0.1.1

Source

trivial-toplevel-prompt.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-toplevel-prompt/trivial-toplevel-prompt.asd

Source

trivial-toplevel-prompt.asd.

Parent Component

trivial-toplevel-prompt (system).

ASDF Systems

trivial-toplevel-prompt.


3.1.2 trivial-toplevel-prompt/package.lisp

Source

trivial-toplevel-prompt.asd.

Parent Component

trivial-toplevel-prompt (system).

Packages

trivial-toplevel-prompt.


3.1.3 trivial-toplevel-prompt/prompt.lisp

Dependency

package.lisp (file).

Source

trivial-toplevel-prompt.asd.

Parent Component

trivial-toplevel-prompt (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-toplevel-prompt

‘trivial-toplevel-prompt’ is a library to customize REPL prompts.

The main entry point is ‘set-toplevel-prompt’, which redefines implementation-specific prompts to follow a certain format.

‘reset-toplevel-prompt’ is an undo operation that restored the prompt to the state before the last ‘set-toplevel-prompt’ was invoked.

Source

package.lisp.

Use List

common-lisp.

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: reset-toplevel-prompt ()

Revert the prompt to the state before the last ‘set-toplevel-prompt’.

Package

trivial-toplevel-prompt.

Source

prompt.lisp.

Function: set-toplevel-prompt (prompt-specifier)

Redefine REPL prompt to be PROMPT-SPECIFIER.

PROMPT-SPECIFIER can be a
- String, which will be used as a format control.
- Function, which prints the prompt text to the supplied stream.

The arguments for format control or function are:
- Stream to print to. Only relevant for function, not supplied to format control.
- Current process/thread name (string).
- Current package name (string).
- Current command number (nullable integer).
- NIL if there’s no command history for the implementation. - Debug level (nullable integer).
- NIL if not in the debugger or unknown.
- Whether in the stepping loop (boolean).
- Whether in the inspect loop (boolean).

Always returns NIL.

Package

trivial-toplevel-prompt.

Source

prompt.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *previous-prompting-stack*

A list of previous prompting states: replaced functions, rebound variables etc. Allows to restore the previous state of the prompt in ‘reset-toplevel-prompt’.

Package

trivial-toplevel-prompt.

Source

prompt.lisp.


5.2.2 Ordinary functions

Function: shortest-package-nickname (package)
Package

trivial-toplevel-prompt.

Source

prompt.lisp.

Function: true (value)

Ensure that VALUE is coerced to a strict NIL/T boolean.

Package

trivial-toplevel-prompt.

Source

prompt.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables