The lisp-invocation Reference Manual

Table of Contents

The lisp-invocation Reference Manual

This is the lisp-invocation Reference Manual, version 1.0.14, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:54:26 2021 GMT+0.

1 Introduction

lisp-invocation

lisp-invocation is a small library for starting Lisp processes from Common Lisp.

lisp-invocation actually only computes the proper command-line invocations; to actually run a process, you will use uiop:run-program, inferior-shell:run, or external-program:start.

Usage

A simple example: Starting an SBCL process, running some code and quitting. Here we use uiop:run-program to run the process and extract its output.

(let ((impl :sbcl))
  (uiop:run-program
   (lisp-invocation:lisp-invocation-arglist
    :implementation-type impl
    :eval (format nil "(progn (format t ~S '~S) ~A)"
                  "~{~31R~^ ~}~%" '(595756 9556552524 643802 496307950)
                  (lisp-invocation:quit-form :code 0 :implementation-type impl)))
   :output :string))

Requirements

lisp-invocation depends on ASDF 3.1.2 or later for its package-inferred-system, but you'd want it 3.1.2 anyway for its enhanced uiop:run-program.

License

Free Software available under an MIT-style license.

Copyright (c) 2008 ITA Software, Inc. All rights reserved.

2 Systems

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

2.1 lisp-invocation

Maintainer

Francois-Rene Rideau

Author

Francois-Rene Rideau

License

MIT

Description

Invoking Lisp subprocesses from Lisp

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

• lisp-invocation/lisp-invocation (system)
• lisp-invocation/implementations (system)

Source

lisp-invocation.asd (file)

2.2 lisp-invocation/implementations

Maintainer

Francois-Rene Rideau

Author

Francois-Rene Rideau

License

MIT

Dependency

lisp-invocation/lisp-invocation (system)

Source

lisp-invocation.asd (file)

Component

file-type.lisp (file)

2.3 lisp-invocation/lisp-invocation

Maintainer

Francois-Rene Rideau

Author

Francois-Rene Rideau

License

MIT

Source

lisp-invocation.asd (file)

Component

file-type.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 lisp-invocation.asd

Location

lisp-invocation.asd

Systems

• lisp-invocation (system)
• lisp-invocation/implementations (system)
• lisp-invocation/lisp-invocation (system)

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

Parent

lisp-invocation/implementations (system)

Location

implementations.lisp

Packages

lisp-invocation/implementations

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

Parent

lisp-invocation/lisp-invocation (system)

Location

lisp-invocation.lisp

Packages

lisp-invocation/lisp-invocation

Exported Definitions

• define-lisp-implementation (macro)
• ensure-path-executable (function)
• get-lisp-implementation (function)
• invoke-lisp (function)
• invoke-lisp-directly (function)
• invoke-lisp-via-script (function)
• lisp-environment-variable-name (function)
• lisp-implementation (class)
• lisp-implementation-argument-control (method)
• lisp-implementation-arguments-end (method)
• lisp-implementation-directory-variable (method)
• lisp-implementation-disable-debugger (method)
• lisp-implementation-environment-variable (method)
• lisp-implementation-eval-flag (method)
• lisp-implementation-feature (method)
• lisp-implementation-flags (method)
• lisp-implementation-fullname (method)
• lisp-implementation-image-executable-p (method)
• lisp-implementation-image-flag (method)
• lisp-implementation-implementation-type (method)
• lisp-implementation-invocation-arglist (method)
• lisp-implementation-invoker (method)
• lisp-implementation-load-flag (method)
• lisp-implementation-name (method)
• lisp-implementation-standalone-executable (method)
• lisp-invocation-arglist (function)
• quit-form (function)
• register-lisp-implementation (function)
• register-lisp-implementation* (function)
• save-image-form (function)
• simple-lisp-implementation (class)

Internal Definitions

• *lisp-implementations* (special variable)
• lisp-implementation-default-image (method)
• lisp-implementation-dump-format (method)
• lisp-implementation-identifiers (method)
• lisp-implementation-quit-format (method)
• lisp-invoker (function)

