The lisp-invocation Reference Manual

This is the lisp-invocation Reference Manual, version 1.0.14, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:01:55 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 lisp-invocation

Invoking Lisp subprocesses from Lisp

Maintainer

Francois-Rene Rideau

Author

Francois-Rene Rideau

License

MIT

Long Description

lisp-invocation allows you to portably execute Lisp code
as subprocesses of a current Lisp process.
All known command-line accessible Common Lisp implementations are supported.

Version

1.0.14

Dependencies
Source

lisp-invocation.asd.


2.2 lisp-invocation/lisp-invocation

Maintainer

Francois-Rene Rideau

Author

Francois-Rene Rideau

License

MIT

Source

lisp-invocation.asd.


2.3 lisp-invocation/implementations

Maintainer

Francois-Rene Rideau

Author

Francois-Rene Rideau

License

MIT

Dependency

lisp-invocation/lisp-invocation (system).

Source

lisp-invocation.asd.


3 Files

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


3.1 Lisp


3.1.1 lisp-invocation/lisp-invocation.asd

Source

lisp-invocation.asd.

Parent Component

lisp-invocation (system).

ASDF Systems

3.1.2 lisp-invocation/lisp-invocation/file-type.lisp

Source

lisp-invocation.asd.

Parent Component

lisp-invocation/lisp-invocation (system).

Packages

lisp-invocation/lisp-invocation.

Public Interface
Internals

3.1.3 lisp-invocation/implementations/file-type.lisp

Source

lisp-invocation.asd.

Parent Component

lisp-invocation/implementations (system).

Packages

lisp-invocation/implementations.


4 Packages

Packages are listed by definition order.


4.1 lisp-invocation/implementations

Source

file-type.lisp.

Use List

4.2 lisp-invocation/lisp-invocation

Source

file-type.lisp.

Nickname

lisp-invocation

Use List
  • common-lisp.
  • uiop/driver.
Used By List

lisp-invocation/implementations.

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 Macros

Macro: define-lisp-implementation (key (&optional class) &rest keys)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.


5.1.2 Ordinary functions

Function: ensure-path-executable (x)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: get-lisp-implementation (&optional implementation-type)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: invoke-lisp (&rest keys &key implementation-type lisp-path lisp-flags image-path console load eval arguments debugger cross-compile run-program run-program-args)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: invoke-lisp-directly (&rest keys &key implementation-type lisp-path lisp-flags image-path console load eval arguments debugger cross-compile run-program run-program-args)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: invoke-lisp-via-script (&rest keys &key implementation-type lisp-path lisp-flags image-path console load eval arguments debugger cross-compile run-program run-program-args)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: lisp-environment-variable-name (&key type prefix suffix)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: lisp-invocation-arglist (&rest keys &key implementation-type &allow-other-keys)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: quit-form (&key code implementation-type)

Returns the correct form to quit lisp, based on the value of lisp-implementation. Can optionally be given a unix status CODE to exit with

Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: register-lisp-implementation (class identifiers &rest keys)

Register the lisp implementation identified by the IDENTIFIERS argument (a keyword or list of keywords), with given option KEYS.

Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: register-lisp-implementation* (x)

Register the lisp implementation described by the list X, which consists of a name followed by a plist of keywords and arguments.

Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Function: save-image-form (filepath &optional implementation-type)

Returns the lisp form to save the lisp image to the given filepath

Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.


5.1.3 Generic functions

