This is the lime Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 06:08:25 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
limeA high-level Swank client, like Slime, but for Common Lisp applications.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:eudoxia0/lime.git)
MIT
# Lime
[](https://travis-ci.org/eudoxia0/lime)
[](https://coveralls.io/r/eudoxia0/lime?branch=master)
[](http://quickdocs.org/lime/)
A Swank ([SLIME][slime]) client for Common Lisp applications, built on
[swank-protocol][swank-protocol]. It can be used to connect to a remote or local
Swank server, evaluate code, and receive responses for printing to the screen,
handling debugger events, etc.
# Usage
## Example
To load and run the REPL example, do this:
“‘lisp
(ql:quickload :lime-example)
(lime-example:repl)
“‘
It works as you’d expect:
“‘lisp
CL-USER> (lime-example:repl)
Starting Swank server...
Connecting...
Swank server running on sbcl 1.2.9
COMMON-LISP-USER> (+ 2 2)
4
COMMON-LISP-USER>
“‘
# Name
Like SLIME, but without the leading S. No relation to
[the text editor][lime-text].
[slime]: https://github.com/slime/slime
[swank-protocol]: https://github.com/eudoxia0/swank-protocol
[lime-text]: http://limetext.org/
# License
Copyright (c) 2015 Fernando Borretti
Licensed under the MIT License.
0.1
swank-protocol (system).
alexandria (system).
trivial-types (system).
src (module).
Modules are listed depth-first from the system components tree.
Files are sorted by type and then listed depth-first from the systems components trees.
lime/src/lime.lispsrc (module).
lime.
abort-debugger (function).
connect (method).
connection (class).
connection-debug-level (reader method).
(setf connection-debug-level) (writer method).
connection-implementation-name (reader method).
(setf connection-implementation-name) (writer method).
connection-implementation-version (reader method).
(setf connection-implementation-version) (writer method).
connection-machine-type (reader method).
(setf connection-machine-type) (writer method).
connection-machine-version (reader method).
(setf connection-machine-version) (writer method).
connection-pid (reader method).
(setf connection-pid) (writer method).
connection-reader-waiting-p (reader method).
(setf connection-reader-waiting-p) (writer method).
connection-swank-version (reader method).
(setf connection-swank-version) (writer method).
debugger-event (class).
debuggerp (function).
evaluate (function).
event (class).
event-call-stack (reader method).
event-condition (reader method).
event-package-name (reader method).
event-prompt-string (reader method).
event-restarts (reader method).
event-string (reader method).
event-tag (reader method).
event-thread (reader method).
make-connection (function).
ping-event (class).
print-object (method).
print-object (method).
print-object (method).
pull-all-events (function).
read-string-event (class).
send-input (function).
switch-package-event (class).
write-string-event (class).
parse-event (function).
Packages are listed by definition order.
limeA high-level Swank client.
common-lisp.
abort-debugger (function).
connection (class).
connection-debug-level (generic reader).
(setf connection-debug-level) (generic writer).
connection-implementation-name (generic reader).
(setf connection-implementation-name) (generic writer).
connection-implementation-version (generic reader).
(setf connection-implementation-version) (generic writer).
connection-machine-type (generic reader).
(setf connection-machine-type) (generic writer).
connection-machine-version (generic reader).
(setf connection-machine-version) (generic writer).
connection-pid (generic reader).
(setf connection-pid) (generic writer).
connection-reader-waiting-p (generic reader).
(setf connection-reader-waiting-p) (generic writer).
connection-swank-version (generic reader).
(setf connection-swank-version) (generic writer).
debugger-event (class).
debuggerp (function).
evaluate (function).
event (class).
event-call-stack (generic reader).
event-condition (generic reader).
event-package-name (generic reader).
event-prompt-string (generic reader).
event-restarts (generic reader).
event-string (generic reader).
event-tag (generic reader).
event-thread (generic reader).
make-connection (function).
ping-event (class).
pull-all-events (function).
read-string-event (class).
send-input (function).
switch-package-event (class).
write-string-event (class).
parse-event (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
T if the connection is in the debugger, NIL otherwise.
Send a string to the Swank server for evaluation.
Create a connection object.
Return a list of all events from the connection.
Send a string to the Swank server’s standard input.
lime.
connection)) ¶connection)) ¶The depth at which the debugger is called.
lime.
connection)) ¶connection)) ¶The name of the implementation running the Swank server.
lime.
connection)) ¶connection)) ¶The version string of the implementation running the Swank server.
lime.
connection)) ¶connection)) ¶The server machine’s architecture.
lime.
connection)) ¶connection)) ¶The server machine’s processor type.
lime.
connection)) ¶connection)) ¶The PID of the Swank server process.
lime.
connection)) ¶connection)) ¶Whether or not the server is waiting for input on standard input.
lime.
connection)) ¶connection)) ¶The server’s Swank version.
lime.
debugger-event)) ¶An association list of a stack frame’s position to its description.
lime.
debugger-event)) ¶A list of strings describing the condition.
lime.
switch-package-event)) ¶The full name of the new package.
lime.
switch-package-event)) ¶The name that should be displayed in the
REPL. If the package has periods in the name, this is usually the subsequence
after the last period, e.g: ’app.db.user’ => ’user’.
lime.
debugger-event)) ¶An association list of restart names to descriptions.
lime.
write-string-event)) ¶The string to write.
lime.
ping-event)) ¶lime.
ping-event)) ¶connection)) ¶After connecting, query the Swank server for connection information and create a REPL.
swank-protocol.
debugger-event) stream) ¶Print a debugger event.
switch-package-event) stream) ¶Print a switch-package event.
write-string-event) stream) ¶Print a write-string event.
A connection to a Swank server.
lime.
connection.
connect.
(setf connection-debug-level).
connection-debug-level.
(setf connection-implementation-name).
connection-implementation-name.
(setf connection-implementation-version).
connection-implementation-version.
(setf connection-machine-type).
connection-machine-type.
(setf connection-machine-version).
connection-machine-version.
(setf connection-pid).
connection-pid.
(setf connection-reader-waiting-p).
connection-reader-waiting-p.
(setf connection-swank-version).
connection-swank-version.
The depth at which the debugger is called.
integer
0
Whether or not the server is waiting for input on standard input.
boolean
The PID of the Swank server process.
integer
The name of the implementation running the Swank server.
string
The version string of the implementation running the Swank server.
string
The server machine’s architecture.
common-lisp.
string
The server machine’s processor type.
common-lisp.
string
The server’s Swank version.
string
Signals that the debugger has been entered.
lime.
A list of strings describing the condition.
common-lisp.
(trivial-types:proper-list string)
:condition
This slot is read-only.
An association list of restart names to descriptions.
(trivial-types:association-list string string)
:restarts
This slot is read-only.
An association list of a stack frame’s position to its description.
(trivial-types:association-list integer string)
:call-stack
This slot is read-only.
An event that checks if the client is still alive.
When this event is recieved, Swank waits until it recieves (:PONG thread tag)
Signals that the server is waiting for input.
An event that indicates the inferior Lisp has changed its current package.
lime.
The full name of the new package.
common-lisp.
string
:package-name
This slot is read-only.
The name that should be displayed in the
REPL. If the package has periods in the name, this is usually the subsequence
after the last period, e.g: ’app.db.user’ => ’user’.
string
:prompt-string
This slot is read-only.
A write-string event.
| Jump to: | (
A C D E F G M P S |
|---|
| Jump to: | (
A C D E F G M P S |
|---|
| Jump to: | C D I M P R S T |
|---|
| Jump to: | C D I M P R S T |
|---|
| Jump to: | C D E F L M P R S W |
|---|
| Jump to: | C D E F L M P R S W |
|---|