4 Packages

Packages are listed by definition order.

4.1 lisp-invocation/implementations

Source

file-type.lisp (file)

Use List

• lisp-invocation/lisp-invocation
• uiop/driver
• common-lisp

4.2 lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

Nickname

lisp-invocation

Use List

• uiop/driver
• common-lisp

Used By List

lisp-invocation/implementations

Exported Definitions

• define-lisp-implementation (macro)
• ensure-path-executable (function)
• get-lisp-implementation (function)
• invoke-lisp (function)
• invoke-lisp-directly (function)
• invoke-lisp-via-script (function)
• lisp-environment-variable-name (function)
• lisp-implementation (class)
• lisp-implementation-argument-control (generic function)
• lisp-implementation-argument-control (method)
• lisp-implementation-arguments-end (generic function)
• lisp-implementation-arguments-end (method)
• lisp-implementation-directory-variable (generic function)
• lisp-implementation-directory-variable (method)
• lisp-implementation-disable-debugger (generic function)
• lisp-implementation-disable-debugger (method)
• lisp-implementation-environment-variable (generic function)
• lisp-implementation-environment-variable (method)
• lisp-implementation-eval-flag (generic function)
• lisp-implementation-eval-flag (method)
• lisp-implementation-feature (generic function)
• lisp-implementation-feature (method)
• lisp-implementation-flags (generic function)
• lisp-implementation-flags (method)
• lisp-implementation-fullname (generic function)
• lisp-implementation-fullname (method)
• lisp-implementation-image-executable-p (generic function)
• lisp-implementation-image-executable-p (method)
• lisp-implementation-image-flag (generic function)
• lisp-implementation-image-flag (method)
• lisp-implementation-implementation-type (generic function)
• lisp-implementation-implementation-type (method)
• lisp-implementation-invocation-arglist (generic function)
• lisp-implementation-invocation-arglist (method)
• lisp-implementation-invoker (generic function)
• lisp-implementation-invoker (method)
• lisp-implementation-load-flag (generic function)
• lisp-implementation-load-flag (method)
• lisp-implementation-name (generic function)
• lisp-implementation-name (method)
• lisp-implementation-standalone-executable (generic function)
• lisp-implementation-standalone-executable (method)
• lisp-invocation-arglist (function)
• quit-form (function)
• register-lisp-implementation (function)
• register-lisp-implementation* (function)
• save-image-form (function)
• simple-lisp-implementation (class)

Internal Definitions