Generic Reader: lisp-implementation-argument-control (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-argument-control ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

argument-control.

Generic Reader: lisp-implementation-arguments-end (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-arguments-end ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

arguments-end.

Generic Reader: lisp-implementation-directory-variable (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-directory-variable ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

directory-variable.

Generic Reader: lisp-implementation-disable-debugger (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-disable-debugger ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

disable-debugger.

Generic Reader: lisp-implementation-environment-variable (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-environment-variable ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

environment-variable.

Generic Reader: lisp-implementation-eval-flag (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-eval-flag ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

eval-flag.

Generic Reader: lisp-implementation-feature (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-feature ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

feature.

Generic Reader: lisp-implementation-flags (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-flags ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

flags.

Generic Reader: lisp-implementation-fullname (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-fullname ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

fullname.

Generic Reader: lisp-implementation-image-executable-p (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-image-executable-p ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

image-executable-p.

Generic Reader: lisp-implementation-image-flag (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-image-flag ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

image-flag.

Generic Function: lisp-implementation-implementation-type (impl)
Package

lisp-invocation/lisp-invocation.

Methods
Method: lisp-implementation-implementation-type ((impl lisp-implementation))
Source

file-type.lisp.

Generic Function: lisp-implementation-invocation-arglist (implementation &key lisp-path lisp-flags image-path load eval arguments debugger cross-compile console)
Package

lisp-invocation/lisp-invocation.

Methods
Method: lisp-implementation-invocation-arglist ((implementation simple-lisp-implementation) &key lisp-path lisp-flags image-path load eval arguments debugger cross-compile console)
Source

file-type.lisp.

Generic Reader: lisp-implementation-invoker (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-invoker ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

invoker.

Generic Reader: lisp-implementation-load-flag (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-load-flag ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

load-flag.

Generic Reader: lisp-implementation-name (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-name ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Reader: lisp-implementation-standalone-executable (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-standalone-executable ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

standalone-executable.


5.1.4 Classes

Class: lisp-implementation
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Direct subclasses

simple-lisp-implementation.

Direct methods
Direct slots
Slot: identifiers
Initargs

:identifiers

Readers

lisp-implementation-identifiers.

Writers

This slot is read-only.

Class: simple-lisp-implementation
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.

Direct superclasses

lisp-implementation.

Direct methods
Direct slots
Slot: fullname
Initargs

:fullname

Readers

lisp-implementation-fullname.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

lisp-implementation-name.

Writers

This slot is read-only.

Slot: feature
Initargs

:feature

Readers

lisp-implementation-feature.

Writers

This slot is read-only.

Slot: environment-variable
Initargs

:environment-variable

Readers

lisp-implementation-environment-variable.

Writers

This slot is read-only.

Slot: flags
Initargs

:flags

Readers

lisp-implementation-flags.

Writers

This slot is read-only.

Slot: eval-flag
Initargs

:eval-flag

Readers

lisp-implementation-eval-flag.

Writers

This slot is read-only.

Slot: load-flag
Initargs

:load-flag

Readers

lisp-implementation-load-flag.

Writers

This slot is read-only.

Slot: arguments-end
Initargs

:arguments-end

Readers

lisp-implementation-arguments-end.

Writers

This slot is read-only.

Slot: image-flag
Initargs

:image-flag

Readers

lisp-implementation-image-flag.

Writers

This slot is read-only.

Slot: image-executable-p
Initargs

:image-executable-p

Readers

lisp-implementation-image-executable-p.

Writers

This slot is read-only.

Slot: default-image
Initargs

:default-image

Readers

lisp-implementation-default-image.

Writers

This slot is read-only.

Slot: standalone-executable
Initargs

:standalone-executable

Readers

lisp-implementation-standalone-executable.

Writers

This slot is read-only.

Slot: argument-control
Initargs

:argument-control

Readers

lisp-implementation-argument-control.

Writers

This slot is read-only.

Slot: disable-debugger
Initargs

:disable-debugger

Readers

lisp-implementation-disable-debugger.

Writers

This slot is read-only.

Slot: directory-variable
Initargs

:directory-variable

Readers

lisp-implementation-directory-variable.

Writers

This slot is read-only.

Slot: invoker
Initargs

:invoker

Readers

lisp-implementation-invoker.

Writers

This slot is read-only.

Slot: quit-format
Initargs

:quit-format

Readers

lisp-implementation-quit-format.

Writers

This slot is read-only.

Slot: dump-format
Initargs

:dump-format

Readers

lisp-implementation-dump-format.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *lisp-implementations*

Dictionary of known Lisp implementations

Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.


5.2.2 Ordinary functions

Function: lisp-invoker (&optional implementation-type)
Package

lisp-invocation/lisp-invocation.

Source

file-type.lisp.


5.2.3 Generic functions

Generic Reader: lisp-implementation-default-image (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-default-image ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

default-image.

Generic Reader: lisp-implementation-dump-format (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-dump-format ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

dump-format.

Generic Reader: lisp-implementation-identifiers (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-identifiers ((lisp-implementation lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

identifiers.

Generic Reader: lisp-implementation-quit-format (object)
Package

lisp-invocation/lisp-invocation.

Methods
Reader Method: lisp-implementation-quit-format ((simple-lisp-implementation simple-lisp-implementation))

automatically generated reader method

Source

file-type.lisp.

Target Slot

quit-format.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   D   E   F   G   I   L   M   Q   R   S  
Index Entry  Section

D
define-lisp-implementation: Public macros

E
ensure-path-executable: Public ordinary functions

F
Function, ensure-path-executable: Public ordinary functions
Function, get-lisp-implementation: Public ordinary functions
Function, invoke-lisp: Public ordinary functions
Function, invoke-lisp-directly: Public ordinary functions
Function, invoke-lisp-via-script: Public ordinary functions
Function, lisp-environment-variable-name: Public ordinary functions
Function, lisp-invocation-arglist: Public ordinary functions
Function, lisp-invoker: Private ordinary functions
Function, quit-form: Public ordinary functions
Function, register-lisp-implementation: Public ordinary functions
Function, register-lisp-implementation*: Public ordinary functions
Function, save-image-form: Public ordinary functions

G
Generic Function, lisp-implementation-argument-control: Public generic functions
Generic Function, lisp-implementation-arguments-end: Public generic functions
Generic Function, lisp-implementation-default-image: Private generic functions
Generic Function, lisp-implementation-directory-variable: Public generic functions
Generic Function, lisp-implementation-disable-debugger: Public generic functions
Generic Function, lisp-implementation-dump-format: Private generic functions
Generic Function, lisp-implementation-environment-variable: Public generic functions
Generic Function, lisp-implementation-eval-flag: Public generic functions
Generic Function, lisp-implementation-feature: Public generic functions
Generic Function, lisp-implementation-flags: Public generic functions
Generic Function, lisp-implementation-fullname: Public generic functions
Generic Function, lisp-implementation-identifiers: Private generic functions
Generic Function, lisp-implementation-image-executable-p: Public generic functions
Generic Function, lisp-implementation-image-flag: Public generic functions
Generic Function, lisp-implementation-implementation-type: Public generic functions
Generic Function, lisp-implementation-invocation-arglist: Public generic functions
Generic Function, lisp-implementation-invoker: Public generic functions
Generic Function, lisp-implementation-load-flag: Public generic functions
Generic Function, lisp-implementation-name: Public generic functions
Generic Function, lisp-implementation-quit-format: Private generic functions
Generic Function, lisp-implementation-standalone-executable: Public generic functions
get-lisp-implementation: Public ordinary functions

I
invoke-lisp: Public ordinary functions
invoke-lisp-directly: Public ordinary functions
invoke-lisp-via-script: Public ordinary functions

L
lisp-environment-variable-name: Public ordinary functions
lisp-implementation-argument-control: Public generic functions
lisp-implementation-argument-control: Public generic functions
lisp-implementation-arguments-end: Public generic functions
lisp-implementation-arguments-end: Public generic functions
lisp-implementation-default-image: Private generic functions
lisp-implementation-default-image: Private generic functions
lisp-implementation-directory-variable: Public generic functions
lisp-implementation-directory-variable: Public generic functions
lisp-implementation-disable-debugger: Public generic functions
lisp-implementation-disable-debugger: Public generic functions
lisp-implementation-dump-format: Private generic functions
lisp-implementation-dump-format: Private generic functions
lisp-implementation-environment-variable: Public generic functions
lisp-implementation-environment-variable: Public generic functions
lisp-implementation-eval-flag: Public generic functions
lisp-implementation-eval-flag: Public generic functions
lisp-implementation-feature: Public generic functions
lisp-implementation-feature: Public generic functions
lisp-implementation-flags: Public generic functions
lisp-implementation-flags: Public generic functions
lisp-implementation-fullname: Public generic functions
lisp-implementation-fullname: Public generic functions
lisp-implementation-identifiers: Private generic functions
lisp-implementation-identifiers: Private generic functions
lisp-implementation-image-executable-p: Public generic functions
lisp-implementation-image-executable-p: Public generic functions
lisp-implementation-image-flag: Public generic functions
lisp-implementation-image-flag: Public generic functions
lisp-implementation-implementation-type: Public generic functions
lisp-implementation-implementation-type: Public generic functions
lisp-implementation-invocation-arglist: Public generic functions
lisp-implementation-invocation-arglist: Public generic functions
lisp-implementation-invoker: Public generic functions
lisp-implementation-invoker: Public generic functions
lisp-implementation-load-flag: Public generic functions
lisp-implementation-load-flag: Public generic functions
lisp-implementation-name: Public generic functions
lisp-implementation-name: Public generic functions
lisp-implementation-quit-format: Private generic functions
lisp-implementation-quit-format: Private generic functions
lisp-implementation-standalone-executable: Public generic functions
lisp-implementation-standalone-executable: Public generic functions
lisp-invocation-arglist: Public ordinary functions
lisp-invoker: Private ordinary functions

M
Macro, define-lisp-implementation: Public macros
Method, lisp-implementation-argument-control: Public generic functions
Method, lisp-implementation-arguments-end: Public generic functions
Method, lisp-implementation-default-image: Private generic functions
Method, lisp-implementation-directory-variable: Public generic functions
Method, lisp-implementation-disable-debugger: Public generic functions
Method, lisp-implementation-dump-format: Private generic functions
Method, lisp-implementation-environment-variable: Public generic functions
Method, lisp-implementation-eval-flag: Public generic functions
Method, lisp-implementation-feature: Public generic functions
Method, lisp-implementation-flags: Public generic functions
Method, lisp-implementation-fullname: Public generic functions
Method, lisp-implementation-identifiers: Private generic functions
Method, lisp-implementation-image-executable-p: Public generic functions
Method, lisp-implementation-image-flag: Public generic functions
Method, lisp-implementation-implementation-type: Public generic functions
Method, lisp-implementation-invocation-arglist: Public generic functions
Method, lisp-implementation-invoker: Public generic functions
Method, lisp-implementation-load-flag: Public generic functions
Method, lisp-implementation-name: Public generic functions
Method, lisp-implementation-quit-format: Private generic functions
Method, lisp-implementation-standalone-executable: Public generic functions

Q
quit-form: Public ordinary functions

R
register-lisp-implementation: Public ordinary functions
register-lisp-implementation*: Public ordinary functions

S
save-image-form: Public ordinary functions


A.3 Variables

Jump to:   *  
A   D   E   F   I   L   N   Q   S  
Index Entry  Section

*
*lisp-implementations*: Private special variables

A
argument-control: Public classes
arguments-end: Public classes

D
default-image: Public classes
directory-variable: Public classes
disable-debugger: Public classes
dump-format: Public classes

E
environment-variable: Public classes
eval-flag: Public classes

F
feature: Public classes
flags: Public classes
fullname: Public classes

I
identifiers: Public classes
image-executable-p: Public classes
image-flag: Public classes
invoker: Public classes

L
load-flag: Public classes

N
name: Public classes

Q
quit-format: Public classes

S
Slot, argument-control: Public classes
Slot, arguments-end: Public classes
Slot, default-image: Public classes
Slot, directory-variable: Public classes
Slot, disable-debugger: Public classes
Slot, dump-format: Public classes
Slot, environment-variable: Public classes
Slot, eval-flag: Public classes
Slot, feature: Public classes
Slot, flags: Public classes
Slot, fullname: Public classes
Slot, identifiers: Public classes
Slot, image-executable-p: Public classes
Slot, image-flag: Public classes
Slot, invoker: Public classes
Slot, load-flag: Public classes
Slot, name: Public classes
Slot, quit-format: Public classes
Slot, standalone-executable: Public classes
Special Variable, *lisp-implementations*: Private special variables
standalone-executable: Public classes


A.4 Data types