The lime Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The lime Reference Manual

This is the lime Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:08:20 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

logo

Lime

Build Status Coverage Status Quicklisp

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.

Usage

Example

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>

Name

Like SLIME, but without the leading S. No relation to the text editor.

License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 lime

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/eudoxia0/lime

Source Control

(:git "git@github.com:eudoxia0/lime.git")

Bug Tracker

https://github.com/eudoxia0/lime/issues

License

MIT

Description

A high-level Swank client, like Slime, but for Common Lisp applications.

Long Description

![logo](logo.png)

# Lime

[![Build Status](https://travis-ci.org/eudoxia0/lime.svg?branch=master)](https://travis-ci.org/eudoxia0/lime)
[![Coverage Status](https://coveralls.io/repos/eudoxia0/lime/badge.svg?branch=master)](https://coveralls.io/r/eudoxia0/lime?branch=master) [![Quicklisp](http://quickdocs.org/badge/lime.svg)](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.

Version

0.1

Dependencies
Source

lime.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 lime/src

Parent

lime (system)

Location

src/

Component

lime.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 lime.asd

Location

lime.asd

Systems

lime (system)


Previous: , Up: Lisp files   [Contents][Index]

4.1.2 lime/src/lime.lisp

Parent

src (module)

Location

src/lime.lisp

Packages

lime

Exported Definitions
Internal Definitions

parse-event (function)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 lime

A high-level Swank client.

Source

lime.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

parse-event (function)


Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: abort-debugger CONNECTION

Leave the debugger.

Package

lime

Source

lime.lisp (file)

Function: debuggerp CONNECTION

T if the connection is in the debugger, NIL otherwise.

Package

lime

Source

lime.lisp (file)

Function: evaluate CONNECTION STRING

Send a string to the Swank server for evaluation.

Package

lime

Source

lime.lisp (file)

Function: make-connection HOSTNAME PORT &key LOGP

Create a connection object.

Package

lime

Source

lime.lisp (file)

Function: pull-all-events CONNECTION

Return a list of all events from the connection.

Package

lime

Source

lime.lisp (file)

Function: send-input CONNECTION STRING

Send a string to the Swank server’s standard input.

Package

lime

Source

lime.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Generic functions

Generic Function: connection-debug-level OBJECT
Generic Function: (setf connection-debug-level) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-debug-level (CONNECTION connection)
Method: (setf connection-debug-level) NEW-VALUE (CONNECTION connection)

The depth at which the debugger is called.

Source

lime.lisp (file)

Generic Function: connection-implementation-name OBJECT
Generic Function: (setf connection-implementation-name) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-implementation-name (CONNECTION connection)
Method: (setf connection-implementation-name) NEW-VALUE (CONNECTION connection)

The name of the implementation running the Swank server.

Source

lime.lisp (file)

Generic Function: connection-implementation-version OBJECT
Generic Function: (setf connection-implementation-version) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-implementation-version (CONNECTION connection)
Method: (setf connection-implementation-version) NEW-VALUE (CONNECTION connection)

The version string of the implementation running the Swank server.

Source

lime.lisp (file)

Generic Function: connection-machine-type OBJECT
Generic Function: (setf connection-machine-type) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-machine-type (CONNECTION connection)
Method: (setf connection-machine-type) NEW-VALUE (CONNECTION connection)

The server machine’s architecture.

Source

lime.lisp (file)

Generic Function: connection-machine-version OBJECT
Generic Function: (setf connection-machine-version) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-machine-version (CONNECTION connection)
Method: (setf connection-machine-version) NEW-VALUE (CONNECTION connection)

The server machine’s processor type.

Source

lime.lisp (file)

Generic Function: connection-pid OBJECT
Generic Function: (setf connection-pid) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-pid (CONNECTION connection)
Method: (setf connection-pid) NEW-VALUE (CONNECTION connection)

The PID of the Swank server process.

Source

lime.lisp (file)

Generic Function: connection-reader-waiting-p OBJECT
Generic Function: (setf connection-reader-waiting-p) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-reader-waiting-p (CONNECTION connection)
Method: (setf connection-reader-waiting-p) NEW-VALUE (CONNECTION connection)

Whether or not the server is waiting for input on standard input.

Source

lime.lisp (file)

Generic Function: connection-swank-version OBJECT
Generic Function: (setf connection-swank-version) NEW-VALUE OBJECT
Package

lime

Methods
Method: connection-swank-version (CONNECTION connection)
Method: (setf connection-swank-version) NEW-VALUE (CONNECTION connection)

The server’s Swank version.

Source

lime.lisp (file)

Generic Function: event-call-stack OBJECT
Package

lime

Methods
Method: event-call-stack (DEBUGGER-EVENT debugger-event)

An association list of a stack frame’s position to its description.

Source

lime.lisp (file)

Generic Function: event-condition OBJECT
Package

lime

Methods
Method: event-condition (DEBUGGER-EVENT debugger-event)

A list of strings describing the condition.

Source

lime.lisp (file)

Generic Function: event-package-name OBJECT
Package

lime

Methods
Method: event-package-name (SWITCH-PACKAGE-EVENT switch-package-event)

The full name of the new package.

Source

lime.lisp (file)

Generic Function: event-prompt-string OBJECT
Package

lime

Methods
Method: event-prompt-string (SWITCH-PACKAGE-EVENT 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’.

Source

lime.lisp (file)

Generic Function: event-restarts OBJECT
Package

lime

Methods
Method: event-restarts (DEBUGGER-EVENT debugger-event)

An association list of restart names to descriptions.

Source

lime.lisp (file)

Generic Function: event-string OBJECT
Package

lime

Methods
Method: event-string (WRITE-STRING-EVENT write-string-event)

The string to write.

Source

lime.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Classes

Class: connection ()

A connection to a Swank server.

Package

lime

Source

lime.lisp (file)

Direct superclasses

connection (class)

Direct methods
Direct slots
Slot: debug-level

The depth at which the debugger is called.

Type

integer

Initform

0

Readers

connection-debug-level (generic function)

Writers

(setf connection-debug-level) (generic function)

Slot: reader-waiting

Whether or not the server is waiting for input on standard input.

Type

boolean

Readers

connection-reader-waiting-p (generic function)

Writers

(setf connection-reader-waiting-p) (generic function)

Slot: pid

The PID of the Swank server process.

Type

integer

Readers

connection-pid (generic function)

Writers

(setf connection-pid) (generic function)

Slot: implementation-name

The name of the implementation running the Swank server.

Type

string

Readers

connection-implementation-name (generic function)

Writers

(setf connection-implementation-name) (generic function)

Slot: implementation-version

The version string of the implementation running the Swank server.

Type

string

Readers

connection-implementation-version (generic function)

Writers

(setf connection-implementation-version) (generic function)

Slot: machine-type

The server machine’s architecture.

Type

string

Readers

connection-machine-type (generic function)

Writers

(setf connection-machine-type) (generic function)

Slot: machine-version

The server machine’s processor type.

Type

string

Readers

connection-machine-version (generic function)

Writers

(setf connection-machine-version) (generic function)

Slot: swank-version

The server’s Swank version.

Type

string

Readers

connection-swank-version (generic function)

Writers

(setf connection-swank-version) (generic function)

Class: debugger-event ()

Signals that the debugger has been entered.

Package

lime

Source

lime.lisp (file)

Direct superclasses

event (class)

Direct methods
Direct slots
Slot: condition

A list of strings describing the condition.

Type

(trivial-types:proper-list string)

Initargs

:condition

Readers

event-condition (generic function)

Slot: restarts

An association list of restart names to descriptions.

Type

(trivial-types:association-list string string)

Initargs

:restarts

Readers

event-restarts (generic function)

Slot: call-stack

An association list of a stack frame’s position to its description.

Type

(trivial-types:association-list integer string)

Initargs

:call-stack

Readers

event-call-stack (generic function)

Class: event ()

The base class of all events

Package

lime

Source

lime.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: read-string-event ()

Signals that the server is waiting for input.

Package

lime

Source

lime.lisp (file)

Direct superclasses

event (class)

Class: switch-package-event ()

An event that indicates the inferior Lisp has changed its current package.

Package

lime

Source

lime.lisp (file)

Direct superclasses

event (class)

Direct methods
Direct slots
Slot: package-name

The full name of the new package.

Type

string

Initargs

:package-name

Readers

event-package-name (generic function)

Slot: prompt-string

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’.

Type

string

Initargs

:prompt-string

Readers

event-prompt-string (generic function)

Class: write-string-event ()

A write-string event.

Package

lime

Source

lime.lisp (file)

Direct superclasses

event (class)

Direct methods
Direct slots
Slot: string

The string to write.

Type

string

Initargs

:string

Readers

event-string (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: parse-event CONNECTION MESSAGE

Parse a swank-protocol message S-expression into a an instance of a subclass of event, or return NIL.

Package

lime

Source

lime.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, lime.asd: The lime<dot>asd file
File, Lisp, lime/src/lime.lisp: The lime/src/lime<dot>lisp file

L
lime.asd: The lime<dot>asd file
lime/src: The lime/src module
lime/src/lime.lisp: The lime/src/lime<dot>lisp file
Lisp File, lime.asd: The lime<dot>asd file
Lisp File, lime/src/lime.lisp: The lime/src/lime<dot>lisp file

M
Module, lime/src: The lime/src module

Jump to:   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   M   P   S  
Index Entry  Section

(
(setf connection-debug-level): Exported generic functions
(setf connection-debug-level): Exported generic functions
(setf connection-implementation-name): Exported generic functions
(setf connection-implementation-name): Exported generic functions
(setf connection-implementation-version): Exported generic functions
(setf connection-implementation-version): Exported generic functions
(setf connection-machine-type): Exported generic functions
(setf connection-machine-type): Exported generic functions
(setf connection-machine-version): Exported generic functions
(setf connection-machine-version): Exported generic functions
(setf connection-pid): Exported generic functions
(setf connection-pid): Exported generic functions
(setf connection-reader-waiting-p): Exported generic functions
(setf connection-reader-waiting-p): Exported generic functions
(setf connection-swank-version): Exported generic functions
(setf connection-swank-version): Exported generic functions

A
abort-debugger: Exported functions

C
connection-debug-level: Exported generic functions
connection-debug-level: Exported generic functions
connection-implementation-name: Exported generic functions
connection-implementation-name: Exported generic functions
connection-implementation-version: Exported generic functions
connection-implementation-version: Exported generic functions
connection-machine-type: Exported generic functions
connection-machine-type: Exported generic functions
connection-machine-version: Exported generic functions
connection-machine-version: Exported generic functions
connection-pid: Exported generic functions
connection-pid: Exported generic functions
connection-reader-waiting-p: Exported generic functions
connection-reader-waiting-p: Exported generic functions
connection-swank-version: Exported generic functions
connection-swank-version: Exported generic functions

D
debuggerp: Exported functions

E
evaluate: Exported functions
event-call-stack: Exported generic functions
event-call-stack: Exported generic functions
event-condition: Exported generic functions
event-condition: Exported generic functions
event-package-name: Exported generic functions
event-package-name: Exported generic functions
event-prompt-string: Exported generic functions
event-prompt-string: Exported generic functions
event-restarts: Exported generic functions
event-restarts: Exported generic functions
event-string: Exported generic functions
event-string: Exported generic functions

F
Function, abort-debugger: Exported functions
Function, debuggerp: Exported functions
Function, evaluate: Exported functions
Function, make-connection: Exported functions
Function, parse-event: Internal functions
Function, pull-all-events: Exported functions
Function, send-input: Exported functions

G
Generic Function, (setf connection-debug-level): Exported generic functions
Generic Function, (setf connection-implementation-name): Exported generic functions
Generic Function, (setf connection-implementation-version): Exported generic functions
Generic Function, (setf connection-machine-type): Exported generic functions
Generic Function, (setf connection-machine-version): Exported generic functions
Generic Function, (setf connection-pid): Exported generic functions
Generic Function, (setf connection-reader-waiting-p): Exported generic functions
Generic Function, (setf connection-swank-version): Exported generic functions
Generic Function, connection-debug-level: Exported generic functions
Generic Function, connection-implementation-name: Exported generic functions
Generic Function, connection-implementation-version: Exported generic functions
Generic Function, connection-machine-type: Exported generic functions
Generic Function, connection-machine-version: Exported generic functions
Generic Function, connection-pid: Exported generic functions
Generic Function, connection-reader-waiting-p: Exported generic functions
Generic Function, connection-swank-version: Exported generic functions
Generic Function, event-call-stack: Exported generic functions
Generic Function, event-condition: Exported generic functions
Generic Function, event-package-name: Exported generic functions
Generic Function, event-prompt-string: Exported generic functions
Generic Function, event-restarts: Exported generic functions
Generic Function, event-string: Exported generic functions

M
make-connection: Exported functions
Method, (setf connection-debug-level): Exported generic functions
Method, (setf connection-implementation-name): Exported generic functions
Method, (setf connection-implementation-version): Exported generic functions
Method, (setf connection-machine-type): Exported generic functions
Method, (setf connection-machine-version): Exported generic functions
Method, (setf connection-pid): Exported generic functions
Method, (setf connection-reader-waiting-p): Exported generic functions
Method, (setf connection-swank-version): Exported generic functions
Method, connection-debug-level: Exported generic functions
Method, connection-implementation-name: Exported generic functions
Method, connection-implementation-version: Exported generic functions
Method, connection-machine-type: Exported generic functions
Method, connection-machine-version: Exported generic functions
Method, connection-pid: Exported generic functions
Method, connection-reader-waiting-p: Exported generic functions
Method, connection-swank-version: Exported generic functions
Method, event-call-stack: Exported generic functions
Method, event-condition: Exported generic functions
Method, event-package-name: Exported generic functions
Method, event-prompt-string: Exported generic functions
Method, event-restarts: Exported generic functions
Method, event-string: Exported generic functions

P
parse-event: Internal functions
pull-all-events: Exported functions

S
send-input: Exported functions

Jump to:   (  
A   C   D   E   F   G   M   P   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   C   D   I   M   P   R   S  
Index Entry  Section

C
call-stack: Exported classes
condition: Exported classes

D
debug-level: Exported classes

I
implementation-name: Exported classes
implementation-version: Exported classes

M
machine-type: Exported classes
machine-version: Exported classes

P
package-name: Exported classes
pid: Exported classes
prompt-string: Exported classes

R
reader-waiting: Exported classes
restarts: Exported classes

S
Slot, call-stack: Exported classes
Slot, condition: Exported classes
Slot, debug-level: Exported classes
Slot, implementation-name: Exported classes
Slot, implementation-version: Exported classes
Slot, machine-type: Exported classes
Slot, machine-version: Exported classes
Slot, package-name: Exported classes
Slot, pid: Exported classes
Slot, prompt-string: Exported classes
Slot, reader-waiting: Exported classes
Slot, restarts: Exported classes
Slot, string: Exported classes
Slot, swank-version: Exported classes
string: Exported classes
swank-version: Exported classes

Jump to:   C   D   I   M   P   R   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   E   L   P   R   S   W  
Index Entry  Section

C
Class, connection: Exported classes
Class, debugger-event: Exported classes
Class, event: Exported classes
Class, read-string-event: Exported classes
Class, switch-package-event: Exported classes
Class, write-string-event: Exported classes
connection: Exported classes

D
debugger-event: Exported classes

E
event: Exported classes

L
lime: The lime system
lime: The lime package

P
Package, lime: The lime package

R
read-string-event: Exported classes

S
switch-package-event: Exported classes
System, lime: The lime system

W
write-string-event: Exported classes

Jump to:   C   D   E   L   P   R   S   W