• *lisp-implementations* (special variable)
• lisp-implementation-default-image (generic function)
• lisp-implementation-default-image (method)
• lisp-implementation-dump-format (generic function)
• lisp-implementation-dump-format (method)
• lisp-implementation-identifiers (generic function)
• lisp-implementation-identifiers (method)
• lisp-implementation-quit-format (generic function)
• lisp-implementation-quit-format (method)
• lisp-invoker (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: define-lisp-implementation KEY (&optional CLASS) &rest KEYS

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

5.1.2 Functions

Function: ensure-path-executable X

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

Function: get-lisp-implementation &optional IMPLEMENTATION-TYPE

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

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 (file)

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 (file)

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 (file)

Function: lisp-environment-variable-name &key TYPE PREFIX SUFFIX

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

Function: lisp-invocation-arglist &rest KEYS &key IMPLEMENTATION-TYPE &allow-other-keys

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

5.1.3 Generic functions

Generic Function: lisp-implementation-argument-control OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-argument-control (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-arguments-end OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-arguments-end (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-directory-variable OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-directory-variable (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-disable-debugger OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-disable-debugger (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-environment-variable OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-environment-variable (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-eval-flag OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-eval-flag (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-feature OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-feature (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-flags OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-flags (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-fullname OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-fullname (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-image-executable-p OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-image-executable-p (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-image-flag OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-image-flag (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

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 (file)

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 (file)

Generic Function: lisp-implementation-invoker OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-invoker (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-load-flag OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-load-flag (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-name OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-name (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-standalone-executable OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-standalone-executable (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

5.1.4 Classes

Class: lisp-implementation ()

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

simple-lisp-implementation (class)

Direct methods

• lisp-implementation-implementation-type (method)
• lisp-implementation-identifiers (method)

Direct slots

Slot: identifiers

Initargs

:identifiers

Readers

lisp-implementation-identifiers (generic function)

Class: simple-lisp-implementation ()

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

Direct superclasses

lisp-implementation (class)

Direct methods

• lisp-implementation-invocation-arglist (method)
• lisp-implementation-dump-format (method)
• lisp-implementation-quit-format (method)
• lisp-implementation-invoker (method)
• lisp-implementation-directory-variable (method)
• lisp-implementation-disable-debugger (method)
• lisp-implementation-argument-control (method)
• lisp-implementation-standalone-executable (method)
• lisp-implementation-default-image (method)
• lisp-implementation-image-executable-p (method)
• lisp-implementation-image-flag (method)
• lisp-implementation-arguments-end (method)
• lisp-implementation-load-flag (method)
• lisp-implementation-eval-flag (method)
• lisp-implementation-flags (method)
• lisp-implementation-environment-variable (method)
• lisp-implementation-feature (method)
• lisp-implementation-name (method)
• lisp-implementation-fullname (method)

Direct slots

Slot: fullname

Initargs

:fullname

Readers

lisp-implementation-fullname (generic function)

Slot: name

Initargs

:name

Readers

lisp-implementation-name (generic function)

Slot: feature

Initargs

:feature

Readers

lisp-implementation-feature (generic function)

Slot: environment-variable

Initargs

:environment-variable

Readers

lisp-implementation-environment-variable (generic function)

Slot: flags

Initargs

:flags

Readers

lisp-implementation-flags (generic function)

Slot: eval-flag

Initargs

:eval-flag

Readers

lisp-implementation-eval-flag (generic function)

Slot: load-flag

Initargs

:load-flag

Readers

lisp-implementation-load-flag (generic function)

Slot: arguments-end

Initargs

:arguments-end

Readers

lisp-implementation-arguments-end (generic function)

Slot: image-flag

Initargs

:image-flag

Readers

lisp-implementation-image-flag (generic function)

Slot: image-executable-p

Initargs

:image-executable-p

Readers

lisp-implementation-image-executable-p (generic function)

Slot: default-image

Initargs

:default-image

Readers

lisp-implementation-default-image (generic function)

Slot: standalone-executable

Initargs

:standalone-executable

Readers

lisp-implementation-standalone-executable (generic function)

Slot: argument-control

Initargs

:argument-control

Readers

lisp-implementation-argument-control (generic function)

Slot: disable-debugger

Initargs

:disable-debugger

Readers

lisp-implementation-disable-debugger (generic function)

Slot: directory-variable

Initargs

:directory-variable

Readers

lisp-implementation-directory-variable (generic function)

Slot: invoker

Initargs

:invoker

Readers

lisp-implementation-invoker (generic function)

Slot: quit-format

Initargs

:quit-format

Readers

lisp-implementation-quit-format (generic function)

Slot: dump-format

Initargs

:dump-format

Readers

lisp-implementation-dump-format (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *lisp-implementations*

Dictionary of known Lisp implementations

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

5.2.2 Functions

Function: lisp-invoker &optional IMPLEMENTATION-TYPE

Package

lisp-invocation/lisp-invocation

Source

file-type.lisp (file)

5.2.3 Generic functions

Generic Function: lisp-implementation-default-image OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-default-image (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-dump-format OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-dump-format (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-identifiers OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-identifiers (LISP-IMPLEMENTATION lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: lisp-implementation-quit-format OBJECT

Package

lisp-invocation/lisp-invocation

Methods

Method: lisp-implementation-quit-format (SIMPLE-LISP-IMPLEMENTATION simple-lisp-implementation)

automatically generated reader method

Source

file-type.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types