The swank Reference Manual

This is the swank Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:54:18 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 Component

swank-loader.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 swank/swank.asd

Source

swank.asd.

Parent Component

swank (system).

ASDF Systems

swank.


3.1.2 swank/swank-loader.lisp

Source

swank.asd.

Parent Component

swank (system).

Packages

swank-loader.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 swank-loader

Source

swank-loader.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *fasl-directory*

The directory where fasl files should be placed.

Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *source-directory*

The directory where to look for the source.

Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *started-from-emacs*
Package

swank-loader.

Source

swank-loader.lisp.


5.1.2 Ordinary functions

Function: dump-image (filename)
Package

swank-loader.

Source

swank-loader.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: list-fasls (&key include-contribs compile quiet)

List up SWANK’s fasls along with their dependencies.

Package

swank-loader.

Source

swank-loader.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *architecture-features*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *contribs*

List of names for contrib modules.

Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *implementation-features*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *os-features*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *swank-files*
Package

swank-loader.

Source

swank-loader.lisp.

Special Variable: *sysdep-files*
Package

swank-loader.

Source

swank-loader.lisp.


5.2.2 Ordinary functions

Function: append-dir (absolute name)
Package

swank-loader.

Source

swank-loader.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: compile-contribs (&key src-dir fasl-dir swank-src-dir load quiet)
Package

swank-loader.

Source

swank-loader.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: contrib-dir (base-dir)
Package

swank-loader.

Source

swank-loader.lisp.

Function: default-fasl-dir ()
Package

swank-loader.

Source

swank-loader.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: 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: handle-swank-load-error (condition context pathname)
Package

swank-loader.

Source

swank-loader.lisp.

Function: lisp-version-string ()
Package

swank-loader.

Source

swank-loader.lisp.

Function: list-swank-packages ()
Package

swank-loader.

Source

swank-loader.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: q (s)
Package

swank-loader.

Source

swank-loader.lisp.

Function: setup ()
Package

swank-loader.

Source

swank-loader.lisp.

Function: slime-version-string ()

Return a string identifying the SLIME version. Return nil if nothing appropriate is available.

Package

swank-loader.

Source

swank-loader.lisp.

Function: src-files (names src-dir)
Package

swank-loader.

Source

swank-loader.lisp.

Function: string-starts-with (string prefix)
Package

swank-loader.

Source

swank-loader.lisp.

Function: unique-dir-name ()

Return a name that can be used as a directory name that is unique to a Lisp implementation, Lisp implementation version, operating system, and hardware architecture.

Package

swank-loader.

Source

swank-loader.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   B   C   D   F   H   I   L   Q   S   U  
Index Entry  Section

A
append-dir: Private ordinary functions

B
binary-pathname: Private ordinary functions

C
compile-contribs: Private ordinary functions
compile-files: Private ordinary functions
contrib-dir: Private ordinary functions

D
default-fasl-dir: Private ordinary functions
delete-packages: Private ordinary functions
delete-stale-contrib-fasl-files: Private ordinary functions
dump-image: Public ordinary functions

F
file-newer-p: Private ordinary functions
Function, append-dir: Private ordinary functions
Function, binary-pathname: Private ordinary functions
Function, compile-contribs: Private ordinary functions
Function, compile-files: Private ordinary functions
Function, contrib-dir: Private ordinary functions
Function, default-fasl-dir: Private ordinary functions
Function, delete-packages: Private ordinary functions
Function, delete-stale-contrib-fasl-files: Private ordinary functions
Function, dump-image: Public ordinary functions
Function, file-newer-p: Private ordinary functions
Function, handle-swank-load-error: Private ordinary functions
Function, init: Public ordinary functions
Function, lisp-version-string: Private ordinary functions
Function, list-fasls: Public ordinary functions
Function, list-swank-packages: Private ordinary functions
Function, load-site-init-file: Private ordinary functions
Function, load-swank: Private ordinary functions
Function, load-user-init-file: Private ordinary functions
Function, loadup: Private ordinary functions
Function, q: Private ordinary functions
Function, setup: Private ordinary functions
Function, slime-version-string: Private ordinary functions
Function, src-files: Private ordinary functions
Function, string-starts-with: Private ordinary functions
Function, unique-dir-name: Private ordinary functions

H
handle-swank-load-error: Private ordinary functions

I
init: Public ordinary functions

L
lisp-version-string: Private ordinary functions
list-fasls: Public ordinary functions
list-swank-packages: Private ordinary functions
load-site-init-file: Private ordinary functions
load-swank: Private ordinary functions
load-user-init-file: Private ordinary functions
loadup: Private ordinary functions

Q
q: Private ordinary functions

S
setup: Private ordinary functions
slime-version-string: Private ordinary functions
src-files: Private ordinary functions
string-starts-with: Private ordinary functions

U
unique-dir-name: Private ordinary functions