Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the lime Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 11:24:41 2021 GMT+0.
| • Introduction | What lime is all about | |
| • Systems | The systems documentation | |
| • Modules | The modules documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
A Swank (SLIME) client for Common Lisp applications, built on 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.
To load and run the REPL example, do this:
(ql:quickload :lime-example)
(lime-example:repl)
It works as you'd expect:
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>
Like SLIME, but without the leading S. No relation to the text editor.
Copyright (c) 2015 Fernando Borretti
Licensed under the MIT License.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The lime system |
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(:git "git@github.com:eudoxia0/lime.git")
MIT
A high-level Swank client, like Slime, but for Common Lisp applications.
# 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
lime.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
| • The lime/src module |
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The lime.asd file | ||
| • The lime/src/lime.lisp file |
Next: The lime/src/lime․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
lime.asd
lime (system)
Previous: The lime․asd file, Up: Lisp files [Contents][Index]
src (module)
src/lime.lisp
parse-event (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The lime package |
A high-level Swank client.
lime.lisp (file)
common-lisp
parse-event (function)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions | ||
| • Exported generic functions | ||
| • Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
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.
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
A connection to a Swank server.
lime.lisp (file)
connection (class)
The depth at which the debugger is called.
integer
0
connection-debug-level (generic function)
(setf connection-debug-level) (generic function)
Whether or not the server is waiting for input on standard input.
boolean
connection-reader-waiting-p (generic function)
(setf connection-reader-waiting-p) (generic function)
The PID of the Swank server process.
integer
connection-pid (generic function)
(setf connection-pid) (generic function)
The name of the implementation running the Swank server.
string
connection-implementation-name (generic function)
(setf connection-implementation-name) (generic function)
The version string of the implementation running the Swank server.
string
connection-implementation-version (generic function)
(setf connection-implementation-version) (generic function)
The server machine’s architecture.
string
connection-machine-type (generic function)
(setf connection-machine-type) (generic function)
The server machine’s processor type.
string
connection-machine-version (generic function)
(setf connection-machine-version) (generic function)
The server’s Swank version.
string
connection-swank-version (generic function)
(setf connection-swank-version) (generic function)
Signals that the debugger has been entered.
lime.lisp (file)
event (class)
A list of strings describing the condition.
(trivial-types:proper-list string)
:condition
event-condition (generic function)
An association list of restart names to descriptions.
(trivial-types:association-list string string)
:restarts
event-restarts (generic function)
An association list of a stack frame’s position to its description.
(trivial-types:association-list integer string)
:call-stack
event-call-stack (generic function)
The base class of all events
lime.lisp (file)
standard-object (class)
Signals that the server is waiting for input.
An event that indicates the inferior Lisp has changed its current package.
lime.lisp (file)
event (class)
The full name of the new package.
string
:package-name
event-package-name (generic function)
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
event-prompt-string (generic function)
A write-string event.
lime.lisp (file)
event (class)
The string to write.
string
:string
event-string (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Parse a swank-protocol message S-expression into a an instance of a subclass of event, or return NIL.
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L M |
|---|
| Jump to: | F L M |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
A C D E F G M P S |
|---|
| Jump to: | (
A C D E F G M P S |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | C D I M P R S |
|---|
| Jump to: | C D I M P R S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C D E L P R S W |
|---|
| Jump to: | C D E L P R S W |
|---|