The trivial-swank Reference Manual

Table of Contents

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

The trivial-swank Reference Manual

This is the trivial-swank Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:27:47 2018 GMT+0.


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

1 Introduction

TRIVIAL-SWANK

An experimental client for SWANK servers, written in Common Lisp.

For an example of how to use it, see the Subtext repl demo.

To start a swank server in a separate Lisp process, do something like:

sbcl --load "start-swank.lisp"

The Emacs slime log buffer is probably your best resource.

REFERENCES

(https://common-lisp.net/project/slime/)


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 trivial-swank

Author

StackSmith <fpgasm@apple2.x10.mx>

License

BSD simplified

Description

swank server communications

Dependencies
Source

trivial-swank.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 trivial-swank.asd

Location

trivial-swank.asd

Systems

trivial-swank (system)


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

3.1.2 trivial-swank/package.lisp

Parent

trivial-swank (system)

Location

package.lisp

Packages

trivial-swank


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

3.1.3 trivial-swank/utf8.lisp

Dependency

package.lisp (file)

Parent

trivial-swank (system)

Location

utf8.lisp

Internal Definitions

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

3.1.4 trivial-swank/trivial-swank.lisp

Dependency

utf8.lisp (file)

Parent

trivial-swank (system)

Location

trivial-swank.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 trivial-swank

low-level implementation of a client for the swank protocol.

Source

package.lisp (file)

Nickname

swa

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: connect CONNECTION &key FALLBACK OUT PACK

connect to the remote server and process requests, sending unknown forms to fallback processor.

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: disconnect CONNECTION
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: emacs-return-string CONNECTION STRING ID TAG

send a string to the server’s standard input.

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: emacs-rex CONNECTION STRING &key PROC THREAD
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: eval CONNECTION STRING &optional PROC

request a swank repl eval and return the id

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: get-historical-line CONNECTION ID
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: get-next-id CONNECTION

return the next continuation id

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: history-back CONNECTION

return prev historical string

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: history-forward CONNECTION
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: make-connection HOSTNAME PORT

create a connection to a remote swank server.

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: message-waiting-p CONNECTION

t if there’s a message in the connection waiting to be read, nil otherwise.

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: send-message-string CONNECTION STRING

send a message string to a swank connection.

Package

trivial-swank

Source

trivial-swank.lisp (file)


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

5.1.2 Generic functions

Generic Function: histid OBJECT
Generic Function: (setf histid) NEW-VALUE OBJECT
Package

trivial-swank

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

history-tracking id

Source

trivial-swank.lisp (file)

Generic Function: hostname OBJECT
Package

trivial-swank

Methods
Method: hostname (CONNECTION connection)

swank host

Source

trivial-swank.lisp (file)

Generic Function: pkg OBJECT
Generic Function: (setf pkg) NEW-VALUE OBJECT
Package

trivial-swank

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

the name of the connection’s package.

Source

trivial-swank.lisp (file)

Generic Function: port OBJECT
Package

trivial-swank

Methods
Method: port (CONNECTION connection)

swank port

Source

trivial-swank.lisp (file)

Generic Function: prompt OBJECT
Generic Function: (setf prompt) NEW-VALUE OBJECT
Package

trivial-swank

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

prompt to display

Source

trivial-swank.lisp (file)

Generic Function: rexs OBJECT
Generic Function: (setf rexs) NEW-VALUE OBJECT
Package

trivial-swank

Methods
Method: rexs (CONNECTION connection)

automatically generated reader method

Source

trivial-swank.lisp (file)

Method: (setf rexs) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

trivial-swank.lisp (file)


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

5.1.3 Classes

Class: connection ()

a swank protocol connection

Package

trivial-swank

Source

trivial-swank.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • rexs (method)
  • rexs (method)
  • thr (method)
  • thr (method)
  • state (method)
  • state (method)
  • socket (method)
  • socket (method)
  • rexid (method)
  • rexid (method)
  • histid (method)
  • histid (method)
  • prompt (method)
  • prompt (method)
  • pkg (method)
  • pkg (method)
  • port (method)
  • hostname (method)
Direct slots
Slot: hostname

swank host

Type

string

Initargs

:hostname

Readers

hostname (generic function)

Slot: port

swank port

Type

integer

Initargs

:port

Readers

port (generic function)

Slot: pkg

the name of the connection’s package.

Type

string

Initform

"common-lisp-user"

Readers

pkg (generic function)

Writers

(setf pkg) (generic function)

Slot: prompt

prompt to display

Type

string

Initform

"cl-user"

Readers

prompt (generic function)

Writers

(setf prompt) (generic function)

Slot: histid

history-tracking id

Type

fixnum

Readers

histid (generic function)

Writers

(setf histid) (generic function)

Slot: rexid

last-processed rex id

Type

fixnum

Readers

rexid (generic function)

Writers

(setf rexid) (generic function)

Slot: socket

the usocket socket.

Type

usocket:stream-usocket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: state

socket state

Readers

state (generic function)

Writers

(setf state) (generic function)

Slot: thr

thread used for listening

Readers

thr (generic function)

Writers

(setf thr) (generic function)

Slot: rexs
Readers

rexs (generic function)

Writers

(setf rexs) (generic function)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: copy-rex INSTANCE
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: default-fallback CONNECTION FORMS
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: default-rex-proc CONNECTION REPLY ID
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: make-rex &key (PACKAGE PACKAGE) (FORM FORM) (PROC PROC)
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: message-process CONNECTION MESSAGE-STR FALLBACK

process a message string.

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: read-packet STREAM

read a swank packet and convert payload to a lisp string.

Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: rex-form INSTANCE
Function: (setf rex-form) VALUE INSTANCE
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: rex-p OBJECT
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: rex-package INSTANCE
Function: (setf rex-package) VALUE INSTANCE
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: rex-proc INSTANCE
Function: (setf rex-proc) VALUE INSTANCE
Package

trivial-swank

Source

trivial-swank.lisp (file)

Function: utf8-decode VECTOR &key START END

Convert a UTF8 string to lisp

Package

trivial-swank

Source

utf8.lisp (file)

Function: utf8-encode STRING &key START END

Convert a lisp string to UTF

Package

trivial-swank

Source

utf8.lisp (file)

Function: write-packet STREAM STRING

write a string to a stream, prefixing it with length information for swank.

Package

trivial-swank

Source

trivial-swank.lisp (file)


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

5.2.2 Generic functions

Generic Function: rexid OBJECT
Generic Function: (setf rexid) NEW-VALUE OBJECT
Package

trivial-swank

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

last-processed rex id

Source

trivial-swank.lisp (file)

Generic Function: socket OBJECT
Generic Function: (setf socket) NEW-VALUE OBJECT
Package

trivial-swank

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

the usocket socket.

Source

trivial-swank.lisp (file)

Generic Function: state OBJECT
Generic Function: (setf state) NEW-VALUE OBJECT
Package

trivial-swank

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

socket state

Source

trivial-swank.lisp (file)

Generic Function: thr OBJECT
Generic Function: (setf thr) NEW-VALUE OBJECT
Package

trivial-swank

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

thread used for listening

Source

trivial-swank.lisp (file)


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

5.2.3 Structures

Structure: rex ()
Package

trivial-swank

Source

trivial-swank.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: package
Readers

rex-package (function)

Writers

(setf rex-package) (function)

Slot: form
Readers

rex-form (function)

Writers

(setf rex-form) (function)

Slot: proc
Readers

rex-proc (function)

Writers

(setf rex-proc) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trivial-swank.asd: The trivial-swank<dot>asd file
File, Lisp, trivial-swank/package.lisp: The trivial-swank/package<dot>lisp file
File, Lisp, trivial-swank/trivial-swank.lisp: The trivial-swank/trivial-swank<dot>lisp file
File, Lisp, trivial-swank/utf8.lisp: The trivial-swank/utf8<dot>lisp file

L
Lisp File, trivial-swank.asd: The trivial-swank<dot>asd file
Lisp File, trivial-swank/package.lisp: The trivial-swank/package<dot>lisp file
Lisp File, trivial-swank/trivial-swank.lisp: The trivial-swank/trivial-swank<dot>lisp file
Lisp File, trivial-swank/utf8.lisp: The trivial-swank/utf8<dot>lisp file

T
trivial-swank.asd: The trivial-swank<dot>asd file
trivial-swank/package.lisp: The trivial-swank/package<dot>lisp file
trivial-swank/trivial-swank.lisp: The trivial-swank/trivial-swank<dot>lisp file
trivial-swank/utf8.lisp: The trivial-swank/utf8<dot>lisp file

Jump to:   F   L   T  

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

A.2 Functions

Jump to:   (  
C   D   E   F   G   H   M   P   R   S   T   U   W  
Index Entry  Section

(
(setf histid): Exported generic functions
(setf histid): Exported generic functions
(setf pkg): Exported generic functions
(setf pkg): Exported generic functions
(setf prompt): Exported generic functions
(setf prompt): Exported generic functions
(setf rex-form): Internal functions
(setf rex-package): Internal functions
(setf rex-proc): Internal functions
(setf rexid): Internal generic functions
(setf rexid): Internal generic functions
(setf rexs): Exported generic functions
(setf rexs): Exported generic functions
(setf socket): Internal generic functions
(setf socket): Internal generic functions
(setf state): Internal generic functions
(setf state): Internal generic functions
(setf thr): Internal generic functions
(setf thr): Internal generic functions

C
connect: Exported functions
copy-rex: Internal functions

D
default-fallback: Internal functions
default-rex-proc: Internal functions
disconnect: Exported functions

E
emacs-return-string: Exported functions
emacs-rex: Exported functions
eval: Exported functions

F
Function, (setf rex-form): Internal functions
Function, (setf rex-package): Internal functions
Function, (setf rex-proc): Internal functions
Function, connect: Exported functions
Function, copy-rex: Internal functions
Function, default-fallback: Internal functions
Function, default-rex-proc: Internal functions
Function, disconnect: Exported functions
Function, emacs-return-string: Exported functions
Function, emacs-rex: Exported functions
Function, eval: Exported functions
Function, get-historical-line: Exported functions
Function, get-next-id: Exported functions
Function, history-back: Exported functions
Function, history-forward: Exported functions
Function, make-connection: Exported functions
Function, make-rex: Internal functions
Function, message-process: Internal functions
Function, message-waiting-p: Exported functions
Function, read-packet: Internal functions
Function, rex-form: Internal functions
Function, rex-p: Internal functions
Function, rex-package: Internal functions
Function, rex-proc: Internal functions
Function, send-message-string: Exported functions
Function, utf8-decode: Internal functions
Function, utf8-encode: Internal functions
Function, write-packet: Internal functions

G
Generic Function, (setf histid): Exported generic functions
Generic Function, (setf pkg): Exported generic functions
Generic Function, (setf prompt): Exported generic functions
Generic Function, (setf rexid): Internal generic functions
Generic Function, (setf rexs): Exported generic functions
Generic Function, (setf socket): Internal generic functions
Generic Function, (setf state): Internal generic functions
Generic Function, (setf thr): Internal generic functions
Generic Function, histid: Exported generic functions
Generic Function, hostname: Exported generic functions
Generic Function, pkg: Exported generic functions
Generic Function, port: Exported generic functions
Generic Function, prompt: Exported generic functions
Generic Function, rexid: Internal generic functions
Generic Function, rexs: Exported generic functions
Generic Function, socket: Internal generic functions
Generic Function, state: Internal generic functions
Generic Function, thr: Internal generic functions
get-historical-line: Exported functions
get-next-id: Exported functions

H
histid: Exported generic functions
histid: Exported generic functions
history-back: Exported functions
history-forward: Exported functions
hostname: Exported generic functions
hostname: Exported generic functions

M
make-connection: Exported functions
make-rex: Internal functions
message-process: Internal functions
message-waiting-p: Exported functions
Method, (setf histid): Exported generic functions
Method, (setf pkg): Exported generic functions
Method, (setf prompt): Exported generic functions
Method, (setf rexid): Internal generic functions
Method, (setf rexs): Exported generic functions
Method, (setf socket): Internal generic functions
Method, (setf state): Internal generic functions
Method, (setf thr): Internal generic functions
Method, histid: Exported generic functions
Method, hostname: Exported generic functions
Method, pkg: Exported generic functions
Method, port: Exported generic functions
Method, prompt: Exported generic functions
Method, rexid: Internal generic functions
Method, rexs: Exported generic functions
Method, socket: Internal generic functions
Method, state: Internal generic functions
Method, thr: Internal generic functions

P
pkg: Exported generic functions
pkg: Exported generic functions
port: Exported generic functions
port: Exported generic functions
prompt: Exported generic functions
prompt: Exported generic functions

R
read-packet: Internal functions
rex-form: Internal functions
rex-p: Internal functions
rex-package: Internal functions
rex-proc: Internal functions
rexid: Internal generic functions
rexid: Internal generic functions
rexs: Exported generic functions
rexs: Exported generic functions

S
send-message-string: Exported functions
socket: Internal generic functions
socket: Internal generic functions
state: Internal generic functions
state: Internal generic functions

T
thr: Internal generic functions
thr: Internal generic functions

U
utf8-decode: Internal functions
utf8-encode: Internal functions

W
write-packet: Internal functions

Jump to:   (  
C   D   E   F   G   H   M   P   R   S   T   U   W  

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

A.3 Variables

Jump to:   F   H   P   R   S   T  
Index Entry  Section

F
form: Internal structures

H
histid: Exported classes
hostname: Exported classes

P
package: Internal structures
pkg: Exported classes
port: Exported classes
proc: Internal structures
prompt: Exported classes

R
rexid: Exported classes
rexs: Exported classes

S
Slot, form: Internal structures
Slot, histid: Exported classes
Slot, hostname: Exported classes
Slot, package: Internal structures
Slot, pkg: Exported classes
Slot, port: Exported classes
Slot, proc: Internal structures
Slot, prompt: Exported classes
Slot, rexid: Exported classes
Slot, rexs: Exported classes
Slot, socket: Exported classes
Slot, state: Exported classes
Slot, thr: Exported classes
socket: Exported classes
state: Exported classes

T
thr: Exported classes

Jump to:   F   H   P   R   S   T  

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

A.4 Data types

Jump to:   C   P   R   S   T  
Index Entry  Section

C
Class, connection: Exported classes
connection: Exported classes

P
Package, trivial-swank: The trivial-swank package

R
rex: Internal structures

S
Structure, rex: Internal structures
System, trivial-swank: The trivial-swank system

T
trivial-swank: The trivial-swank system
trivial-swank: The trivial-swank package

Jump to:   C   P   R   S   T