The cl-scripting Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-scripting Reference Manual

This is the cl-scripting Reference Manual, version 0.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:22:24 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-scripting, utilities for scripting in Common Lisp

cl-scripting is a collection of utilities for scripting in Common Lisp.

Don't write shell scripts, write Common Lisp scripts instead! See my article Common Lisp as a Scripting Language, 2015 edition.

For examples on how I use these utilities, see fare-scripts.

Contents:


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 cl-scripting

Author

Francois-Rene Rideau

License

MIT

Description

Utilities to help in writing scripts in CL

Version

0.2

Dependency

cl-scripting/cl-scripting (system)

Source

cl-scripting.asd (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.2 cl-scripting/cl-scripting

Dependencies
Source

cl-scripting.asd (file)

Component

lisp.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.3 cl-scripting/commands

Dependencies
Source

cl-scripting.asd (file)

Component

lisp.lisp (file)


Previous: , Up: Systems   [Contents][Index]

2.4 cl-scripting/failure

Dependency

fare-utils

Source

cl-scripting.asd (file)

Component

lisp.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-scripting.asd

Location

cl-scripting.asd

Systems

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-scripting/cl-scripting/lisp.lisp

Parent

cl-scripting/cl-scripting (system)

Location

cl-scripting.lisp

Packages

cl-scripting


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-scripting/commands/lisp.lisp

Parent

cl-scripting/commands (system)

Location

commands.lisp

Packages

cl-scripting/commands

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-scripting/failure/lisp.lisp

Parent

cl-scripting/failure (system)

Location

failure.lisp

Packages

cl-scripting/failure

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-scripting

Source

lisp.lisp (file)

Nickname

cl-scripting/cl-scripting

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 cl-scripting/commands

Source

lisp.lisp (file)

Use List
Used By List

cl-scripting

Exported Definitions

Previous: , Up: Packages   [Contents][Index]

4.3 cl-scripting/failure

Source

lisp.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: with-failure-context (&rest KEYS &key NAME MUFFLE-FAILURES) &body BODY
Package

cl-scripting/failure

Source

lisp.lisp (file)

Macro: without-stopping () &body BODY
Package

cl-scripting/failure

Source

lisp.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: call-without-stopping THUNKS
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: fail! &rest REASON-ARGUMENTS
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: failure &optional FAILURES

Return magic values that signal failure

Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: failure-failures VALUE-LIST
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: failure-if TEST &rest FAILURE-ARGS

If not TEST, return success, otherwise, return failure with FAILURE-ARGS

Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: failurep VALUE-LIST
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: register-command COMMAND
Package

cl-scripting/commands

Source

lisp.lisp (file)

Function: register-commands COMMANDS
Package

cl-scripting/commands

Source

lisp.lisp (file)

Function: run-command FUN &rest ARGS
Package

cl-scripting/commands

Source

lisp.lisp (file)

Function: success &rest VALUES
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: success-if TEST &rest FAILURE-ARGS

If TEST, return success, otherwise, return failure with FAILURE-ARGS

Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: success-values VALUE-LIST
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: successp VALUE-LIST
Package

cl-scripting/failure

Source

lisp.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *context*
Package

cl-scripting/failure

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: call-with-failure-context THUNK &key NAME MUFFLE-FAILURES
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: make-error &optional REASON &rest ARGUMENTS
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: make-failure &optional REASON &rest ARGUMENTS
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: make-failures &optional LIST
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: register-failures FAILURES
Package

cl-scripting/failure

Source

lisp.lisp (file)

Function: result-values &rest VALUES

If values represent success, pass them on.
If values represent failure, fail.
Otherwise, return values representing success with given values.

Package

cl-scripting/failure

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Generic functions

Generic Function: ancestor OBJECT
Package

cl-scripting/failure

Methods
Method: ancestor (CONTEXT context)

automatically generated reader method

Source

lisp.lisp (file)

Generic Function: failure-context CONDITION
Package

cl-scripting/failure

Methods
Method: failure-context (CONDITION execution-failure)
Source

lisp.lisp (file)

Generic Function: failure-list CONDITION
Package

cl-scripting/failure

Methods
Method: failure-list (CONDITION execution-failures)
Source

lisp.lisp (file)

Generic Function: failure-reason CONDITION
Package

cl-scripting/failure

Methods
Method: failure-reason (CONDITION execution-failure)
Source

lisp.lisp (file)

Generic Function: failures OBJECT
Generic Function: (setf failures) NEW-VALUE OBJECT
Package

cl-scripting/failure

Methods
Method: failures (CONTEXT context)

automatically generated reader method

Source

lisp.lisp (file)

Method: (setf failures) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

lisp.lisp (file)

Generic Function: muffle-failures OBJECT
Package

cl-scripting/failure

Methods
Method: muffle-failures (CONTEXT context)

automatically generated reader method

Source

lisp.lisp (file)

Generic Function: names OBJECT
Package

cl-scripting/failure

Methods
Method: names (CONTEXT context)

automatically generated reader method

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Conditions

Condition: execution-error ()
Package

cl-scripting/failure

Source

lisp.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

print-object (method)

Condition: execution-failure ()
Package

cl-scripting/failure

Source

lisp.lisp (file)

Direct superclasses

execution-error (condition)

Direct methods
Direct slots
Slot: context
Initargs

:context

Initform

(quote nil)

Readers

failure-context (generic function)

Slot: reason
Initargs

:reason

Readers

failure-reason (generic function)

Condition: execution-failures ()
Package

cl-scripting/failure

Source

lisp.lisp (file)

Direct superclasses

execution-error (condition)

Direct methods
Direct slots
Slot: failures
Initargs

:failures

Initform

(quote nil)

Readers

failure-list (generic function)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

Class: context ()
Package

cl-scripting/failure

Source

lisp.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: names
Type

list

Initargs

:names

Readers

names (generic function)

Slot: muffle-failures
Type

boolean

Initargs

:muffle-failures

Readers

muffle-failures (generic function)

Slot: ancestor
Type

(or cl-scripting/failure::context null)

Initargs

:ancestor

Readers

ancestor (generic function)

Slot: failures
Type

list

Readers

failures (generic function)

Writers

(setf failures) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-scripting.asd: The cl-scripting<dot>asd file
cl-scripting/cl-scripting/lisp.lisp: The cl-scripting/cl-scripting/lisp<dot>lisp file
cl-scripting/commands/lisp.lisp: The cl-scripting/commands/lisp<dot>lisp file
cl-scripting/failure/lisp.lisp: The cl-scripting/failure/lisp<dot>lisp file

F
File, Lisp, cl-scripting.asd: The cl-scripting<dot>asd file
File, Lisp, cl-scripting/cl-scripting/lisp.lisp: The cl-scripting/cl-scripting/lisp<dot>lisp file
File, Lisp, cl-scripting/commands/lisp.lisp: The cl-scripting/commands/lisp<dot>lisp file
File, Lisp, cl-scripting/failure/lisp.lisp: The cl-scripting/failure/lisp<dot>lisp file

L
Lisp File, cl-scripting.asd: The cl-scripting<dot>asd file
Lisp File, cl-scripting/cl-scripting/lisp.lisp: The cl-scripting/cl-scripting/lisp<dot>lisp file
Lisp File, cl-scripting/commands/lisp.lisp: The cl-scripting/commands/lisp<dot>lisp file
Lisp File, cl-scripting/failure/lisp.lisp: The cl-scripting/failure/lisp<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   F   G   M   N   R   S   W  
Index Entry  Section

(
(setf failures): Internal generic functions
(setf failures): Internal generic functions

A
ancestor: Internal generic functions
ancestor: Internal generic functions

C
call-with-failure-context: Internal functions
call-without-stopping: Exported functions

F
fail!: Exported functions
failure: Exported functions
failure-context: Internal generic functions
failure-context: Internal generic functions
failure-failures: Exported functions
failure-if: Exported functions
failure-list: Internal generic functions
failure-list: Internal generic functions
failure-reason: Internal generic functions
failure-reason: Internal generic functions
failurep: Exported functions
failures: Internal generic functions
failures: Internal generic functions
Function, call-with-failure-context: Internal functions
Function, call-without-stopping: Exported functions
Function, fail!: Exported functions
Function, failure: Exported functions
Function, failure-failures: Exported functions
Function, failure-if: Exported functions
Function, failurep: Exported functions
Function, make-error: Internal functions
Function, make-failure: Internal functions
Function, make-failures: Internal functions
Function, register-command: Exported functions
Function, register-commands: Exported functions
Function, register-failures: Internal functions
Function, result-values: Internal functions
Function, run-command: Exported functions
Function, success: Exported functions
Function, success-if: Exported functions
Function, success-values: Exported functions
Function, successp: Exported functions

G
Generic Function, (setf failures): Internal generic functions
Generic Function, ancestor: Internal generic functions
Generic Function, failure-context: Internal generic functions
Generic Function, failure-list: Internal generic functions
Generic Function, failure-reason: Internal generic functions
Generic Function, failures: Internal generic functions
Generic Function, muffle-failures: Internal generic functions
Generic Function, names: Internal generic functions

M
Macro, with-failure-context: Exported macros
Macro, without-stopping: Exported macros
make-error: Internal functions
make-failure: Internal functions
make-failures: Internal functions
Method, (setf failures): Internal generic functions
Method, ancestor: Internal generic functions
Method, failure-context: Internal generic functions
Method, failure-list: Internal generic functions
Method, failure-reason: Internal generic functions
Method, failures: Internal generic functions
Method, muffle-failures: Internal generic functions
Method, names: Internal generic functions
muffle-failures: Internal generic functions
muffle-failures: Internal generic functions

N
names: Internal generic functions
names: Internal generic functions

R
register-command: Exported functions
register-commands: Exported functions
register-failures: Internal functions
result-values: Internal functions
run-command: Exported functions

S
success: Exported functions
success-if: Exported functions
success-values: Exported functions
successp: Exported functions

W
with-failure-context: Exported macros
without-stopping: Exported macros

Jump to:   (  
A   C   F   G   M   N   R   S   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   C   F   M   N   R   S  
Index Entry  Section

*
*context*: Internal special variables

A
ancestor: Internal classes

C
context: Internal conditions

F
failures: Internal conditions
failures: Internal classes

M
muffle-failures: Internal classes

N
names: Internal classes

R
reason: Internal conditions

S
Slot, ancestor: Internal classes
Slot, context: Internal conditions
Slot, failures: Internal conditions
Slot, failures: Internal classes
Slot, muffle-failures: Internal classes
Slot, names: Internal classes
Slot, reason: Internal conditions
Special Variable, *context*: Internal special variables

Jump to:   *  
A   C   F   M   N   R   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   E   P   S  
Index Entry  Section

C
cl-scripting: The cl-scripting system
cl-scripting: The cl-scripting package
cl-scripting/cl-scripting: The cl-scripting/cl-scripting system
cl-scripting/commands: The cl-scripting/commands system
cl-scripting/commands: The cl-scripting/commands package
cl-scripting/failure: The cl-scripting/failure system
cl-scripting/failure: The cl-scripting/failure package
Class, context: Internal classes
Condition, execution-error: Internal conditions
Condition, execution-failure: Internal conditions
Condition, execution-failures: Internal conditions
context: Internal classes

E
execution-error: Internal conditions
execution-failure: Internal conditions
execution-failures: Internal conditions

P
Package, cl-scripting: The cl-scripting package
Package, cl-scripting/commands: The cl-scripting/commands package
Package, cl-scripting/failure: The cl-scripting/failure package

S
System, cl-scripting: The cl-scripting system
System, cl-scripting/cl-scripting: The cl-scripting/cl-scripting system
System, cl-scripting/commands: The cl-scripting/commands system
System, cl-scripting/failure: The cl-scripting/failure system

Jump to:   C   E   P   S