The swank Reference Manual

This is the swank Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:43:25 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 swank

Source

swank.asd.

Child Components

3 Modules

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


3.1 swank/backend

Source

swank.asd.

Parent Component

swank (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 swank/swank.asd

Source

swank.asd.

Parent Component

swank (system).

ASDF Systems

swank.


4.1.2 swank/swank-loader.lisp

Source

swank.asd.

Parent Component

swank (system).

Packages

swank-loader.

Public Interface
Internals

4.1.3 swank/packages.lisp

Source

swank.asd.

Parent Component

swank (system).

Packages

4.1.4 swank/xref.lisp

If Feature

:clisp

Source

swank.asd.

Parent Component

swank (system).


4.1.5 swank/metering.lisp

If Feature

(:or :clozure :clisp :clasp)

Source

swank.asd.

Parent Component

swank (system).


4.1.6 swank/backend/backend.lisp

Source

swank.asd.

Parent Component

backend (module).

Public Interface
Internals

4.1.7 swank/backend/source-path-parser.lisp

If Feature

(:or :cmu :scl :sbcl)

Source

swank.asd.

Parent Component

backend (module).

Packages

swank/source-path-parser.

Public Interface
Internals

4.1.8 swank/backend/source-file-cache.lisp

If Feature

(:or :cmu :scl :sbcl)

Source

swank.asd.

Parent Component

backend (module).

Packages

swank/source-file-cache.

Public Interface
Internals

4.1.9 swank/backend/cmucl.lisp

If Feature

:cmu

Source

swank.asd.

Parent Component

backend (module).


4.1.10 swank/backend/scl.lisp

If Feature

:scl

Source

swank.asd.

Parent Component

backend (module).


4.1.11 swank/backend/sbcl.lisp

If Feature

:sbcl

Source

swank.asd.

Parent Component

backend (module).

Packages

swank/sbcl.

Public Interface
Internals

4.1.12 swank/backend/ccl.lisp

If Feature

:clozure

Source

swank.asd.

Parent Component

backend (module).


4.1.13 swank/backend/lispworks.lisp

If Feature

:lispworks

Source

swank.asd.

Parent Component

backend (module).


4.1.14 swank/backend/allegro.lisp

If Feature

:allegro

Source

swank.asd.

Parent Component

backend (module).


4.1.15 swank/backend/clisp.lisp

If Feature

:clisp

Source

swank.asd.

Parent Component

backend (module).


4.1.16 swank/backend/abcl.lisp

If Feature

:armedbear

Source

swank.asd.

Parent Component

backend (module).


4.1.17 swank/backend/corman.lisp

If Feature

:cormanlisp

Source

swank.asd.

Parent Component

backend (module).


4.1.18 swank/backend/ecl.lisp

If Feature

:ecl

Source

swank.asd.

Parent Component

backend (module).


4.1.19 swank/backend/clasp.lisp

If Feature

:clasp

Source

swank.asd.

Parent Component

backend (module).


4.1.20 swank/backend/mkcl.lisp

If Feature

:mkcl

Source

swank.asd.

Parent Component

backend (module).


4.1.21 swank/backend/mezzano.lisp

If Feature

:mezzano

Source

swank.asd.

Parent Component

backend (module).


4.1.22 swank/backend/gray.lisp

Source

swank.asd.

Parent Component

backend (module).

Packages

swank/gray.

Public Interface
Internals

4.1.23 swank/backend/match.lisp

Source

swank.asd.

Parent Component

backend (module).

Public Interface

match (macro).

Internals

4.1.24 swank/backend/rpc.lisp

Source

swank.asd.

Parent Component

backend (module).

Public Interface
Internals

4.1.25 swank/swank.lisp

Source

swank.asd.

Parent Component

swank (system).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 swank/source-path-parser

Source

source-path-parser.lisp.

Use List

common-lisp.

Used By List

swank/sbcl.

Public Interface
Internals

5.2 swank/source-file-cache

Source

source-file-cache.lisp.

Use List

common-lisp.

Used By List

swank/sbcl.

Public Interface
Internals

5.3 swank

Source

packages.lisp.

Use List
Public Interface
Internals

5.4 swank/gray

Source

gray.lisp.

Use List
Internals

5.5 swank-mop

Source

packages.lisp.

Public Interface

slot-definition-documentation (function).


5.6 swank-loader

Source

swank-loader.lisp.

Use List

common-lisp.

Public Interface
Internals

5.7 swank/sbcl

Source

sbcl.lisp.

Use List
Internals

5.8 swank/match

Source

packages.lisp.

Use List

common-lisp.

Used By List

swank.

Public Interface

match (macro).

Internals

5.9 swank/rpc

Source

packages.lisp.

Use List

common-lisp.

Used By List

swank.

Public Interface
Internals

5.10 swank/backend

Source

packages.lisp.

Nickname

swank-backend

Use List

common-lisp.

Used By List
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *after-toggle-trace-hook*

Hook called whenever a SPEC is traced or untraced.

If non-nil, called with two arguments SPEC and TRACED-P.

Package

swank.

Source

swank.lisp.

Special Variable: *auto-flush-interval*
Package

swank/backend.

Source

backend.lisp.

Special Variable: *backtrace-printer-bindings*

Pretter settings for printing backtraces.

Package

swank.

Source

swank.lisp.

Special Variable: *communication-style*
Package

swank.

Source

swank.lisp.

Special Variable: *configure-emacs-indentation*

When true, automatically send indentation information to Emacs after each command.

Package

swank.

Source

swank.lisp.

Special Variable: *debug-swank-backend*

If this is true, backends should not catch errors but enter the debugger where appropriate. Also, they should not perform backtrace magic but really show every frame including SWANK related ones.

Package

swank/backend.

Source

backend.lisp.

Special Variable: *default-worker-thread-bindings*

An alist to initialize dynamic variables in worker threads.
The list has the form ((VAR . VALUE) ...). Each variable VAR will be bound to the corresponding VALUE.

Package

swank.

Source

swank.lisp.

Special Variable: *dont-close*

Default value of :dont-close argument to start-server and create-server.

Package

swank.

Source

swank.lisp.

Special Variable: *fasl-directory*

The directory where fasl files should be placed.

Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *fasl-pathname-function*

In non-nil, use this function to compute the name for fasl-files.

Package

swank.

Source

swank.lisp.

Special Variable: *find-definitions-left-trim*
Package

swank.

Source

swank.lisp.

Special Variable: *find-definitions-right-trim*
Package

swank.

Source

swank.lisp.

Special Variable: *global-debugger*

Non-nil means the Swank debugger hook will be installed globally.

Package

swank.

Source

swank.lisp.

Special Variable: *inspector-verbose*
Package

swank.

Source

swank.lisp.

Special Variable: *interrupt-queued-handler*

Function to call on queued interrupts.
Interrupts get queued when an interrupt occurs while interrupt handling is disabled.

Backends can use this function to abort slow operations.

Package

swank/backend.

Source

backend.lisp.

Special Variable: *log-events*
Package

swank.

Source

swank.lisp.

Special Variable: *log-output*
Package

swank/backend.

Source

backend.lisp.

Special Variable: *macroexpand-printer-bindings*
Package

swank.

Source

swank.lisp.

Special Variable: *pending-slime-interrupts*
Package

swank/backend.

Source

backend.lisp.

Special Variable: *readtable-alist*

An alist mapping package names to readtables.

Package

swank.

Source

swank.lisp.

Special Variable: *sldb-quit-restart*

The restart that will be invoked when the user calls sldb-quit.

Package

swank.

Source

swank.lisp.

Special Variable: *source-directory*

The directory where to look for the source.

Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *source-snippet-size*

Maximum number of characters in a snippet of source code. Snippets at the beginning of definitions are used to tell Emacs what the definitions looks like, so that it can accurately find them by text search.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Special Variable: *started-from-emacs*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *swank-debugger-condition*

The condition being debugged.

Package

swank.

Source

swank.lisp.

Special Variable: *swank-pprint-bindings*

A list of variables bindings during pretty printing. Used by pprint-eval.

Package

swank.

Source

swank.lisp.


6.1.2 Macros

Macro: converting-errors-to-error-location (&body body)

Catches errors during BODY and converts them to an error location.

Package

swank/backend.

Source

backend.lisp.

Macro: defimplementation (name args &body body)
Package

swank/backend.

Source

backend.lisp.

Macro: define-package (package &rest options)

This is like CL:DEFPACKAGE but silences warnings and errors signalled when the redefined package is at variance with the current state of the package. Typically this situation occurs when symbols are exported by calling EXPORT (as is the case with DEFSECTION) as opposed to adding :EXPORT forms to the DEFPACKAGE form and the package definition is subsequently reevaluated. See the section on [package variance](http://www.sbcl.org/manual/#Package-Variance) in the SBCL manual.

Package

swank-loader.

Source

swank-loader.lisp.

Macro: label-value-line* (&rest label-values)
Package

swank/backend.

Source

backend.lisp.

Macro: match (expression &body patterns)
Package

swank/match.

Source

match.lisp.

Macro: when-let ((var value) &body body)
Package

swank/backend.

Source

backend.lisp.

Macro: with-collected-macro-forms ((forms &optional result) instrumented-form &body body)

Collect macro forms by locally binding *MACROEXPAND-HOOK*.

Evaluates INSTRUMENTED-FORM and collects any forms which undergo macro-expansion into a list. Then evaluates BODY with FORMS bound to the list of forms, and RESULT (optionally) bound to the value of INSTRUMENTED-FORM.

Package

swank/backend.

Source

backend.lisp.

Macro: with-compilation-hooks ((&rest ignore) &body body)

Execute BODY as in CALL-WITH-COMPILATION-HOOKS.

Package

swank/backend.

Source

backend.lisp.

Macro: with-lock (lock &body body)
Package

swank/backend.

Source

backend.lisp.

Macro: with-struct ((conc-name &rest names) obj &body body)

Like with-slots but works only for structs.

Package

swank/backend.

Source

backend.lisp.


6.1.3 Ordinary functions

Function: accept-connection (socket &key external-format buffering timeout)

Accept a client connection on the listening socket SOCKET. Return a stream for the new connection.
If EXTERNAL-FORMAT is nil return a binary stream otherwise create a character stream.
BUFFERING can be one of:
nil ... no buffering
t ... enable buffering
:line ... enable buffering with automatic flushing on eol.

Package

swank/backend.

Source

backend.lisp.

Function: activate-stepping (frame-number)

Prepare the frame FRAME-NUMBER for stepping.

Package

swank/backend.

Source

backend.lisp.

Function: add-fd-handler (socket fn)

Call FN when Lisp is waiting for input and SOCKET is readable.

Package

swank/backend.

Source

backend.lisp.

Function: add-sigio-handler (socket fn)

Call FN whenever SOCKET is readable.

Package

swank/backend.

Source

backend.lisp.

Function: all-threads ()

Return a fresh list of all threads.

Package

swank/backend.

Source

backend.lisp.

Function: apropos-list-for-emacs (name &optional external-only case-sensitive package)

Make an apropos search for Emacs. The result is a list of property lists.

Package

swank.

Source

swank.lisp.

Function: arglist (name)

Return the lambda list for the symbol NAME. NAME can also be a lisp function object, on lisps which support this.

The result can be a list or the :not-available keyword if the arglist cannot be determined.

Package

swank/backend.

Source

backend.lisp.

Function: augment-features ()

*features* or something else

Package

swank/backend.

Source

backend.lisp.

Function: auto-flush-loop (stream interval &optional receive flush)
Package

swank/backend.

Source

backend.lisp.

Function: background-save-image (filename &key restart-function completion-function)

Request saving a heap image to the file FILENAME.
RESTART-FUNCTION, if non-nil, should be called when the image is loaded. COMPLETION-FUNCTION, if non-nil, should be called after saving the image.

Package

swank/backend.

Source

backend.lisp.

Function: backtrace (start end)

Return a list ((I FRAME PLIST) ...) of frames from START to END.

I is an integer, and can be used to reference the corresponding frame from Emacs; FRAME is a string representation of an implementation’s frame.

Package

swank.

Source

swank.lisp.

Function: boolean-to-feature-expression (value)

Converts a boolean VALUE to a form suitable for testing with #+.

Package

swank/backend.

Source

backend.lisp.

Function: buffer-first-change (filename)

Called for effect the first time FILENAME’s buffer is modified. CMUCL/SBCL use this to cache the unmodified file and use the unmodified text to improve the precision of source locations.

Package

swank/backend.

Source

backend.lisp.

Function: call-with-compilation-hooks (func)

Call FUNC with hooks to record compiler conditions.

Package

swank/backend.

Source

backend.lisp.

Function: call-with-debugger-hook (hook fun)

Call FUN and use HOOK as debugger hook. HOOK can be NIL.

HOOK should be called for both BREAK and INVOKE-DEBUGGER.

Package

swank/backend.

Source

backend.lisp.

Function: call-with-debugging-environment (debugger-loop-fn)

Call DEBUGGER-LOOP-FN in a suitable debugging environment.

This function is called recursively at each debug level to invoke the debugger loop. The purpose is to setup any necessary environment for other debugger callbacks that will be called within the debugger loop.

For example, this is a reasonable place to compute a backtrace, switch to safe reader/printer settings, and so on.

Package

swank/backend.

Source

backend.lisp.

Function: call-with-lock-held (lock function)

Call FUNCTION with LOCK held, queueing if necessary.

Package

swank/backend.

Source

backend.lisp.

Function: call-with-syntax-hooks (fn)

Call FN with hooks to handle special syntax.

Package

swank/backend.

Source

backend.lisp.

Function: call-with-user-break-handler (handler function)

Install the break handler HANDLER while executing FUNCTION.

Package

swank/backend.

Source

backend.lisp.

Function: calls-who (function-name)

Return the call sites of FUNCTION-NAME (a symbol). The results is a list ((DSPEC LOCATION) ...).

Package

swank/backend.

Source

backend.lisp.

Function: character-completion-set (prefix matchp)

Return a list of names of characters that match PREFIX.

Package

swank/backend.

Source

backend.lisp.

Function: check-slime-interrupts ()

Execute pending interrupts if any.
This should be called periodically in operations which
can take a long time to complete.
Return a boolean indicating whether any interrupts was processed.

Package

swank/backend.

Source

backend.lisp.

Function: choose-symbol (package name alt-package alt-name)

If symbol package:name exists return that symbol, otherwise alt-package:alt-name. Suitable for use with #.

Package

swank/backend.

Source

backend.lisp.

Function: close-socket (socket)

Close the socket SOCKET.

Package

swank/backend.

Source

backend.lisp.

Function: collect-macro-forms (form &optional env)

Collect subforms of FORM which undergo (compiler-)macro expansion. Returns two values: a list of macro forms and a list of compiler macro forms.

Package

swank/backend.

Source

backend.lisp.

Function: command-line-args ()

Return a list of strings as passed by the OS.

Package

swank/backend.

Source

backend.lisp.

Function: commit-edited-value (form value)

Set the value of a setf’able FORM to VALUE. FORM and VALUE are both strings from Emacs.

Package

swank.

Source

swank.lisp.

Function: compile-file-for-emacs (filename load-p &rest options)

Compile FILENAME and, when LOAD-P, load the result. Record compiler notes signalled as ‘compiler-condition’s.

Package

swank.

Source

swank.lisp.

Function: compile-file-if-needed (filename loadp)
Package

swank.

Source

swank.lisp.

Function: compile-multiple-strings-for-emacs (strings policy)

Compile STRINGS (exerpted from BUFFER at POSITION). Record compiler notes signalled as ‘compiler-condition’s.

Package

swank.

Source

swank.lisp.

Function: compile-string-for-emacs (string buffer position filename policy)

Compile STRING (exerpted from BUFFER at POSITION). Record compiler notes signalled as ‘compiler-condition’s.

Package

swank.

Source

swank.lisp.

Function: compiler-macroexpand (form &optional env)

Repetitively call ‘compiler-macroexpand-1’.

Package

swank/backend.

Source

backend.lisp.

Function: compiler-macroexpand-1 (form &optional env)

Call the compiler-macro for form.
If FORM is a function call for which a compiler-macro has been defined, invoke the expander function using *macroexpand-hook* and return the results and T. Otherwise, return the original form and NIL.

Package

swank/backend.

Source

backend.lisp.

Function: compute-backtrace (start end)

Returns a backtrace of the condition currently being debugged, that is an ordered list consisting of frames. “Ordered list” means that an integer I can be mapped back to the i-th frame of this backtrace.

START and END are zero-based indices constraining the number of frames returned. Frame zero is defined as the frame which invoked the debugger. If END is nil, return the frames from START to the end of the stack.

Package

swank/backend.

Source

backend.lisp.

Function: condition-extras (condition)

Return a list of extra for the debugger. The allowed elements are of the form: (:SHOW-FRAME-SOURCE frame-number) (:REFERENCES &rest refs)

Package

swank/backend.

Source

backend.lisp.

Function: connection-info ()

Return a key-value list of the form:
(&key PID STYLE LISP-IMPLEMENTATION MACHINE FEATURES PACKAGE VERSION) PID: is the process-id of Lisp process (or nil, depending on the STYLE) STYLE: the communication style
LISP-IMPLEMENTATION: a list (&key TYPE NAME VERSION)
FEATURES: a list of keywords
PACKAGE: a list (&key NAME PROMPT)
VERSION: the protocol version

Package

swank.

Source

swank.lisp.

Function: create-server (&key port style dont-close interface backlog)

Start a SWANK server on PORT running in STYLE.
If DONT-CLOSE is true then the listen socket will accept multiple connections, otherwise it will be closed after the first.

Optionally, an INTERFACE could be specified and swank will bind the PORT on this interface. By default, interface is "localhost".

Package

swank.

Source

swank.lisp.

Function: create-socket (host port &key backlog)

Create a listening TCP socket on interface HOST and port PORT. BACKLOG queue length for incoming connections.

Package

swank/backend.

Source

backend.lisp.

Function: current-thread ()

Return the currently executing thread.

Package

swank/backend.

Source

backend.lisp.

Function: debug-nth-thread (index)
Package

swank.

Source

swank.lisp.

Function: debug-on-swank-error ()
Package

swank.

Source

swank.lisp.

Function: (setf debug-on-swank-error) ()
Package

swank.

Source

swank.lisp.

Function: debugger-info-for-emacs (start end)

Return debugger state, with stack frames from START to END.
The result is a list:
(condition ({restart}*) ({stack-frame}*) (cont*))
where
condition ::= (description type [extra])
restart ::= (name description)
stack-frame ::= (number description [plist])
extra ::= (:references and other random things)
cont ::= continutation
plist ::= (:restartable {nil | t | :unknown})

condition—a pair of strings: message, and type. If show-source is not nil it is a frame number for which the source should be displayed.

restart—a pair of strings: restart name, and description.

stack-frame—a number from zero (the top), and a printed representation of the frame’s call.

continutation—the id of a pending Emacs continuation.

Below is an example return value. In this case the condition was a division by zero (multi-line description), and only one frame is being fetched (start=0, end=1).

(("Arithmetic error DIVISION-BY-ZERO signalled.
Operation was KERNEL::DIVISION, operands (1 0)."
"[Condition of type DIVISION-BY-ZERO]")
(("ABORT" "Return to Slime toplevel.")
("ABORT" "Return to Top-Level."))
((0 "(KERNEL::INTEGER-/-INTEGER 1 0)" (:restartable nil))) (4))

Package

swank.

Source

swank.lisp.

Function: default-directory ()

Return the default directory.

Package

swank/backend.

Source

backend.lisp.

Function: default-readtable-alist ()

Return a suitable initial value for SWANK:*READTABLE-ALIST*.

Package

swank/backend.

Source

backend.lisp.

Function: deinit-log-output ()
Package

swank/backend.

Source

backend.lisp.

Function: describe-definition (name type)

Describe the definition NAME of TYPE.
TYPE can be any value returned by DESCRIBE-SYMBOL-FOR-EMACS.

Return a documentation string, or NIL if none is available.

Package

swank/backend.

Source

backend.lisp.

Function: describe-definition-for-emacs (name kind)
Package

swank.

Source

swank.lisp.

Function: describe-function (name)
Package

swank.

Source

swank.lisp.

Function: describe-inspectee ()

Describe the currently inspected object.

Package

swank.

Source

swank.lisp.

Function: describe-primitive-type (object)

Return a string describing the primitive type of object.

Package

swank/backend.

Source

backend.lisp.

Function: describe-symbol (symbol-name)
Package

swank.

Source

swank.lisp.

Function: describe-symbol-for-emacs (symbol)

Return a property list describing SYMBOL.

The property list has an entry for each interesting aspect of the symbol. The recognised keys are:

:VARIABLE :FUNCTION :SETF :SPECIAL-OPERATOR :MACRO :COMPILER-MACRO :TYPE :CLASS :ALIEN-TYPE :ALIEN-STRUCT :ALIEN-UNION :ALIEN-ENUM

The value of each property is the corresponding documentation string, or NIL (or the obsolete :NOT-DOCUMENTED). It is legal to include keys not listed here (but slime-print-apropos in Emacs must know about them).

Properties should be included if and only if they are applicable to the symbol. For example, only (and all) fbound symbols should include the :FUNCTION property.

Example:
(describe-symbol-for-emacs ’vector)
=> (:CLASS :NOT-DOCUMENTED
:TYPE :NOT-DOCUMENTED
:FUNCTION "Constructs a simple-vector from the given objects.")

Package

swank/backend.

Source

backend.lisp.

Function: disassemble-form (form)
Package

swank.

Source

swank.lisp.

Function: disassemble-frame (frame-number)

Disassemble the code for the FRAME-NUMBER. The output should be written to standard output. FRAME-NUMBER is a non-negative integer.

Package

swank/backend.

Source

backend.lisp.

Function: documentation-symbol (symbol-name)
Package

swank.

Source

swank.lisp.

Function: dump-image (filename)
Package

swank-loader.

Source

swank-loader.lisp.

Function: dup (fd)

Duplicate a file descriptor.
If the syscall fails, signal a condition. See dup(2).

Package

swank/backend.

Source

backend.lisp.

Function: ed-in-emacs (&optional what)

Edit WHAT in Emacs.

WHAT can be:
A pathname or a string,
A list (PATHNAME-OR-STRING &key LINE COLUMN POSITION), A function name (symbol or cons),
NIL.

Package

swank.

Source

swank.lisp.

Function: ed-rpc (fn &rest args)

Invoke FN in Emacs (or some lesser editor). FN should be defined in Emacs Lisp via ‘defslimefun’ or otherwise marked as RPCallable.

Package

swank.

Source

swank.lisp.

Function: ed-rpc-no-wait (fn &rest args)

Invoke FN in Emacs (or some lesser editor) and don’t wait for the result.

Package

swank.

Source

swank.lisp.

Function: emacs-connected ()

Hook called when the first connection from Emacs is established. Called from the INIT-FN of the socket server that accepts the connection.

This is intended for setting up extra context, e.g. to discover that the calling thread is the one that interacts with Emacs.

Package

swank/backend.

Source

backend.lisp.

Function: eval-and-grab-output (string)
Package

swank.

Source

swank.lisp.

Function: eval-context (object)

Return a list of bindings corresponding to OBJECT’s slots.

Package

swank/backend.

Source

backend.lisp.

Function: eval-for-emacs (form buffer-package id)

Bind *BUFFER-PACKAGE* to BUFFER-PACKAGE and evaluate FORM. Return the result to the continuation ID.
Errors are trapped and invoke our debugger.

Package

swank.

Source

swank.lisp.

Function: eval-in-emacs (form &optional nowait)

Eval FORM in Emacs.
‘slime-enable-evaluate-in-emacs’ should be set to T on the Emacs side.

Package

swank.

Source

swank.lisp.

Function: eval-in-frame (form frame-number)

Evaluate a Lisp form in the lexical context of a stack frame in the debugger.

FRAME-NUMBER must be a positive integer with 0 indicating the frame which invoked the debugger.

The return value is the result of evaulating FORM in the appropriate context.

Package

swank/backend.

Source

backend.lisp.

Function: eval-string-in-frame (string frame package)
Package

swank.

Source

swank.lisp.

Function: exec-image (image-file args)

Replace the current process with a new process image. The new image is created by loading the previously dumped core file IMAGE-FILE.
ARGS is a list of strings passed as arguments to
the new image.
This is thin wrapper around exec(3).

Package

swank/backend.

Source

backend.lisp.

Function: filename-to-pathname (filename)

Return a pathname for FILENAME.
A filename in Emacs may for example contain asterisks which should not be translated to wildcards.

Package

swank/backend.

Source

backend.lisp.

Function: find-definition-for-thing (thing)
Package

swank.

Source

swank.lisp.

Function: find-definitions (name)

Return a list ((DSPEC LOCATION) ...) for NAME’s definitions.

NAME is a "definition specifier".

DSPEC is a "definition specifier" describing the definition, e.g., FOO or (METHOD FOO (STRING NUMBER)) or (DEFVAR FOO).

LOCATION is the source location for the definition.

Package

swank/backend.

Source

backend.lisp.

Function: find-definitions-for-emacs (name)

Return a list ((DSPEC LOCATION) ...) of definitions for NAME. DSPEC is a string and LOCATION a source location. NAME is a string.

Package

swank.

Source

swank.lisp.

Function: find-external-format (coding-system)

Return a "external file format designator" for CODING-SYSTEM. CODING-SYSTEM is Emacs-style coding system name (a string), e.g. "latin-1-unix".

Package

swank/backend.

Source

backend.lisp.

Function: find-locally-nicknamed-package (name base-package)

Return the package whose local nickname in BASE-PACKAGE matches NAME. Return NIL if local nicknames are not implemented or if there is no such package.

Package

swank/backend.

Source

backend.lisp.

Function: find-registered (name)

Find the thread that was registered for the symbol NAME. Return nil if the no thread was registred or if the tread is dead.

Package

swank/backend.

Source

backend.lisp.

Function: find-source-location (object)

Returns the source location of OBJECT, or NIL.

That is the source location of the underlying datastructure of OBJECT. E.g. on a STANDARD-OBJECT, the source location of the respective DEFCLASS definition is returned, on a STRUCTURE-CLASS the respective DEFSTRUCT definition, and so on.

Package

swank/backend.

Source

backend.lisp.

Function: find-source-location-for-emacs (spec)
Package

swank.

Source

swank.lisp.

Function: find-thread (id)

Return the thread for ID.
ID should be an id previously obtained with THREAD-ID. Can return nil if the thread no longer exists.

Package

swank/backend.

Source

backend.lisp.

Function: float-infinity-p (float)

Return true if FLOAT is positive or negative infinity.

Package

swank/backend.

Source

backend.lisp.

Function: float-nan-p (float)

Return true if FLOAT is a NaN value (Not a Number).

Package

swank/backend.

Source

backend.lisp.

Function: flow-control-test (n delay)
Package

swank.

Source

swank.lisp.

Function: format-string-expand (control-string &optional env)

Expand the format string CONTROL-STRING.

Package

swank/backend.

Source

backend.lisp.

Function: frame-call (frame-number)

Return a string representing a call to the entry point of a frame.

Package

swank/backend.

Source

backend.lisp.

Function: frame-catch-tags (frame-number)

Return a list of catch tags for being printed in a debugger stack frame.

Package

swank/backend.

Source

backend.lisp.

Function: frame-locals (frame-number)

Return a list of ((&key NAME ID VALUE) ...) where each element of the list represents a local variable in the stack frame associated to FRAME-NUMBER.

NAME, a symbol; the name of the local variable.

ID, an integer; used as primary key for the local variable, unique relatively to the frame under operation.

value, an object; the value of the local variable.

Package

swank/backend.

Source

backend.lisp.

Function: frame-locals-and-catch-tags (index)

Return a list (LOCALS TAGS) for vars and catch tags in the frame INDEX. LOCALS is a list of the form ((&key NAME ID VALUE) ...).
TAGS has is a list of strings.

Package

swank.

Source

swank.lisp.

Function: frame-package (frame-number)

Return the package corresponding to the frame at FRAME-NUMBER. Return nil if the backend can’t figure it out.

Package

swank/backend.

Source

backend.lisp.

Function: frame-package-name (frame)
Package

swank.

Source

swank.lisp.

Function: frame-restartable-p (frame)

Is the frame FRAME restartable?.
Return T if ‘restart-frame’ can safely be called on the frame.

Package

swank/backend.

Source

backend.lisp.

Function: frame-source-location (frame-number)

Return the source location for the frame associated to FRAME-NUMBER.

Package

swank/backend.

Source

backend.lisp.

Function: frame-var-value (frame-number var-id)

Return the value of the local variable associated to VAR-ID relatively to the frame associated to FRAME-NUMBER.

Package

swank/backend.

Source

backend.lisp.

Function: from-string (string)

Read string in the *BUFFER-PACKAGE*

Package

swank.

Source

swank.lisp.

Function: function-name (function)

Return the name of the function object FUNCTION.

The result is either a symbol, a list, or NIL if no function name is available.

Package

swank/backend.

Source

backend.lisp.

Function: gdb-initial-commands ()

List of gdb commands supposed to be executed first for the ATTACH-GDB restart.

Package

swank/backend.

Source

backend.lisp.

Function: get-source-code (filename code-date)

Return the source code for FILENAME as written on DATE in a string.
If the exact version cannot be found then return the current one from disk.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: getpid ()

Return the (Unix) process ID of this superior Lisp.

Package

swank/backend.

Source

backend.lisp.

Function: gray-package-name ()

Return a package-name that contains the Gray stream symbols. This will be used like so:
(defpackage foo
(:import-from #.(gray-package-name) . #.*gray-stream-symbols*)

Package

swank/backend.

Source

backend.lisp.

Function: guess-external-format (pathname)

Detect the external format for the file with name pathname. Return nil if the file contains no special markers.

Package

swank/backend.

Source

backend.lisp.

Function: hash-table-weakness (hashtable)

Return nil or one of :key :value :key-or-value :key-and-value

Package

swank/backend.

Source

backend.lisp.

Function: import-swank-mop-symbols (package except)

Import the mop symbols from PACKAGE to SWANK-MOP. EXCEPT is a list of symbol names which should be ignored.

Package

swank/backend.

Source

backend.lisp.

Function: import-to-swank-mop (symbol-list)
Package

swank/backend.

Source

backend.lisp.

Function: init (&key delete reload load-contribs setup quiet from-emacs)

Load SWANK and initialize some global variables.
If DELETE is true, delete any existing SWANK packages.
If RELOAD is true, reload SWANK, even if the SWANK package already exists. If LOAD-CONTRIBS is true, load all contribs
If SETUP is true, load user init files and initialize some
global variabes in SWANK.

Package

swank-loader.

Source

swank-loader.lisp.

Function: init-inspector (string &optional definition)
Package

swank.

Source

swank.lisp.

Function: initialize-multiprocessing (continuation)

Initialize multiprocessing, if necessary and then invoke CONTINUATION.

Depending on the impleimentaion, this function may never return.

Package

swank/backend.

Source

backend.lisp.

Function: inspect-current-condition ()
Package

swank.

Source

swank.lisp.

Function: inspect-frame-var (frame var)
Package

swank.

Source

swank.lisp.

Function: inspect-in-emacs (what &key wait)

Inspect WHAT in Emacs. If WAIT is true (default NIL) blocks until the inspector has been closed in Emacs.

Package

swank.

Source

swank.lisp.

Function: inspect-in-frame (string index)
Package

swank.

Source

swank.lisp.

Function: inspect-nth-part (index)
Package

swank.

Source

swank.lisp.

Function: inspector-call-nth-action (index &rest args)
Package

swank.

Source

swank.lisp.

Function: inspector-eval (string)
Package

swank.

Source

swank.lisp.

Function: inspector-history ()
Package

swank.

Source

swank.lisp.

Function: inspector-next ()

Inspect the next element in the history of inspected objects..

Package

swank.

Source

swank.lisp.

Function: inspector-nth-part (index)

Return the current inspector’s INDEXth part.
The second value indicates if that part exists at all.

Package

swank.

Source

swank.lisp.

Function: inspector-pop ()

Inspect the previous object.
Return nil if there’s no previous object.

Package

swank.

Source

swank.lisp.

Function: inspector-range (from to)
Package

swank.

Source

swank.lisp.

Function: inspector-reinspect ()
Package

swank.

Source

swank.lisp.

Function: inspector-toggle-verbose ()

Toggle verbosity of inspected object.

Package

swank.

Source

swank.lisp.

Function: install-debugger-globally (function)

Install FUNCTION as the debugger for all threads/processes. This usually involves setting *DEBUGGER-HOOK* and, if the implementation permits, hooking into BREAK as well.

Package

swank/backend.

Source

backend.lisp.

Function: install-sigint-handler (function)

Call FUNCTION on SIGINT (instead of invoking the debugger). Return old signal handler.

Package

swank/backend.

Source

backend.lisp.

Function: interactive-eval (string)
Package

swank.

Source

swank.lisp.

Function: interactive-eval-region (string)
Package

swank.

Source

swank.lisp.

Function: interrupt-thread (thread fn)

Cause THREAD to execute FN.

Package

swank/backend.

Source

backend.lisp.

Function: invoke-nth-restart (index)
Package

swank.

Source

swank.lisp.

Function: invoke-nth-restart-for-emacs (sldb-level n)

Invoke the Nth available restart.
SLDB-LEVEL is the debug level when the request was made. If this has changed, ignore the request.

Package

swank.

Source

swank.lisp.

Function: invoke-slime-debugger (condition)

Sends a message to Emacs declaring that the debugger has been entered, then waits to handle further requests from Emacs. Eventually returns after Emacs causes a restart to be invoked.

Package

swank.

Source

swank.lisp.

Function: io-speed-test (&optional n m)
Package

swank.

Source

swank.lisp.

Function: kill-nth-thread (index)
Package

swank.

Source

swank.lisp.

Function: kill-thread (thread)

Terminate THREAD immediately.
Don’t execute unwind-protected sections, don’t raise conditions. (Do not pass go, do not collect $200.)

Package

swank/backend.

Source

backend.lisp.

Function: label-value-line (label value &key newline)

Create a control list which prints "LABEL: VALUE" in the inspector. If NEWLINE is non-NIL a ‘(:newline)’ is added to the result.

Package

swank/backend.

Source

backend.lisp.

Function: lisp-implementation-program ()

Return the argv[0] of the running Lisp process, or NIL.

Package

swank/backend.

Source

backend.lisp.

Function: lisp-implementation-type-name ()

Return a short name for the Lisp implementation.

Package

swank/backend.

Source

backend.lisp.

Function: list-all-package-names (&optional nicknames)

Return a list of all package names. Include the nicknames if NICKNAMES is true.

Package

swank.

Source

swank.lisp.

Function: list-callees (function-name)

List the functions called by FUNCTION-NAME.
See LIST-CALLERS for a description of the return value.

Package

swank/backend.

Source

backend.lisp.

Function: list-callers (function-name)

List the callers of FUNCTION-NAME.
This function is like WHO-CALLS except that it is expected to use lower-level means. Whereas WHO-CALLS is usually implemented with special compiler support, LIST-CALLERS is usually implemented by groveling for constants in function objects throughout the heap.

The return value is as for WHO-CALLS.

Package

swank/backend.

Source

backend.lisp.

Function: list-fasls (&key include-contribs compile quiet)

List up SWANK’s fasls along with their dependencies.

Package

swank-loader.

Source

swank-loader.lisp.

Function: list-threads ()

Return a list (LABELS (ID NAME STATUS ATTRS ...) ...).
LABELS is a list of attribute names and the remaining lists are the corresponding attribute values per thread.
Example:
((:id :name :status :priority)
(6 "swank-indentation-cache-thread" "Semaphore timed wait" 0) (5 "reader-thread" "Active" 0)
(4 "control-thread" "Semaphore timed wait" 0)
(1 "listener" "Active" 0)
(0 "Initial" "Sleep" 0))

Package

swank.

Source

swank.lisp.

Function: load-file (filename)
Package

swank.

Source

swank.lisp.

Function: local-port (socket)

Return the local port number of SOCKET.

Package

swank/backend.

Source

backend.lisp.

Function: location-buffer (structure)
Package

swank/backend.

Source

backend.lisp.

Function: (setf location-buffer) (structure)
Package

swank/backend.

Source

backend.lisp.

Function: location-hints (structure)
Package

swank/backend.

Source

backend.lisp.

Function: (setf location-hints) (structure)
Package

swank/backend.

Source

backend.lisp.

Function: location-position (structure)
Package

swank/backend.

Source

backend.lisp.

Function: (setf location-position) (structure)
Package

swank/backend.

Source

backend.lisp.

Function: macroexpand-all (form &optional env)

Recursively expand all macros in FORM. Return the resulting form.

Package

swank/backend.

Source

backend.lisp.

Function: make-auto-flush-thread (stream)

Make an auto-flush thread

Package

swank/backend.

Source

backend.lisp.

Function: make-error-location (datum &rest args)
Package

swank/backend.

Source

backend.lisp.

Function: make-fd-stream (fd external-format)

Create a character stream for the file descriptor FD.

Package

swank/backend.

Source

backend.lisp.

Function: make-input-stream (read-string)

Return a new character input stream.
The stream calls READ-STRING when input is needed.

Package

swank/backend.

Source

backend.lisp.

Function: make-location (buffer position &optional hints)
Package

swank/backend.

Source

backend.lisp.

Function: make-lock (&key name)

Make a lock for thread synchronization.
Only one thread may hold the lock (via CALL-WITH-LOCK-HELD) at a time but that thread may hold it more than once.

Package

swank/backend.

Source

backend.lisp.

Function: make-output-function-for-target (connection target)

Create a function to send user output to a specific TARGET in Emacs.

Package

swank.

Source

swank.lisp.

Function: make-output-stream (write-string)

Return a new character output stream.
The stream calls WRITE-STRING when output is ready.

Package

swank/backend.

Source

backend.lisp.

Function: make-output-stream-for-target (connection target)

Create a stream that sends output to a specific TARGET in Emacs.

Package

swank.

Source

swank.lisp.

Function: make-weak-key-hash-table (&rest args)

Like MAKE-HASH-TABLE, but weak w.r.t. the keys.

Package

swank/backend.

Source

backend.lisp.

Function: make-weak-value-hash-table (&rest args)

Like MAKE-HASH-TABLE, but weak w.r.t. the values.

Package

swank/backend.

Source

backend.lisp.

Function: mop (type symbol-name)

Return info about classes using mop.

When type is:
:subclasses - return the list of subclasses of class. :superclasses - return the list of superclasses of class.

Package

swank.

Source

swank.lisp.

Function: operator-arglist (name package)
Package

swank.

Source

swank.lisp.

Function: package-local-nicknames (package)

Returns an alist of (local-nickname . actual-package) describing the nicknames local to the designated package.

Package

swank/backend.

Source

backend.lisp.

Function: parse-string (string package)

Read STRING in PACKAGE.

Package

swank.

Source

swank.lisp.

Function: pathname-to-filename (pathname)

Return the filename for PATHNAME.

Package

swank/backend.

Source

backend.lisp.

Function: ping (tag)
Package

swank.

Source

swank.lisp.

Function: pprint-eval (string)
Package

swank.

Source

swank.lisp.

Function: pprint-eval-string-in-frame (string frame package)
Package

swank.

Source

swank.lisp.

Function: pprint-inspector-part (index)

Pretty-print the currently inspected object.

Package

swank.

Source

swank.lisp.

Function: preferred-communication-style ()

Return one of the symbols :spawn, :sigio, :fd-handler, or NIL.

Package

swank/backend.

Source

backend.lisp.

Function: print-condition (condition stream)

Print a condition for display in SLDB.

Package

swank/backend.

Source

backend.lisp.

Function: print-frame (frame stream)

Print frame to stream.

Package

swank/backend.

Source

backend.lisp.

Function: print-indentation-lossage (&optional stream)

Return the list of symbols whose indentation styles collide incompatibly. Collisions are caused because package information is ignored.

Package

swank.

Source

swank.lisp.

Function: profile (fname)

Marks symbol FNAME for profiling.

Package

swank/backend.

Source

backend.lisp.

Function: profile-by-substring (substring package)
Package

swank.

Source

swank.lisp.

Function: profile-package (package callers-p methods)

Wrap profiling code around all functions in PACKAGE. If a function is already profiled, then unprofile and reprofile (useful to notice function redefinition.)

If CALLERS-P is T names have counts of the most common calling functions recorded.

When called with arguments :METHODS T, profile all methods of all generic functions having names in the given package. Generic functions themselves, that is, their dispatch functions, are left alone.

Package

swank/backend.

Source

backend.lisp.

Function: profile-report ()

Prints profile report.

Package

swank/backend.

Source

backend.lisp.

Function: profile-reset ()

Resets profile counters.

Package

swank/backend.

Source

backend.lisp.

Function: profiled-functions ()

Returns a list of profiled functions.

Package

swank/backend.

Source

backend.lisp.

Function: quit-inspector ()
Package

swank.

Source

swank.lisp.

Function: quit-lisp ()

Exit the current lisp image.

Package

swank/backend.

Source

backend.lisp.

Function: quit-thread-browser ()
Package

swank.

Source

swank.lisp.

Function: re-evaluate-defvar (form)
Package

swank.

Source

swank.lisp.

Function: read-message (stream package)
Package

swank/rpc.

Source

rpc.lisp.

Function: read-packet (stream)
Package

swank/rpc.

Source

rpc.lisp.

Function: read-snippet (stream &optional position)

Read a string of upto *SOURCE-SNIPPET-SIZE* characters from STREAM. If POSITION is given, set the STREAM’s file position first.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: read-snippet-from-string (string &optional position)
Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: read-source-form (n stream)

Read the Nth toplevel form number with source location recording. Return the form and the source-map.

Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: really-finish-output (stream)

Make an auto-flush thread

Package

swank/backend.

Source

backend.lisp.

Function: receive (&optional timeout)

Return the next message from current thread’s mailbox.

Package

swank/backend.

Source

backend.lisp.

Function: receive-if (predicate &optional timeout)

Return the first message satisfiying PREDICATE.

Package

swank/backend.

Source

backend.lisp.

Function: register-thread (name thread)

Associate the thread THREAD with the symbol NAME. The thread can then be retrieved with ‘find-registered’. If THREAD is nil delete the association.

Package

swank/backend.

Source

backend.lisp.

Function: remove-fd-handlers (socket)

Remove all fd-handlers for SOCKET.

Package

swank/backend.

Source

backend.lisp.

Function: remove-sigio-handlers (socket)

Remove all sigio handlers for SOCKET.

Package

swank/backend.

Source

backend.lisp.

Function: restart-frame (frame-number)

Restart execution of the frame FRAME-NUMBER with the same arguments as it was called originally.

Package

swank/backend.

Source

backend.lisp.

Function: restart-server (&key port style dont-close)

Stop the server listening on PORT, then start a new SWANK server
on PORT running in STYLE. If DONT-CLOSE is true then the listen socket will accept multiple connections, otherwise it will be closed after the first.

Package

swank.

Source

swank.lisp.

Function: return-from-frame (frame-number form)

Unwind the stack to the frame FRAME-NUMBER and return the value(s) produced by evaluating FORM in the frame context to its caller.

Execute any clean-up code from unwind-protect forms above the frame during unwinding.

Return a string describing the error if it’s not possible to return from the frame.

Package

swank/backend.

Source

backend.lisp.

Function: save-image (filename &optional restart-function)

Save a heap image to the file FILENAME.
RESTART-FUNCTION, if non-nil, should be called when the image is loaded.

Package

swank/backend.

Source

backend.lisp.

Function: sdlb-print-condition ()
Package

swank.

Source

swank.lisp.

Function: send (thread object)

Send OBJECT to thread THREAD.

Package

swank/backend.

Source

backend.lisp.

Function: set-default-directory (directory)

Set the default directory.
This is used to resolve filenames without directory component.

Package

swank/backend.

Source

backend.lisp.

Function: set-default-initial-binding (var form)

Initialize special variable VAR by default with FORM.

Some implementations initialize certain variables in each newly created thread. This function sets the form which is used to produce the initial value.

Package

swank/backend.

Source

backend.lisp.

Function: set-package (name)

Set *package* to the package named NAME.
Return the full package-name and the string to use in the prompt.

Package

swank.

Source

swank.lisp.

Function: set-stream-timeout (stream timeout)

Set the ’stream ’timeout. The timeout is either the real number specifying the timeout in seconds or ’nil for no timeout.

Package

swank/backend.

Source

backend.lisp.

Function: simple-break (&optional datum &rest args)
Package

swank.

Source

swank.lisp.

Function: simple-completions (prefix package)

Return a list of completions for the string PREFIX.

Package

swank.

Source

swank.lisp.

Function: sldb-abort ()
Package

swank.

Source

swank.lisp.

Function: sldb-break (name)
Package

swank.

Source

swank.lisp.

Function: sldb-break-at-start (symbol)

Set a breakpoint on the beginning of the function for SYMBOL.

Package

swank/backend.

Source

backend.lisp.

Function: sldb-break-on-return (frame-number)

Set a breakpoint in the frame FRAME-NUMBER.

Package

swank/backend.

Source

backend.lisp.

Function: sldb-break-with-default-debugger (dont-unwind)

Invoke the default debugger.

Package

swank.

Source

swank.lisp.

Function: sldb-continue ()
Package

swank.

Source

swank.lisp.

Function: sldb-disassemble (index)
Package

swank.

Source

swank.lisp.

Function: sldb-next (frame)
Package

swank.

Source

swank.lisp.

Function: sldb-out (frame)
Package

swank.

Source

swank.lisp.

Function: sldb-return-from-frame (index string)
Package

swank.

Source

swank.lisp.

Function: sldb-step (frame)
Package

swank.

Source

swank.lisp.

Function: sldb-step-into ()

Step into the current single-stepper form.

Package

swank/backend.

Source

backend.lisp.

Function: sldb-step-next ()

Step to the next form in the current function.

Package

swank/backend.

Source

backend.lisp.

Function: sldb-step-out ()

Stop single-stepping temporarily, but resume it once the current function returns.

Package

swank/backend.

Source

backend.lisp.

Function: sldb-stepper-condition-p (condition)

Return true if SLDB was invoked due to a single-stepping condition, false otherwise.

Package

swank/backend.

Source

backend.lisp.

Function: slot-definition-documentation (slot)
Package

swank-mop.

Source

sbcl.lisp.

Function: socket-fd (socket-stream)

Return the file descriptor for SOCKET-STREAM.

Package

swank/backend.

Source

backend.lisp.

Function: source-cache-get (filename date)

Return the source code for FILENAME as written on DATE in a string. Return NIL if the right version cannot be found.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: source-path-file-position (path filename)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: source-path-source-position (path form source-map)

Return the start position of PATH from FORM and SOURCE-MAP. All subforms along the path are considered and the start and end position of the deepest (i.e. smallest) possible form is returned.

Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: source-path-string-position (path string)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: spawn (fn &key name)

Create a new thread to call FN.

Package

swank/backend.

Source

backend.lisp.

Function: start-server (port-file &key style dont-close)

Start the server and write the listen port number to PORT-FILE. This is the entry point for Emacs.

Package

swank.

Source

swank.lisp.

Function: start-swank-server-in-thread (index port-file-name)

Interrupt the INDEXth thread and make it start a swank server. The server port is written to PORT-FILE-NAME.

Package

swank.

Source

swank.lisp.

Function: stop-server (port)

Stop server running on PORT.

Package

swank.

Source

swank.lisp.

Function: string-to-utf8 (string)

Convert the string STRING to a (simple-array (unsigned-byte 8))

Package

swank/backend.

Source

backend.lisp.

Function: swank-compile-file (input-file output-file load-p external-format &key policy)

Compile INPUT-FILE signalling COMPILE-CONDITIONs.
If LOAD-P is true, load the file after compilation. EXTERNAL-FORMAT is a value returned by find-external-format or :default.

If POLICY is supplied, and non-NIL, it may be used by certain implementations to compile with optimization qualities of its value.

Should return OUTPUT-TRUENAME, WARNINGS-P and FAILURE-p like ‘compile-file’

Package

swank/backend.

Source

backend.lisp.

Function: swank-compile-string (string &key buffer position filename line column policy)

Compile source from STRING.
During compilation, compiler conditions must be trapped and resignalled as COMPILER-CONDITIONs.

If supplied, BUFFER and POSITION specify the source location in Emacs.

Additionally, if POSITION is supplied, it must be added to source positions reported in compiler conditions.

If FILENAME is specified it may be used by certain implementations to rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of source information.

If POLICY is supplied, and non-NIL, it may be used by certain implementations to compile with optimization qualities of its value.

If LINE and COLUMN are supplied, and non-NIL, they may be used
by certain implementations as the line and column of the start of the string in FILENAME. Both LINE and COLUMN are 1-based.

Should return T on successful compilation, NIL otherwise.

Package

swank/backend.

Source

backend.lisp.

Function: swank-compiler-macroexpand (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-compiler-macroexpand-1 (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-debugger-hook (condition hook)

Debugger function for binding *DEBUGGER-HOOK*.

Package

swank.

Source

swank.lisp.

Function: swank-delete-package (package-name)
Package

swank.

Source

swank.lisp.

Function: swank-expand (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-expand-1 (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-format-string-expand (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-macroexpand (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-macroexpand-1 (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-macroexpand-all (string &optional environment)
Package

swank.

Source

swank.lisp.

Function: swank-macrolet-expand (macrolets expander string)
Package

swank.

Source

swank.lisp.

Function: swank-profile-package (package-name callersp methodsp)
Package

swank.

Source

swank.lisp.

Function: swank-require (modules &optional filename)

Load the module MODULE.

Package

swank.

Source

swank.lisp.

Function: swank-toggle-trace (spec-string)
Package

swank.

Source

swank.lisp.

Function: thread-alive-p (thread)

Test if THREAD is termintated.

Package

swank/backend.

Source

backend.lisp.

Function: thread-attributes (thread)

Return a plist of implementation-dependent attributes for THREAD

Package

swank/backend.

Source

backend.lisp.

Function: thread-id (thread)

Return an Emacs-parsable object to identify THREAD.

Ids should be comparable with equal, i.e.:
(equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)

Package

swank/backend.

Source

backend.lisp.

Function: thread-name (thread)

Return the name of THREAD.
Thread names are short strings meaningful to the user. They do not have to be unique.

Package

swank/backend.

Source

backend.lisp.

Function: thread-status (thread)

Return a string describing THREAD’s state.

Package

swank/backend.

Source

backend.lisp.

Function: throw-to-toplevel ()

Invoke the ABORT-REQUEST restart abort an RPC from Emacs. If we are not evaluating an RPC then ABORT instead.

Package

swank.

Source

swank.lisp.

Function: to-string (object)

Write OBJECT in the *BUFFER-PACKAGE*.
The result may not be readable. Handles problems with PRINT-OBJECT methods gracefully.

Package

swank.

Source

swank.lisp.

Function: toggle-break-on-signals ()
Package

swank.

Source

swank.lisp.

Function: toggle-debug-on-swank-error ()
Package

swank.

Source

swank.lisp.

Function: toggle-profile-fdefinition (fname-string)
Package

swank.

Source

swank.lisp.

Function: toggle-trace (spec)

Toggle tracing of the function(s) given with SPEC.
SPEC can be:
(setf NAME) ; a setf function
(:defmethod NAME QUALIFIER... (SPECIALIZER...)) ; a specific method (:defgeneric NAME) ; a generic function with all methods (:call CALLER CALLEE) ; trace calls from CALLER to CALLEE. (:labels TOPLEVEL LOCAL)
(:flet TOPLEVEL LOCAL)

Package

swank/backend.

Source

backend.lisp.

Function: type-specifier-p (symbol)

Determine if SYMBOL is a type-specifier.

Package

swank/backend.

Source

backend.lisp.

Function: undefine-function (fname-string)
Package

swank.

Source

swank.lisp.

Function: unintern-symbol (name package)
Package

swank.

Source

swank.lisp.

Function: unprofile (fname)

Marks symbol FNAME as not profiled.

Package

swank/backend.

Source

backend.lisp.

Function: unprofile-all ()

Marks all currently profiled functions as not profiled.

Package

swank/backend.

Source

backend.lisp.

Function: unreadable-result-p (object)
Package

swank.

Source

swank.lisp.

Reader: unreadable-result-string (instance)
Writer: (setf unreadable-result-string) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

string.

Function: untrace-all ()
Package

swank.

Source

swank.lisp.

Function: unwrap (spec indicator)

Remove from SPEC any wrappings tagged with INDICATOR.

Package

swank/backend.

Source

backend.lisp.

Function: update-indentation-information ()
Package

swank.

Source

swank.lisp.

Function: utf8-to-string (octets)

Convert the (simple-array (unsigned-byte 8)) OCTETS to a string.

Package

swank/backend.

Source

backend.lisp.

Function: valid-function-name-p (form)

Is FORM syntactically valid to name a function?
If true, FBOUNDP should not signal a type-error for FORM.

Package

swank/backend.

Source

backend.lisp.

Function: value-for-editing (form)

Return a readable value of FORM for editing in Emacs. FORM is expected, but not required, to be SETF’able.

Package

swank.

Source

swank.lisp.

Function: wait-for-input (streams &optional timeout)

Wait for input on a list of streams. Return those that are ready. STREAMS is a list of streams
TIMEOUT nil, t, or real number. If TIMEOUT is t, return those streams which are ready (or have reached end-of-file) without waiting.
If TIMEOUT is a number and no streams is ready after TIMEOUT seconds, return nil.

Return :interrupt if an interrupt occurs while waiting.

Package

swank/backend.

Source

backend.lisp.

Function: wake-thread (thread)

Trigger a call to CHECK-SLIME-INTERRUPTS in THREAD without using asynchronous interrupts.

Package

swank/backend.

Source

backend.lisp.

Function: who-binds (variable-name)

Return the locations where VARIABLE-NAME (a symbol) is bound. See WHO-CALLS for a description of the return value.

Package

swank/backend.

Source

backend.lisp.

Function: who-calls (function-name)

Return the call sites of FUNCTION-NAME (a symbol). The results is a list ((DSPEC LOCATION) ...).

Package

swank/backend.

Source

backend.lisp.

Function: who-macroexpands (macro-name)

Return the locations where MACRO-NAME (a symbol) is expanded. See WHO-CALLS for a description of the return value.

Package

swank/backend.

Source

backend.lisp.

Function: who-references (variable-name)

Return the locations where VARIABLE-NAME (a symbol) is referenced. See WHO-CALLS for a description of the return value.

Package

swank/backend.

Source

backend.lisp.

Function: who-sets (variable-name)

Return the locations where VARIABLE-NAME (a symbol) is set. See WHO-CALLS for a description of the return value.

Package

swank/backend.

Source

backend.lisp.

Function: who-specializes (class-name)

Return the locations where CLASS-NAME (a symbol) is specialized. See WHO-CALLS for a description of the return value.

Package

swank/backend.

Source

backend.lisp.

Function: with-symbol (name package)

Check if a symbol with a given NAME exists in PACKAGE and returns a form suitable for testing with #+.

Package

swank/backend.

Source

backend.lisp.

Function: wrap (spec indicator &key before after replace)

Intercept future calls to SPEC and surround them in callbacks.

INDICATOR is a symbol identifying a particular wrapping, and is used to differentiate between multiple wrappings.

Implementations intercept calls to SPEC and call, in this order:

* the BEFORE callback, if it’s provided, with a single argument set to the list of arguments passed to the intercepted call;

* the original definition of SPEC recursively honouring any wrappings previously established under different values of INDICATOR. If the compatible function REPLACE is provided, call that instead.

* the AFTER callback, if it’s provided, with a single set to the list of values returned by the previous call, or, if that call exited non-locally, a single descriptive symbol, like :EXITED-NON-LOCALLY.

Package

swank/backend.

Source

backend.lisp.

Function: wrapped-p (spec indicator)

Returns true if SPEC is wrapped with INDICATOR.

Package

swank/backend.

Source

backend.lisp.

Function: write-message (message package stream)
Package

swank/rpc.

Source

rpc.lisp.

Function: xref (type name)
Package

swank.

Source

swank.lisp.

Function: xrefs (types name)
Package

swank.

Source

swank.lisp.

Function: y-or-n-p-in-emacs (format-string &rest arguments)

Like y-or-n-p, but ask in the Emacs minibuffer.

Package

swank.

Source

swank.lisp.


6.1.4 Generic functions

Generic Function: declaration-arglist (decl-identifier)

Return the argument list of the declaration specifier belonging to the declaration identifier DECL-IDENTIFIER. If the arglist cannot be determined, the keyword :NOT-AVAILABLE is returned.

The different SWANK backends can specialize this generic function to include implementation-dependend declaration specifiers, or to provide additional information on the specifiers defined in ANSI Common Lisp.

Package

swank/backend.

Source

backend.lisp.

Methods
Method: declaration-arglist ((decl-identifier (eql optimize)))
Source

sbcl.lisp.

Method: declaration-arglist (decl-identifier)
Generic Function: emacs-inspect (object)

Explain to Emacs how to inspect OBJECT.

Returns a list specifying how to render the object for inspection.

Every element of the list must be either a string, which will be inserted into the buffer as is, or a list of the form:

(:value object &optional format) - Render an inspectable object. If format is provided it must be a string and will be rendered in place of the value, otherwise use princ-to-string.

(:newline) - Render a \n

(:action label lambda &key (refresh t)) - Render LABEL (a text string) which when clicked will call LAMBDA. If REFRESH is non-NIL the currently inspected object will be re-inspected after calling the lambda.

Package

swank/backend.

Source

backend.lisp.

Methods
Method: emacs-inspect ((char character))
Source

swank.lisp.

Method: emacs-inspect ((array array))
Source

swank.lisp.

Method: emacs-inspect ((ht hash-table))
Source

swank.lisp.

Method: emacs-inspect ((o cons))
Source

swank.lisp.

Method: emacs-inspect :around ((o generic-function))
Source

sbcl.lisp.

Method: emacs-inspect ((o fdefn))
Source

sbcl.lisp.

Method: emacs-inspect ((o weak-pointer))
Source

sbcl.lisp.

Method: emacs-inspect ((o code-component))
Source

sbcl.lisp.

Method: emacs-inspect ((o function))
Source

sbcl.lisp.

Method: emacs-inspect (o)
Source

sbcl.lisp.

Generic Reader: location (condition)
Generic Writer: (setf location) (condition)
Package

swank/backend.

Methods
Reader Method: location ((condition compiler-condition))
Writer Method: (setf location) ((condition compiler-condition))
Source

backend.lisp.

Target Slot

location.

Generic Reader: message (condition)
Generic Writer: (setf message) (condition)
Package

swank/backend.

Methods
Reader Method: message ((condition compiler-condition))
Writer Method: (setf message) ((condition compiler-condition))
Source

backend.lisp.

Target Slot

message.

Generic Reader: original-condition (condition)
Generic Writer: (setf original-condition) (condition)
Package

swank/backend.

Methods
Reader Method: original-condition ((condition sldb-condition))
Writer Method: (setf original-condition) ((condition sldb-condition))
Source

backend.lisp.

Target Slot

original-condition.

Reader Method: original-condition ((condition compiler-condition))
Writer Method: (setf original-condition) ((condition compiler-condition))
Source

backend.lisp.

Target Slot

original-condition.

Generic Reader: references (condition)
Generic Writer: (setf references) (condition)
Package

swank/backend.

Methods
Reader Method: references ((condition compiler-condition))
Writer Method: (setf references) ((condition compiler-condition))
Source

backend.lisp.

Target Slot

references.

Generic Reader: severity (condition)
Generic Writer: (setf severity) (condition)
Package

swank/backend.

Methods
Reader Method: severity ((condition compiler-condition))
Writer Method: (setf severity) ((condition compiler-condition))
Source

backend.lisp.

Target Slot

severity.

Generic Function: sexp-in-bounds-p (sexp i)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Methods
Method: sexp-in-bounds-p ((s comma) i)
Source

sbcl.lisp.

Method: sexp-in-bounds-p ((list list) i)
Method: sexp-in-bounds-p (sexp i)
Generic Function: sexp-ref (sexp n)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Methods
Method: sexp-ref ((s comma) i)
Source

sbcl.lisp.

Method: sexp-ref ((s list) n)
Generic Reader: source-context (condition)
Generic Writer: (setf source-context) (condition)
Package

swank/backend.

Methods
Reader Method: source-context ((condition compiler-condition))
Writer Method: (setf source-context) ((condition compiler-condition))
Source

backend.lisp.

Target Slot

source-context.

Generic Reader: swank-reader-error.cause (condition)
Package

swank/rpc.

Methods
Reader Method: swank-reader-error.cause ((condition swank-reader-error))
Source

rpc.lisp.

Target Slot

cause.

Generic Reader: swank-reader-error.packet (condition)
Package

swank/rpc.

Methods
Reader Method: swank-reader-error.packet ((condition swank-reader-error))
Source

rpc.lisp.

Target Slot

packet.

Generic Function: type-specifier-arglist (typespec-operator)

Return the argument list of the type specifier belonging to TYPESPEC-OPERATOR.. If the arglist cannot be determined, the keyword :NOT-AVAILABLE is returned.

The different SWANK backends can specialize this generic function to include implementation-dependend declaration specifiers, or to provide additional information on the specifiers defined in ANSI Common Lisp.

Package

swank/backend.

Source

backend.lisp.

Methods
Method: type-specifier-arglist :around (typespec-operator)
Source

sbcl.lisp.

Method: type-specifier-arglist (typespec-operator)

6.1.5 Standalone methods

Method: initialize-instance :after ((ch channel) &key)
Source

swank.lisp.

Method: print-object ((object unreadable-result) stream)
Source

swank.lisp.

Method: print-object ((object connection) stream)
Source

swank.lisp.

Method: print-object ((c channel) stream)
Source

swank.lisp.

Method: stream-clear-input ((s slime-input-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-file-position ((stream slime-input-stream) &optional position)
Package

sb-gray.

Source

gray.lisp.

Method: stream-file-position ((stream slime-output-stream) &optional position)
Package

sb-gray.

Source

gray.lisp.

Method: stream-finish-output ((stream slime-output-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-force-output ((stream slime-output-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-fresh-line ((stream slime-output-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-line-column ((s slime-input-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-line-column ((stream slime-output-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-listen ((s slime-input-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-read-char ((s slime-input-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-read-char-no-hang ((s slime-input-stream))
Package

sb-gray.

Source

gray.lisp.

Method: stream-unread-char ((s slime-input-stream) char)
Package

sb-gray.

Source

gray.lisp.

Method: stream-write-char ((stream slime-output-stream) char)
Package

sb-gray.

Source

gray.lisp.

Method: stream-write-string ((stream slime-output-stream) string &optional start end)
Package

sb-gray.

Source

gray.lisp.


6.1.6 Conditions

Condition: compiler-condition
Package

swank/backend.

Source

backend.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: original-condition
Initargs

:original-condition

Readers

original-condition.

Writers

(setf original-condition).

Slot: severity
Initargs

:severity

Readers

severity.

Writers

(setf severity).

Slot: message
Initargs

:message

Readers

message.

Writers

(setf message).

Slot: source-context
Initform

(quote nil)

Initargs

:source-context

Readers

source-context.

Writers

(setf source-context).

Slot: references
Initform

(quote nil)

Initargs

:references

Readers

references.

Writers

(setf references).

Slot: location
Initargs

:location

Readers

location.

Writers

(setf location).

Condition: sldb-condition

Wrapper for conditions that should not be debugged.

When a condition arises from the internals of the debugger, it is not desirable to debug it – we’d risk entering an endless loop trying to debug the debugger! Instead, such conditions can be reported to the user without (re)entering the debugger by wrapping them as ‘sldb-condition’s.

Package

swank/backend.

Source

backend.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: original-condition
Initargs

:original-condition

Readers

original-condition.

Writers

(setf original-condition).

Condition: swank-reader-error
Package

swank/rpc.

Source

rpc.lisp.

Direct superclasses

reader-error.

Direct methods
Direct slots
Slot: packet
Initargs

:packet

Readers

swank-reader-error.packet.

Writers

This slot is read-only.

Slot: cause
Initargs

:cause

Readers

swank-reader-error.cause.

Writers

This slot is read-only.


6.1.7 Structures

Structure: unreadable-result
Package

swank.

Source

swank.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: string
Package

common-lisp.

Readers

unreadable-result-string.

Writers

(setf unreadable-result-string).


6.1.8 Types

Type: severity ()
Package

swank/backend.

Source

backend.lisp.


6.2 Internals


6.2.1 Constants

Constant: +sigint+
Package

swank/backend.

Source

backend.lisp.

Constant: cl-package

The COMMON-LISP package.

Package

swank.

Source

swank.lisp.

Constant: default-server-port

The default TCP port for the server (when started manually).

Package

swank.

Source

swank.lisp.

Constant: keyword-package

The KEYWORD package.

Package

swank.

Source

swank.lisp.

Constant: send-counter-limit
Package

swank.

Source

swank.lisp.


6.2.2 Special variables

Special Variable: *after-init-hook*

Hook run after user init files are loaded.

Package

swank.

Source

swank.lisp.

Special Variable: *architecture-features*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *auto-abbreviate-dotted-packages*

Abbreviate dotted package names to their last component if T.

Package

swank.

Source

swank.lisp.

Special Variable: *backtrace-pprint-dispatch-table*
Package

swank.

Source

swank.lisp.

Special Variable: *buffer-name*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *buffer-offset*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *buffer-package*

Package corresponding to slime-buffer-package.

EVAL-FOR-EMACS binds *buffer-package*. Strings originating from a slime buffer are best read in this package. See also FROM-STRING and TO-STRING.

Package

swank.

Source

swank.lisp.

Special Variable: *buffer-readtable*

Readtable associated with the current buffer

Package

swank.

Source

swank.lisp.

Special Variable: *buffer-substring*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *buffer-tmpfile*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *cache-sourcecode*

When true complete source files are cached.
The cache is used to keep known good copies of the source text which correspond to the loaded code. Finding definitions is much more reliable when the exact source is available, so we cache it in case it gets edited on disk later.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Special Variable: *canonical-package-nicknames*

Canonical package names to use instead of shortest name/nickname.

Package

swank.

Source

swank.lisp.

Special Variable: *channel-counter*
Package

swank.

Source

swank.lisp.

Special Variable: *channels*
Package

swank.

Source

swank.lisp.

Special Variable: *compile-file-for-emacs-hook*
Package

swank.

Source

swank.lisp.

Special Variable: *connection-closed-hook*

This hook is run when a connection is closed.
The connection as passed as an argument.
Backend code should treat the connection structure as opaque.

Package

swank.

Source

swank.lisp.

Special Variable: *connection-lock*
Package

swank.

Source

swank.lisp.

Special Variable: *connections*

List of all active connections, with the most recent at the front.

Package

swank.

Source

swank.lisp.

Special Variable: *contribs*

List of names for contrib modules.

Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *debootstrap-packages*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *debug-on-swank-protocol-error*

When non-nil invoke the system debugger on errors that were signalled during decoding/encoding the wire protocol. Do not set this to T unless you want to debug swank internals.

Package

swank.

Source

swank.lisp.

Special Variable: *definition-types*

Map SB-INTROSPECT definition type names to Slime-friendly forms

Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *echo-area-prefix*

A prefix that ‘format-values-for-echo-area’ should use.

Package

swank.

Source

swank.lisp.

Special Variable: *emacs-connection*

The connection to Emacs currently in use.

Package

swank.

Source

swank.lisp.

Special Variable: *enable-event-history*
Package

swank.

Source

swank.lisp.

Special Variable: *event-history*

A ring buffer to record events for better error messages.

Package

swank.

Source

swank.lisp.

Special Variable: *event-history-index*
Package

swank.

Source

swank.lisp.

Special Variable: *event-hook*
Package

swank.

Source

swank.lisp.

Special Variable: *external-format-to-coding-system*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *find-module*

Pluggable function to locate modules.
The function receives a module name as argument and should return the filename of the module (or nil if the file doesn’t exist).

Package

swank.

Source

swank.lisp.

Special Variable: *implementation-features*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *inspector-history*
Package

swank.

Source

swank.lisp.

Special Variable: *inspector-printer-bindings*
Package

swank.

Source

swank.lisp.

Special Variable: *inspector-verbose-printer-bindings*
Package

swank.

Source

swank.lisp.

Special Variable: *interface-functions*

The names of all interface functions.

Package

swank/backend.

Source

backend.lisp.

Special Variable: *io-interupt-level*
Package

swank.

Source

swank.lisp.

Special Variable: *istate*
Package

swank.

Source

swank.lisp.

Special Variable: *keep-non-valid-locals*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *load-path*

A list of directories to search for modules.

Package

swank.

Source

swank.lisp.

Special Variable: *loopback-interface*
Package

swank.

Source

swank.lisp.

Special Variable: *mailbox-lock*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *mailboxes*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *new-connection-hook*

This hook is run each time a connection is established. The connection structure is given as the argument. Backend code should treat the connection structure as opaque.

Package

swank.

Source

swank.lisp.

Special Variable: *os-features*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *pending-continuations*

List of continuations for Emacs. (thread local)

Package

swank.

Source

swank.lisp.

Special Variable: *physical-pathname-host*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *pre-reply-hook*

Hook run (without arguments) immediately before replying to an RPC.

Package

swank.

Source

swank.lisp.

Special Variable: *previous-compiler-condition*

Used to detect duplicates.

Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *send-counter*
Package

swank.

Source

swank.lisp.

Special Variable: *servers*

A list ((server-socket port thread) ...) describing the listening sockets. Used to close sockets on server shutdown or restart.

Package

swank.

Source

swank.lisp.

Special Variable: *shebang-readtable*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *sigio-handlers*

List of (key . fn) pairs to be called on SIGIO.

Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *sldb-condition-printer*

Function called to print a condition to an SLDB buffer.

Package

swank.

Source

swank.lisp.

Special Variable: *sldb-initial-frames*

The initial number of backtrace frames to send to Emacs.

Package

swank.

Source

swank.lisp.

Special Variable: *sldb-level*

The current level of recursive debugging.

Package

swank.

Source

swank.lisp.

Special Variable: *sldb-restarts*

The list of currenlty active restarts.

Package

swank.

Source

swank.lisp.

Special Variable: *sldb-stack-top*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *sldb-stepping-p*

True during execution of a step command.

Package

swank.

Source

swank.lisp.

Special Variable: *slime-features*

The feature list that has been sent to Emacs.

Package

swank.

Source

swank.lisp.

Special Variable: *slime-interrupts-enabled*
Package

swank.

Source

swank.lisp.

Special Variable: *source-file-cache*

Cache of source file contents.
Maps from truename to source-cache-entry structure.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Special Variable: *swank-debug-p*

When true, print extra debugging information.

Package

swank.

Source

swank.lisp.

Special Variable: *swank-files*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *swank-io-package*
Package

swank.

Source

swank.lisp.

Special Variable: *swank-wire-protocol-version*

The version of the swank/slime communication protocol.

Package

swank.

Source

swank.lisp.

Special Variable: *sysdep-files*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *tag-counter*
Package

swank.

Source

swank.lisp.

Special Variable: *thread-list*

List of threads displayed in Emacs. We don’t care a about synchronization issues (yet). There can only be one thread listing at a time.

Package

swank.

Source

swank.lisp.

Special Variable: *trap-load-time-warnings*
Package

swank/sbcl.

Source

sbcl.lisp.

Special Variable: *type-specifier-arglists*
Package

swank/backend.

Source

backend.lisp.

Special Variable: *unimplemented-interfaces*

List of interface functions that are not implemented. DEFINTERFACE adds to this list and DEFIMPLEMENTATION removes.

Package

swank/backend.

Source

backend.lisp.

Special Variable: *validate-input*

Set to true to require input that more strictly conforms to the protocol

Package

swank/rpc.

Source

rpc.lisp.

Special Variable: *wait-for-input-called*
Package

swank/sbcl.

Source

sbcl.lisp.


6.2.3 Macros

Macro: add-hook (place function)

Add FUNCTION to the list of values on PLACE.

Package

swank.

Source

swank.lisp.

Macro: current-environment ()
Package

swank.

Source

swank.lisp.

Macro: dcase (value &body patterns)

Dispatch VALUE to one of PATTERNS.
A cross between ‘case’ and ‘destructuring-bind’.
The pattern syntax is:
((HEAD . ARGS) . BODY)
The list of patterns is searched for a HEAD ‘eq’ to the car of VALUE. If one is found, the BODY is executed with ARGS bound to the corresponding values in the CDR of VALUE.

Package

swank.

Source

swank.lisp.

Macro: define-channel-method (selector (channel &rest args) &body body)
Package

swank.

Source

swank.lisp.

Macro: define-special (name doc)

Define a special variable NAME with doc string DOC. This is like defvar, but NAME will not be initialized.

Package

swank.

Source

swank.lisp.

Macro: define-stepper-function (name backend-function-name)
Package

swank.

Source

swank.lisp.

Macro: definterface (name args documentation &rest default-body)

Define an interface function for the backend to implement.
A function is defined with NAME, ARGS, and DOCUMENTATION. This function first looks for a function to call in NAME’s property list that is indicated by ’IMPLEMENTATION; failing that, it looks for a function indicated by ’DEFAULT. If neither is present, an error is signaled.

If a DEFAULT-BODY is supplied, then a function with the same body and ARGS will be added to NAME’s property list as the property indicated by ’DEFAULT.

Backends implement these functions using DEFIMPLEMENTATION.

Package

swank/backend.

Source

backend.lisp.

Macro: defslimefun (name arglist &body rest)

A DEFUN for functions that Emacs can call by RPC.

Package

swank.

Source

swank.lisp.

Macro: defxref (name &optional fn-name)
Package

swank/sbcl.

Source

sbcl.lisp.

Macro: lcons (car cdr)
Package

swank.

Source

swank.lisp.

Macro: lcons* (car cdr &rest more)
Package

swank.

Source

swank.lisp.

Macro: restart-loop (form &body clauses)

Executes FORM, with restart-case CLAUSES which have a chance to modify FORM’s environment before trying again (by returning normally) or giving up (through an explicit transfer of control), all within an implicit block named nil.
e.g.: (restart-loop (http-request url) (use-value (new) (setq url new)))

Package

swank.

Source

swank.lisp.

Macro: select-match (expression &rest patterns)
Package

swank/match.

Source

match.lisp.

Macro: utf8-encode-aux (code buffer start end n)
Package

swank/backend.

Source

backend.lisp.

Macro: values-to-string (values)
Package

swank.

Source

swank.lisp.

Macro: with-bindings (alist &body body)

See ‘call-with-bindings’.

Package

swank.

Source

swank.lisp.

Macro: with-buffer-syntax ((&optional package) &body body)

Execute BODY with appropriate *package* and *readtable* bindings.

This should be used for code that is conceptionally executed in an Emacs buffer.

Package

swank.

Source

swank.lisp.

Macro: with-compiler-policy (policy &body body)
Package

swank/sbcl.

Source

sbcl.lisp.

Macro: with-connection ((connection) &body body)

Execute BODY in the context of CONNECTION.

Package

swank.

Source

swank.lisp.

Macro: with-debootstrapping (&body body)
Package

swank/sbcl.

Source

sbcl.lisp.

Macro: with-definition-source ((&rest names) obj &body body)

Like with-slots but works only for structs.

Package

swank/sbcl.

Source

sbcl.lisp.

Macro: with-describe-settings ((&rest _) &body body)
Package

swank.

Source

swank.lisp.

Macro: with-interrupts-enabled% (flag body)
Package

swank.

Source

swank.lisp.

Macro: with-io-redirection ((connection) &body body)

Execute BODY I/O redirection to CONNECTION.

Package

swank.

Source

swank.lisp.

Macro: with-panic-handler ((connection) &body body)

Close the connection on unhandled ‘serious-condition’s.

Package

swank.

Source

swank.lisp.

Macro: with-retry-restart ((&key msg) &body body)
Package

swank.

Source

swank.lisp.

Macro: with-slime-interrupts (&body body)
Package

swank.

Source

swank.lisp.

Macro: with-slime-output-stream (stream &body body)
Package

swank/gray.

Source

gray.lisp.

Macro: with-string-stream ((var &key length bindings) &body body)
Package

swank.

Source

swank.lisp.

Macro: with-struct* ((conc-name get obj) &body body)
Package

swank.

Source

swank.lisp.

Macro: with-swank-error-handler ((connection) &body body)

Close the connection on internal ‘swank-error’s.

Package

swank.

Source

swank.lisp.

Macro: with-top-level-restart ((connection k) &body body)
Package

swank.

Source

swank.lisp.

Macro: without-printing-errors ((&key object stream msg) &body body)

Catches errors during evaluation of BODY and prints MSG instead.

Package

swank.

Source

swank.lisp.

Macro: without-slime-interrupts (&body body)
Package

swank.

Source

swank.lisp.


6.2.4 Ordinary functions

Function: %%condition-message (condition)
Package

swank.

Source

swank.lisp.

Function: %condition-message (condition)
Package

swank.

Source

swank.lisp.

Function: %lcons (car %cdr)
Package

swank.

Source

swank.lisp.

Function: %make-connection (&key socket socket-io dedicated-output user-input user-output user-io env trace-output repl-results indentation-cache indentation-cache-packages communication-style)
Package

swank.

Source

swank.lisp.

Function: %search-coding (str start end)
Package

swank/backend.

Source

backend.lisp.

Function: %stop-server (key value)
Package

swank.

Source

swank.lisp.

Function: %stream-finish-output (stream)
Package

swank/gray.

Source

gray.lisp.

Function: %utf8-encode (code buffer start end)
Package

swank/backend.

Source

backend.lisp.

Function: accept (socket)

Like socket-accept, but retry on EAGAIN.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: accept-connections (socket style dont-close)
Package

swank.

Source

swank.lisp.

Function: action-part (label lambda refreshp actions)
Package

swank.

Source

swank.lisp.

Function: add-active-thread (connection thread)
Package

swank.

Source

swank.lisp.

Function: add-connection (conn)
Package

swank.

Source

swank.lisp.

Function: add-server (socket port thread)
Package

swank.

Source

swank.lisp.

Function: all-completions (prefix package)
Package

swank.

Source

swank.lisp.

Function: announce-server-port (file port)
Package

swank.

Source

swank.lisp.

Function: append-dir (absolute name)
Package

swank-loader.

Source

swank-loader.lisp.

Function: apply-macro-expander (expander string &optional environment)
Package

swank.

Source

swank.lisp.

Function: apropos-symbols (string external-only case-sensitive package)
Package

swank.

Source

swank.lisp.

Function: ascii-char-p (c)
Package

swank.

Source

swank.lisp.

Function: ascii-string-p (o)
Package

swank.

Source

swank.lisp.

Function: asciify (packet)
Package

swank/rpc.

Source

rpc.lisp.

Function: assign-index (object vector)
Package

swank.

Source

swank.lisp.

Function: authenticate-client (stream)
Package

swank.

Source

swank.lisp.

Function: auto-abbreviated-package-name (package)

Return an abbreviated ’name’ for PACKAGE.

N.B. this is not an actual package name or nickname.

Package

swank.

Source

swank.lisp.

Function: background-message (format-string &rest args)

Display a message in Emacs’ echo area.

Use this function for informative messages only. The message may even be dropped if we are too busy with other things.

Package

swank.

Source

swank.lisp.

Function: before-init (version load-path)
Package

swank.

Source

swank.lisp.

Function: binary-pathname (src-pathname binary-dir)

Return the pathname where SRC-PATHNAME’s binary should be compiled.

Package

swank-loader.

Source

swank-loader.lisp.

Function: brief-compiler-message-for-emacs (condition)

Briefly describe a compiler error for Emacs.
When Emacs presents the message it already has the source popped up and the source form highlighted. This makes much of the information in the error-context redundant.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: briefly-describe-symbol-for-emacs (symbol)

Return a property list describing SYMBOL.
Like ‘describe-symbol-for-emacs’ but with at most one line per item.

Package

swank.

Source

swank.lisp.

Function: call-with-bindings (alist fun)

Call FUN with variables bound according to ALIST. ALIST is a list of the form ((VAR . VAL) ...).

Package

swank.

Source

swank.lisp.

Function: call-with-break-hook (hook continuation)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: call-with-buffer-syntax (package fun)
Package

swank.

Source

swank.lisp.

Function: call-with-collected-macro-forms (body-fn instrumented-fn)
Package

swank/backend.

Source

backend.lisp.

Function: call-with-debootstrapping (fun)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: call-with-describe-settings (fn)
Package

swank.

Source

swank.lisp.

Function: call-with-retry-restart (msg thunk)
Package

swank.

Source

swank.lisp.

Function: call/truncated-output-to-string (length function &optional ellipsis)

Call FUNCTION with a new stream, return the output written to the stream. If FUNCTION tries to write more than LENGTH characters, it will be aborted and return immediately with the output written so far.

Package

swank.

Source

swank.lisp.

Function: canonical-package-nickname (package)

Return the canonical package nickname, if any, of PACKAGE.

Package

swank.

Source

swank.lisp.

Function: casify-char (char)

Convert CHAR accoring to readtable-case.

Package

swank.

Source

swank.lisp.

Function: cat (&rest strings)

Concatenate all arguments and make the result a string.

Package

swank.

Source

swank.lisp.

Function: categorize-definition-source (definition-source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: check-source-path (path)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: cl-symbol-p (symbol)

Is SYMBOL a symbol in the COMMON-LISP package?

Package

swank.

Source

swank.lisp.

Function: clean-arglist (arglist)

Remove &whole, &enviroment, and &aux elements from ARGLIST.

Package

swank.

Source

swank.lisp.

Function: cleanup-connection-threads (connection)
Package

swank.

Source

swank.lisp.

Function: clear-event-history ()
Package

swank.

Source

swank.lisp.

Function: clear-user-input ()
Package

swank.

Source

swank.lisp.

Function: close-connection (connection condition backtrace)
Package

swank.

Source

swank.lisp.

Function: close-connection% (c condition backtrace)
Package

swank.

Source

swank.lisp.

Function: code-location-debug-fun-fun (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: code-location-debug-source-created (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: code-location-debug-source-name (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: code-location-has-debug-block-info-p (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: code-location-source-location (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: coerce-to-condition (datum args)
Package

swank.

Source

swank.lisp.

Function: collect-notes (function)
Package

swank.

Source

swank.lisp.

Function: compilation-result-duration (structure)
Package

swank.

Source

swank.lisp.

Function: (setf compilation-result-duration) (structure)
Package

swank.

Source

swank.lisp.

Function: compilation-result-faslfile (structure)
Package

swank.

Source

swank.lisp.

Function: (setf compilation-result-faslfile) (structure)
Package

swank.

Source

swank.lisp.

Function: compilation-result-loadp (structure)
Package

swank.

Source

swank.lisp.

Function: (setf compilation-result-loadp) (structure)
Package

swank.

Source

swank.lisp.

Function: compilation-result-notes (structure)
Package

swank.

Source

swank.lisp.

Function: (setf compilation-result-notes) (structure)
Package

swank.

Source

swank.lisp.

Function: compilation-result-successp (structure)
Package

swank.

Source

swank.lisp.

Function: (setf compilation-result-successp) (structure)
Package

swank.

Source

swank.lisp.

Function: compilation-result-type (structure)
Package

swank.

Source

swank.lisp.

Function: (setf compilation-result-type) (structure)
Package

swank.

Source

swank.lisp.

Function: compile-contribs (&key src-dir fasl-dir swank-src-dir load quiet)
Package

swank-loader.

Source

swank-loader.lisp.

Function: compile-file-output (file directory)
Package

swank.

Source

swank.lisp.

Function: compile-files (files fasl-dir load quiet)

Compile each file in FILES if the source is newer than its corresponding binary, or the file preceding it was recompiled. If LOAD is true, load the fasl file.

Package

swank-loader.

Source

swank-loader.lisp.

Function: compile-select-bindings (key pattern action)
Package

swank/match.

Source

match.lisp.

Function: compile-select-test (key pattern)
Package

swank/match.

Source

match.lisp.

Function: compile-select-tests (key pattern)
Package

swank/match.

Source

match.lisp.

Function: compiler-error-context (error-context)

Describe a compiler error for Emacs including context information.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: compiler-note-location (condition context)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: compiler-policy (qualities)

Return compiler policy qualities present in the QUALITIES alist. QUALITIES is an alist with (quality . value)

Package

swank/sbcl.

Source

sbcl.lisp.

Function: (setf compiler-policy) ()
Package

swank/sbcl.

Source

sbcl.lisp.

Function: compiler-source-path (context)

Return the source-path for the current compiler error. Returns NIL if this cannot be determined by examining internal compiler state.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: compiling-from-buffer-p (filename)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: compiling-from-file-p (filename)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: compiling-from-generated-code-p (filename source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: condition-references (condition)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: connection-p (object)
Package

swank.

Source

swank.lisp.

Reader: connection.communication-style (instance)
Writer: (setf connection.communication-style) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

communication-style.

Reader: connection.dedicated-output (instance)
Writer: (setf connection.dedicated-output) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

dedicated-output.

Reader: connection.env (instance)
Writer: (setf connection.env) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

env.

Reader: connection.indentation-cache (instance)
Writer: (setf connection.indentation-cache) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

indentation-cache.

Reader: connection.indentation-cache-packages (instance)
Writer: (setf connection.indentation-cache-packages) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

indentation-cache-packages.

Reader: connection.repl-results (instance)
Writer: (setf connection.repl-results) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

repl-results.

Reader: connection.socket (instance)
Package

swank.

Source

swank.lisp.

Target Slot

socket.

Reader: connection.socket-io (instance)
Package

swank.

Source

swank.lisp.

Target Slot

socket-io.

Reader: connection.trace-output (instance)
Writer: (setf connection.trace-output) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

trace-output.

Reader: connection.user-input (instance)
Writer: (setf connection.user-input) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

user-input.

Reader: connection.user-io (instance)
Writer: (setf connection.user-io) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

user-io.

Reader: connection.user-output (instance)
Writer: (setf connection.user-output) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

user-output.

Function: content-range (list start end)
Package

swank.

Source

swank.lisp.

Function: contrib-dir (base-dir)
Package

swank-loader.

Source

swank-loader.lisp.

Function: control-thread (connection)
Package

swank.

Source

swank.lisp.

Function: copy-compilation-result (sequence)

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

swank.

Alias for

copy-seq.

Function: copy-connection (instance)
Package

swank.

Source

swank.lisp.

Function: copy-inspector-state (instance)
Package

swank.

Source

swank.lisp.

Function: copy-istate (instance)
Package

swank.

Source

swank.lisp.

Function: copy-lcons (instance)
Package

swank.

Source

swank.lisp.

Function: copy-location (sequence)

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

swank/backend.

Alias for

copy-seq.

Function: copy-mailbox (instance)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: copy-multithreaded-connection (instance)
Package

swank.

Source

swank.lisp.

Function: copy-singlethreaded-connection (instance)
Package

swank.

Source

swank.lisp.

Function: copy-source-cache-entry (instance)
Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: cs-car (exp)
Package

swank/match.

Source

match.lisp.

Function: cs-car/cdr (op exp table)
Package

swank/match.

Source

match.lisp.

Function: cs-cdr (exp)
Package

swank/match.

Source

match.lisp.

Function: current-socket-io ()
Package

swank.

Source

swank.lisp.

Function: current-thread-id ()
Package

swank.

Source

swank.lisp.

Function: debug-in-emacs (condition)
Package

swank.

Source

swank.lisp.

Function: debug-var-info (var)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: debug-var-value (var frame location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: debugger-condition-for-emacs ()
Package

swank.

Source

swank.lisp.

Function: decode-message (stream)

Read an S-expression from STREAM using the SLIME protocol.

Package

swank.

Source

swank.lisp.

Function: default-connection ()

Return the ’default’ Emacs connection.
This connection can be used to talk with Emacs when no specific connection is in use, i.e. *EMACS-CONNECTION* is NIL.

The default connection is defined (quite arbitrarily) as the most recently established one.

Package

swank.

Source

swank.lisp.

Function: default-fasl-dir ()
Package

swank-loader.

Source

swank-loader.lisp.

Function: default-string-to-utf8 (string)
Package

swank/backend.

Source

backend.lisp.

Function: default-utf8-to-string (octets)
Package

swank/backend.

Source

backend.lisp.

Function: definition-source-buffer-and-file-location (definition-source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: definition-source-buffer-location (definition-source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: definition-source-file-location (definition-source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: definition-source-for-emacs (definition-source type name)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: definition-specifier (type)

Return a pretty specifier for NAME representing a definition of type TYPE.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: deinstall-fd-handler (connection)
Package

swank.

Source

swank.lisp.

Function: deinstall-sigio-handler (connection)
Package

swank.

Source

swank.lisp.

Function: delete-packages (packages)
Package

swank-loader.

Source

swank-loader.lisp.

Function: delete-stale-contrib-fasl-files (swank-files contrib-files fasl-dir)
Package

swank-loader.

Source

swank-loader.lisp.

Function: describe-to-string (object)
Package

swank.

Source

swank.lisp.

Function: dispatch-event (connection event)

Handle an event triggered either by Emacs or within Lisp.

Package

swank.

Source

swank.lisp.

Function: dispatch-interrupt-event (connection)
Package

swank.

Source

swank.lisp.

Function: dispatch-loop (connection)
Package

swank.

Source

swank.lisp.

Function: dump-event (event stream)
Package

swank.

Source

swank.lisp.

Function: dump-event-history (stream)
Package

swank.

Source

swank.lisp.

Function: emacs-buffer-source-location (code-location plist)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: emacs-inspect-array-aux (array)
Package

swank.

Source

swank.lisp.

Function: emacs-inspect-vector-with-fill-pointer-aux (array)
Package

swank.

Source

swank.lisp.

Function: emacs-inspect/istate (istate)
Package

swank.

Source

swank.lisp.

Function: enable-sigio-on-fd (fd)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: encode-message (message stream)

Write an S-expression to STREAM using the SLIME protocol.

Package

swank.

Source

swank.lisp.

Function: encoding-error (condition string)
Package

swank/rpc.

Source

rpc.lisp.

Function: ensure-istate-metadata (o indicator default)
Package

swank.

Source

swank.lisp.

Function: ensure-list (thing)
Package

swank.

Source

swank.lisp.

Function: escape-non-ascii (string)

Return a string like STRING but with non-ascii chars escaped.

Package

swank.

Source

swank.lisp.

Function: escape-string (string stream &key length map)

Write STRING to STREAM surronded by double-quotes. LENGTH – if non-nil truncate output after LENGTH chars. MAP – rewrite the chars in STRING according to this alist.

Package

swank.

Source

swank.lisp.

Function: eval-in-frame-aux (frame string package print)
Package

swank.

Source

swank.lisp.

Function: eval-region (string)

Evaluate STRING.
Return the results of the last form as a list and as secondary value the last form.

Package

swank.

Source

swank.lisp.

Function: event-history-to-list ()

Return the list of events (older events first).

Package

swank.

Source

swank.lisp.

Function: event-match-p (event pattern)
Package

swank.

Source

swank.lisp.

Function: execv (program args)

Replace current executable with another one.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: expand (form &optional environment)
Package

swank.

Source

swank.lisp.

Function: expand-1 (form &optional environment)
Package

swank.

Source

swank.lisp.

Function: expand-select-patterns (key patterns)
Package

swank/match.

Source

match.lisp.

Function: expand-select-patterns-style-1 (key patterns)
Package

swank/match.

Source

match.lisp.

Function: expand-select-patterns-style-2 (key patterns)
Package

swank/match.

Source

match.lisp.

Function: externalize-reference (ref)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: extract-package (line)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: fallback-source-location (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: fasl-pathname (input-file options)
Package

swank.

Source

swank.lisp.

Function: fd-stream-input-buffer-empty-p (stream)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: feature-in-list-p (feature list)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: features-for-emacs ()

Return ‘*slime-features*’ in a format suitable to send it to Emacs.

Package

swank.

Source

swank.lisp.

Function: file-form-number-position (definition-source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: file-newer-p (new-file old-file)

Returns true if NEW-FILE is newer than OLD-FILE.

Package

swank.

Source

swank.lisp.

Function: file-newer-p (new-file old-file)

Returns true if NEW-FILE is newer than OLD-FILE.

Package

swank-loader.

Source

swank-loader.lisp.

Function: file-source-location (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: find-channel (id)
Package

swank.

Source

swank.lisp.

Function: find-definition (string)
Package

swank.

Source

swank.lisp.

Function: find-definitions-find-symbol-or-package (name)
Package

swank.

Source

swank.lisp.

Function: find-external-format-or-lose (coding-system)
Package

swank.

Source

swank.lisp.

Function: find-module (module)
Package

swank.

Source

swank.lisp.

Function: find-symbol-with-status (symbol-name status &optional package)
Package

swank.

Source

swank.lisp.

Function: force-user-output ()
Package

swank.

Source

swank.lisp.

Function: form-number-position (definition-source stream)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: format-completion-set (strings internal-p package-name)

Format a set of completion strings.
Returns a list of completions with package qualifiers if needed.

Package

swank.

Source

swank.lisp.

Function: format-restarts-for-emacs ()

Return a list of restarts for *swank-debugger-condition* in a format suitable for Emacs.

Package

swank.

Source

swank.lisp.

Function: format-values-for-echo-area (values)
Package

swank.

Source

swank.lisp.

Function: frame-debug-vars (frame)

Return a vector of debug-variables in frame.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: frame-locals-for-emacs (index)
Package

swank.

Source

swank.lisp.

Function: frame-to-string (frame)
Package

swank.

Source

swank.lisp.

Function: function-dspec (fn)

Describe where the function FN was defined. Return a list of the form (NAME LOCATION).

Package

swank/sbcl.

Source

sbcl.lisp.

Function: function-source-location (function &optional name)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: guess-buffer-package (string)

Return a package for STRING.
Fall back to the current if no such package exists.

Package

swank.

Source

swank.lisp.

Function: guess-buffer-readtable (package-name)
Package

swank.

Source

swank.lisp.

Function: guess-package (string)

Guess which package corresponds to STRING. Return nil if no package matches.

Package

swank.

Source

swank.lisp.

Function: guess-reader-state (stream)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: guess-readtable-for-filename (filename)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: handle-indentation-cache-request (connection request)
Package

swank.

Source

swank.lisp.

Function: handle-notification-condition (condition)

Handle a condition caused by a compiler warning.
This traps all compiler conditions at a lower-level than using C:*COMPILER-NOTIFICATION-FUNCTION*. The advantage is that we get to craft our own error messages, which can omit a lot of redundant information.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: handle-requests (connection &optional timeout)

Read and process :emacs-rex requests.
The processing is done in the extent of the toplevel restart.

Package

swank.

Source

swank.lisp.

Function: handle-sldb-condition (condition)

Handle an internal debugger condition.
Rather than recursively debug the debugger (a dangerous idea!), these conditions are simply reported.

Package

swank.

Source

swank.lisp.

Function: handle-swank-load-error (condition context pathname)
Package

swank-loader.

Source

swank-loader.lisp.

Function: hash-table-to-alist (ht)
Package

swank.

Source

swank.lisp.

Function: ignored-xref-function-names ()
Package

swank/sbcl.

Source

sbcl.lisp.

Function: iline (label value)
Package

swank.

Source

swank.lisp.

Function: indentation-cache-loop (connection)
Package

swank.

Source

swank.lisp.

Function: init ()
Package

swank.

Source

swank.lisp.

Function: init-log-output ()
Package

swank.

Source

swank.lisp.

Function: input-ready-p (stream)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: inspect-cons (cons)
Package

swank.

Source

swank.lisp.

Function: inspect-list (list)
Package

swank.

Source

swank.lisp.

Function: inspect-list-aux (list)
Package

swank.

Source

swank.lisp.

Function: inspect-object (o)
Package

swank.

Source

swank.lisp.

Function: inspector-state-p (object)
Package

swank.

Source

swank.lisp.

Function: install-debugger (connection)
Package

swank.

Source

swank.lisp.

Function: install-fd-handler (connection)
Package

swank.

Source

swank.lisp.

Function: install-sigio-handler (connection)
Package

swank.

Source

swank.lisp.

Function: interrupt-worker-thread (connection id)
Package

swank.

Source

swank.lisp.

Function: invoke-default-debugger (condition)
Package

swank.

Source

swank.lisp.

Function: invoke-or-queue-interrupt (function)
Package

swank.

Source

swank.lisp.

Function: istate-p (object)
Package

swank.

Source

swank.lisp.

Reader: istate.actions (instance)
Writer: (setf istate.actions) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

actions.

Reader: istate.content (instance)
Writer: (setf istate.content) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

content.

Reader: istate.metadata-plist (instance)
Writer: (setf istate.metadata-plist) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

metadata-plist.

Reader: istate.next (instance)
Writer: (setf istate.next) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

next.

Reader: istate.object (instance)
Writer: (setf istate.object) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

object.

Reader: istate.parts (instance)
Writer: (setf istate.parts) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

parts.

Reader: istate.previous (instance)
Writer: (setf istate.previous) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

previous.

Reader: istate.verbose (instance)
Writer: (setf istate.verbose) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

verbose.

Function: istate>elisp (istate)
Package

swank.

Source

swank.lisp.

Function: known-to-emacs-p (symbol)

Return true if Emacs has special rules for indenting SYMBOL.

Package

swank.

Source

swank.lisp.

Reader: lcons-%cdr (instance)
Writer: (setf lcons-%cdr) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

%cdr.

Reader: lcons-car (instance)
Writer: (setf lcons-car) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

car.

Function: lcons-cdr (lcons)
Package

swank.

Source

swank.lisp.

Reader: lcons-forced? (instance)
Writer: (setf lcons-forced?) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

forced?.

Function: lcons? (object)
Package

swank.

Source

swank.lisp.

Function: lisp-source-location (code-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: lisp-version-string ()
Package

swank-loader.

Source

swank-loader.lisp.

Function: list-swank-packages ()
Package

swank-loader.

Source

swank-loader.lisp.

Function: listify (f)

Return a function like F, but which returns any non-null value wrapped in a list.

Package

swank.

Source

swank.lisp.

Function: llist-range (llist start end)
Package

swank.

Source

swank.lisp.

Function: llist-skip (lcons index)
Package

swank.

Source

swank.lisp.

Function: llist-take (lcons count)
Package

swank.

Source

swank.lisp.

Function: load-site-init-file (dir)
Package

swank-loader.

Source

swank-loader.lisp.

Function: load-swank (&key src-dir fasl-dir quiet)
Package

swank-loader.

Source

swank-loader.lisp.

Function: load-user-init-file ()

Load the user init file, return NIL if it does not exist.

Package

swank-loader.

Source

swank-loader.lisp.

Function: loadup ()
Package

swank-loader.

Source

swank-loader.lisp.

Function: locate-compiler-note (file source-path source)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: location-type (structure)
Package

swank/backend.

Source

backend.lisp.

Function: (setf location-type) (structure)
Package

swank/backend.

Source

backend.lisp.

Function: log-event (format-string &rest args)

Write a message to *terminal-io* when *log-events* is non-nil. Useful for low level debugging.

Package

swank.

Source

swank.lisp.

Function: longest-common-prefix (strings)

Return the longest string that is a common prefix of STRINGS.

Package

swank.

Source

swank.lisp.

Function: macro-indentation (arglist)
Package

swank.

Source

swank.lisp.

Function: mailbox (thread)

Return THREAD’s mailbox.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: mailbox-p (object)
Package

swank/sbcl.

Source

sbcl.lisp.

Reader: mailbox.mutex (instance)
Writer: (setf mailbox.mutex) (instance)
Package

swank/sbcl.

Source

sbcl.lisp.

Target Slot

mutex.

Reader: mailbox.queue (instance)
Writer: (setf mailbox.queue) (instance)
Package

swank/sbcl.

Source

sbcl.lisp.

Target Slot

queue.

Reader: mailbox.thread (instance)
Writer: (setf mailbox.thread) (instance)
Package

swank/sbcl.

Source

sbcl.lisp.

Target Slot

thread.

Reader: mailbox.waitqueue (instance)
Writer: (setf mailbox.waitqueue) (instance)
Package

swank/sbcl.

Source

sbcl.lisp.

Target Slot

waitqueue.

Function: make-apropos-matcher (pattern case-sensitive)
Package

swank.

Source

swank.lisp.

Function: make-compilation-result (&key type notes successp duration loadp faslfile)
Package

swank.

Source

swank.lisp.

Function: make-compiler-note (condition)

Make a compiler note data structure from a compiler-condition.

Package

swank.

Source

swank.lisp.

Function: make-connection (socket stream style)
Package

swank.

Source

swank.lisp.

Function: make-dspec (type name source-location)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: make-inspector-state (&key)
Package

swank.

Source

swank.lisp.

Function: make-invoke-debugger-hook (hook)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: make-istate (&key object verbose parts actions metadata-plist content next previous)
Package

swank.

Source

swank.lisp.

Function: make-mailbox (&key thread mutex waitqueue queue)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: make-multithreaded-connection (&key socket socket-io dedicated-output user-input user-output user-io env trace-output repl-results indentation-cache indentation-cache-packages communication-style reader-thread control-thread repl-thread auto-flush-thread indentation-cache-thread active-threads)
Package

swank.

Source

swank.lisp.

Function: make-repl-input-stream (connection stdin)
Package

swank.

Source

swank.lisp.

Function: make-sharpdot-reader (orig-sharpdot-reader)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: make-singlethreaded-connection (&key socket socket-io dedicated-output user-input user-output user-io env trace-output repl-results indentation-cache indentation-cache-packages communication-style saved-sigint-handler event-queue events-enqueued)
Package

swank.

Source

swank.lisp.

Function: make-socket-io-stream (socket external-format buffering)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: make-source-cache-entry (text date)
Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: make-source-recorder (fn source-map)

Return a macro character function that does the same as FN, but additionally stores the result together with the stream positions before and after of calling FN in the hashtable SOURCE-MAP.

Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: make-source-recording-readtable (readtable source-map)

Return a source position recording copy of READTABLE. The source locations are stored in SOURCE-MAP.

Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: make-tag ()
Package

swank.

Source

swank.lisp.

Function: make-unreadable-result (string)
Package

swank.

Source

swank.lisp.

Function: map-if (test fn &rest lists)

Like (mapcar FN . LISTS) but only call FN on objects satisfying TEST. Example:
(map-if #’oddp #’- ’(1 2 3 4 5)) => (-1 2 -3 4 -5)

Package

swank.

Source

swank.lisp.

Function: matching-symbols (package external test)
Package

swank.

Source

swank.lisp.

Function: maybe-schedule-flush (stream)
Package

swank/gray.

Source

gray.lisp.

Function: maybe-slow-down ()
Package

swank.

Source

swank.lisp.

Reader: mconn.active-threads (instance)
Writer: (setf mconn.active-threads) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

active-threads.

Reader: mconn.auto-flush-thread (instance)
Writer: (setf mconn.auto-flush-thread) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

auto-flush-thread.

Function: mconn.communication-style (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.communication-style) (instance)
Package

swank.

Source

swank.lisp.

Reader: mconn.control-thread (instance)
Writer: (setf mconn.control-thread) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

control-thread.

Function: mconn.dedicated-output (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.dedicated-output) (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.env (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.env) (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.indentation-cache (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.indentation-cache) (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.indentation-cache-packages (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.indentation-cache-packages) (instance)
Package

swank.

Source

swank.lisp.

Reader: mconn.indentation-cache-thread (instance)
Writer: (setf mconn.indentation-cache-thread) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

indentation-cache-thread.

Reader: mconn.reader-thread (instance)
Writer: (setf mconn.reader-thread) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

reader-thread.

Function: mconn.repl-results (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.repl-results) (instance)
Package

swank.

Source

swank.lisp.

Reader: mconn.repl-thread (instance)
Writer: (setf mconn.repl-thread) (instance)
Package

swank.

Source

swank.lisp.

Target Slot

repl-thread.

Function: mconn.socket (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.socket-io (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.trace-output (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.trace-output) (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.user-input (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.user-input) (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.user-io (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.user-io) (instance)
Package

swank.

Source

swank.lisp.

Function: mconn.user-output (instance)
Package

swank.

Source

swank.lisp.

Function: (setf mconn.user-output) (instance)
Package

swank.

Source

swank.lisp.

Function: measure-time-interval (fun)

Call FUN and return the first return value and the elapsed time. The time is measured in seconds.

Package

swank.

Source

swank.lisp.

Function: merged-directory (dirname defaults)
Package

swank.

Source

swank.lisp.

Function: missing-arg ()

A function that the compiler knows will never to return a value. You can use (MISSING-ARG) as the initform for defstruct slots that must always be supplied. This way the :TYPE slot option need not include some arbitrary initial value like NIL.

Package

swank.

Source

swank.lisp.

Function: module-candidates (name dir)
Package

swank.

Source

swank.lisp.

Function: module-filename (module)

Return the filename for the module MODULE.

Package

swank.

Source

swank.lisp.

Function: mop-helper (class-name fn)
Package

swank.

Source

swank.lisp.

Function: multithreaded-connection-p (object)
Package

swank.

Source

swank.lisp.

Function: need-full-indentation-update-p (connection)

Return true if the whole indentation cache should be updated. This is a heuristic to avoid scanning all symbols all the time: instead, we only do a full scan if the set of packages has changed.

Package

swank.

Source

swank.lisp.

Function: notify-backend-of-connection (connection)
Package

swank.

Source

swank.lisp.

Function: nth-frame (index)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: nth-restart (index)
Package

swank.

Source

swank.lisp.

Function: nth-thread (index)
Package

swank.

Source

swank.lisp.

Function: package-names (package)

Return the name and all nicknames of PACKAGE in a fresh list.

Package

swank.

Source

swank.lisp.

Function: package-string-for-prompt (package)

Return the shortest nickname (or canonical name) of PACKAGE.

Package

swank.

Source

swank.lisp.

Function: parse-header (stream)
Package

swank/rpc.

Source

rpc.lisp.

Function: parse-package (string)

Find the package named STRING. Return the package or nil.

Package

swank.

Source

swank.lisp.

Function: parse-symbol (string &optional package)

Find the symbol named STRING.
Return the symbol and a flag indicating whether the symbols was found.

Package

swank.

Source

swank.lisp.

Function: parse-symbol-or-lose (string &optional package)
Package

swank.

Source

swank.lisp.

Function: pathname-as-directory (pathname)
Package

swank.

Source

swank.lisp.

Function: perform-indentation-update (connection force package)

Update the indentation cache in CONNECTION and update Emacs.
If FORCE is true then start again without considering the old cache.

Package

swank.

Source

swank.lisp.

Function: ping-pong ()
Package

swank.

Source

swank.lisp.

Function: poll-for-event (connection pattern)
Package

swank.

Source

swank.lisp.

Function: prefix-match-p (prefix string)

Return true if PREFIX is a prefix of STRING.

Package

swank.

Source

swank.lisp.

Function: prepare-part (part istate)
Package

swank.

Source

swank.lisp.

Function: prepare-range (istate start end)
Package

swank.

Source

swank.lisp.

Function: prepare-title (istate)
Package

swank.

Source

swank.lisp.

Function: present-symbol-before-p (x y)

Return true if X belongs before Y in a printed summary of symbols. Sorted alphabetically by package name and then symbol name, except that symbols accessible in the current package go first.

Package

swank.

Source

swank.lisp.

Function: prin1-to-string-for-emacs (object package)
Package

swank/rpc.

Source

rpc.lisp.

Function: print-connection (conn stream depth)
Package

swank.

Source

swank.lisp.

Function: print-part-to-string (value)
Package

swank.

Source

swank.lisp.

Function: process-form-for-emacs (form)

Returns a string which emacs will read as equivalent to
FORM. FORM can contain lists, strings, characters, symbols and numbers.

Characters are converted emacs’ ?<char> notaion, strings are left as they are (except for espacing any nested " chars, numbers are printed in base 10 and symbols are printed as their symbol-name converted to lower case.

Package

swank.

Source

swank.lisp.

Function: process-fspec (fspec)
Package

swank/sbcl.

Source

sbcl.lisp.

Function: process-io-interrupt (connection)
Package

swank.

Source

swank.lisp.

Function: process-requests (timeout)

Read and process requests from Emacs.

Package

swank.

Source

swank.lisp.

Function: profiledp (fspec)
Package

swank.

Source

swank.lisp.

Function: q (s)
Package

swank-loader.

Source

swank-loader.lisp.

Function: queue-thread-interrupt (thread function)
Package

swank.

Source

swank.lisp.

Function: read-and-record-source-map (stream)

Read the next object from STREAM.
Return the object together with a hashtable that maps subexpressions of the object to stream positions.

Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: read-chunk (stream length)
Package

swank/rpc.

Source

rpc.lisp.

Function: read-file (filename)

Return the entire contents of FILENAME as a string.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: read-form (string package)
Package

swank/rpc.

Source

rpc.lisp.

Function: read-from-minibuffer-in-emacs (prompt &optional initial-value)

Ask user a question in Emacs’ minibuffer. Returns "" when user entered nothing, returns NIL when user pressed C-g.

Package

swank.

Source

swank.lisp.

Function: read-loop (connection)
Package

swank.

Source

swank.lisp.

Function: read-non-blocking (stream)
Package

swank.

Source

swank.lisp.

Function: read-upto-n-chars (stream n)

Return a string of upto N chars from STREAM.

Package

swank/source-file-cache.

Source

source-file-cache.lisp.

Function: readtable-for-package (package)
Package

swank/source-path-parser.

Source

source-path-parser.lisp.

Function: real-condition (condition)

Return the encapsulated condition or CONDITION itself.

Package

swank/sbcl.

Source

sbcl.lisp.

Function: real-input-stream (stream)
Package

swank.

Source

swank.lisp.

Function: real-output-stream (stream)
Package

swank.

Source

swank.lisp.

Function: remove-active-thread (connection thread)
Package

swank.

Source

swank.lisp.

Function: repl-input-stream-read (connection stdin)
Package

swank.

Source

swank.lisp.

Function: requires-compile-p (source-file)
Package

swank.

Source

swank.lisp.

Function: reset-inspector ()
Package