3.1.1 external-program/external-program.asd

Source

external-program.asd.

Parent Component

external-program (system).

ASDF Systems

external-program.

Packages

external-program-system.

3.1.2 external-program/external-program.lisp

Source

external-program.asd.

Parent Component

external-program (system).

Packages

external-program.

Public Interface

• process-error-stream (generic function).
• process-id (generic function).
• process-input-stream (generic function).
• process-output-stream (generic function).
• process-p (generic function).
• process-status (generic function).
• run (generic function).
• signal-process (generic function).
• start (generic function).

Internals

*signal-mapping* (special variable).

3.1.3 external-program/utilities.lisp

Dependency

external-program.lisp (file).

Source

external-program.asd.

Parent Component

external-program (system).

Internals

• embed-environment (function).
• make-shell-string (function).
• reformat-environment (function).
• rename-parameter (function).
• stringify-args (function).

3.1.4 external-program/sbcl.lisp

Dependency

utilities.lisp (file).

Source

external-program.asd.

Parent Component

external-program (system).

Public Interface

• process-error-stream (method).
• process-id (method).
• process-input-stream (method).
• process-output-stream (method).
• process-p (method).
• process-status (method).
• run (method).
• signal-process (method).
• signal-process (method).
• start (method).

Internals

convert-environment (function).

5.1.1 Generic functions

Generic Function: process-error-stream (process) ¶

Returns the stream created when the error argument to ‘START‘ is specified as ‘:STREAM‘.

Package

external-program.

Source

external-program.lisp.

Methods

Method: process-error-stream (process) ¶

Source

sbcl.lisp.

Generic Function: process-id (process) ¶

Returns the process id assigned to the external
process by the operating system. This is typically a positive, 16-bit number.

Package

external-program.

Source

external-program.lisp.

Methods

Method: process-id (process) ¶

Source

sbcl.lisp.

Generic Function: process-input-stream (process) ¶

Returns the stream created when the input argument to ‘START‘ is specified as ‘:STREAM‘.

Package

external-program.

Source

external-program.lisp.

Methods

Method: process-input-stream (process) ¶

Source

sbcl.lisp.

Generic Function: process-output-stream (process) ¶

Returns the stream created when the output argument to ‘START‘ is specified as ‘:STREAM‘.

Package

external-program.

Source

external-program.lisp.

Methods

Method: process-output-stream (process) ¶

Source

sbcl.lisp.

Generic Function: process-p (process) ¶

‘T‘ if object is a process, ‘NIL‘ otherwise.

Package

external-program.

Source

external-program.lisp.

Methods

Method: process-p (process) ¶

Source

sbcl.lisp.

Generic Function: process-status (process) ¶

Returns, as multiple values, a keyword denoting the
status of the external process (one of ‘:RUNNING‘, ‘:STOPPED‘, ‘:SIGNALED‘, or ‘:EXITED‘), and the exit code or terminating signal if the first value is other than ‘:RUNNING‘.

Package

external-program.

Source

external-program.lisp.

Methods

Method: process-status (process) ¶

Source

sbcl.lisp.

Generic Function: run (program args &key input if-input-does-not-exist output if-output-exists error if-error-exists environment replace-environment-p &allow-other-keys) ¶

Runs the specified program similarly to ‘START‘,
however it blocks and returns the external process status once the
program exits.

‘:STREAM‘ is not a valid argument to ‘INPUT‘, ‘OUTPUT‘, or ‘ERROR‘ for this function.

Package

external-program.

Source

external-program.lisp.

Methods

Method: run (program args &rest rest &key environment replace-environment-p &allow-other-keys) ¶

Source

sbcl.lisp.

Method: run ((program pathname) args &rest rest) ¶

Generic Function: signal-process (process signal) ¶

Sends the specified unix signal to the specified
external process. Signals an error if unsuccessful. The signal may be either an integer, or one of the keywords in ‘EXTERNAL-PROGRAM::*SIGNAL-MAPPING*‘.

Package

external-program.

Source

external-program.lisp.

Methods

Method: signal-process (process (signal integer)) ¶

Source

sbcl.lisp.

Method: signal-process (process (signal symbol)) ¶

Source

sbcl.lisp.

Method: signal-process (process signal) ¶

Generic Function: start (program args &key input if-input-does-not-exist output if-output-exists error if-error-exists environment replace-environment-p status-hook &allow-other-keys) ¶

Runs the specified program in an external (Unix) process,
returning a process object if successful.

‘INPUT‘, ‘OUTPUT‘, and ‘ERROR‘ all behave similarly, accepting one of
the following values:

* ‘NIL‘, specifying that a null stream (e.g., ‘/dev/null‘) should be used;
* ‘T‘, specifying that the ‘EXTERNAL-PROCESS‘ should use the source or destination with which the Lisp was invoked;
* a stream;
* a pathname designator, to redirect to/from a file;
* ‘:STREAM‘, which creates a new stream opened for character input or output (accessible via the ‘EXTERNAL-PROCESS-*-STREAM‘ functions);
or
* ‘:OUTPUT‘, (only available for ‘ERROR‘) which directs the error
output to the same destination as the standard output.

‘ENVIRONMENT‘ contains an alist mapping vars to values.

‘REPLACE-ENVIRONMENT-P‘ indicates whether the argument passed as ‘ENVIRONMENT‘ should replace or extend the current environment. The default is ‘NIL‘ (to extend the environment).

‘STATUS-HOOK‘ is a function the system calls whenever the status of
the process changes. The function takes the process as an argument.

Package

external-program.

Source

external-program.lisp.

Methods

Method: start (program args &rest rest &key environment replace-environment-p &allow-other-keys) ¶

Source

sbcl.lisp.

Method: start ((program pathname) args &rest rest) ¶

5.2.1 Special variables

Special Variable: *signal-mapping* ¶

Package

external-program.

Source

external-program.lisp.

5.2.2 Ordinary functions

Function: convert-environment (rest environment replace-environment-p) ¶

Package

external-program.

Source

sbcl.lisp.

Function: embed-environment (program args environment replace-environment-p) ¶

Package

external-program.

Source

utilities.lisp.

Function: make-shell-string (program args environment replace-environment-p) ¶

Package

external-program.

Source

utilities.lisp.

Function: reformat-environment (environment) ¶

SBCL accepts vars as either ("FOO=meh" ...) or ((:foo . "meh") ...), but not (("FOO" . "meh") ...), so we build up the first kind (since the second kind is potentially lossy).

Package

external-program.

Source

utilities.lisp.

Function: rename-parameter (from-name to-name rest) ¶

Package

external-program.

Source

utilities.lisp.

Function: stringify-args (args) ¶

Package

external-program.

Source

utilities.lisp.