The cl-scripting Reference Manual

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 4.0 beta 2 "William Riker" on Mon Aug 15 04:01:06 2022 GMT+0.

Table of Contents


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:


2 Systems

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


2.1 cl-scripting

Utilities to help in writing scripts in CL

Author

Francois-Rene Rideau

License

MIT

Version

0.2

Dependency

cl-scripting/cl-scripting (system).

Source

cl-scripting.asd.


2.2 cl-scripting/cl-scripting

Author

Francois-Rene Rideau

License

MIT

Dependencies
Source

cl-scripting.asd.


2.3 cl-scripting/failure

Author

Francois-Rene Rideau

License

MIT

Dependency

fare-utils (system).

Source

cl-scripting.asd.


2.4 cl-scripting/commands

Author

Francois-Rene Rideau

License

MIT

Dependencies
Source

cl-scripting.asd.


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


3.1.1 cl-scripting/cl-scripting.asd

Source

cl-scripting.asd.

Parent Component

cl-scripting (system).

ASDF Systems

3.1.2 cl-scripting/cl-scripting/file-type.lisp

Source

cl-scripting.asd.

Parent Component

cl-scripting/cl-scripting (system).

Packages

cl-scripting.


3.1.3 cl-scripting/failure/file-type.lisp

Source

cl-scripting.asd.

Parent Component

cl-scripting/failure (system).

Packages

cl-scripting/failure.

Public Interface
Internals

3.1.4 cl-scripting/commands/file-type.lisp

Source

cl-scripting.asd.

Parent Component

cl-scripting/commands (system).

Packages

cl-scripting/commands.

Public Interface

4 Packages

Packages are listed by definition order.


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

4.1 cl-scripting/commands

Source

file-type.lisp.

Use List
Used By List

cl-scripting.

Public Interface

4.2 cl-scripting/failure

Source

file-type.lisp.

Use List
  • common-lisp.
  • fare-utils.
Used By List
Public Interface
Internals

4.3 cl-scripting

Source

file-type.lisp.

Nickname

cl-scripting/cl-scripting

Use List

5 Definitions

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


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

5.1 Public Interface


5.1.1 Macros

Macro: with-failure-context ((&rest keys &key name muffle-failures) &body body)
Package

cl-scripting/failure.

Source

file-type.lisp.

Macro: without-stopping (() &body body)
Package

cl-scripting/failure.

Source

file-type.lisp.


5.1.2 Ordinary functions

Function: call-without-stopping (thunks)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: fail! (&rest reason-arguments)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: failure (&optional failures)

Return magic values that signal failure

Package

cl-scripting/failure.

Source

file-type.lisp.

Function: failure-failures (value-list)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: failure-if (test &rest failure-args)

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

Package

cl-scripting/failure.

Source

file-type.lisp.

Function: failurep (value-list)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: register-command (command)
Package

cl-scripting/commands.

Source

file-type.lisp.

Function: register-commands (commands)
Package

cl-scripting/commands.

Source

file-type.lisp.

Function: run-command (fun &rest args)
Package

cl-scripting/commands.

Source

file-type.lisp.

Function: success (&rest values)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: success-if (test &rest failure-args)

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

Package

cl-scripting/failure.

Source

file-type.lisp.

Function: success-values (value-list)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: successp (value-list)
Package

cl-scripting/failure.

Source

file-type.lisp.


5.1.3 Standalone methods

Method: print-object ((failure execution-failure) stream)
Source

file-type.lisp.

Method: print-object ((failures execution-failures) stream)
Source

file-type.lisp.

Method: print-object ((failure execution-error) stream)
Source

file-type.lisp.


5.2 Internals


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

5.2.1 Special variables

Special Variable: *context*
Package

cl-scripting/failure.

Source

file-type.lisp.


5.2.2 Ordinary functions

Function: call-with-failure-context (thunk &key name muffle-failures)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: make-error (&optional reason &rest arguments)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: make-failure (&optional reason &rest arguments)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: make-failures (&optional list)
Package

cl-scripting/failure.

Source

file-type.lisp.

Function: register-failures (failures)
Package

cl-scripting/failure.

Source

file-type.lisp.

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

file-type.lisp.


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

5.2.3 Generic functions

Generic Reader: ancestor (object)
Package

cl-scripting/failure.

Methods
Reader Method: ancestor ((context context))

automatically generated reader method

Source

file-type.lisp.

Target Slot

ancestor.

Generic Reader: failure-context (condition)
Package

cl-scripting/failure.

Methods
Reader Method: failure-context ((condition execution-failure))
Source

file-type.lisp.

Target Slot

context.

Generic Reader: failure-list (condition)
Package

cl-scripting/failure.

Methods
Reader Method: failure-list ((condition execution-failures))
Source

file-type.lisp.

Target Slot

failures.

Generic Reader: failure-reason (condition)
Package

cl-scripting/failure.

Methods
Reader Method: failure-reason ((condition execution-failure))
Source

file-type.lisp.

Target Slot

reason.

Generic Reader: failures (object)
Package

cl-scripting/failure.

Methods
Reader Method: failures ((context context))

automatically generated reader method

Source

file-type.lisp.

Target Slot

failures.

Generic Writer: (setf failures) (object)
Package

cl-scripting/failure.

Methods
Writer Method: (setf failures) ((context context))

automatically generated writer method

Source

file-type.lisp.

Target Slot

failures.

Generic Reader: muffle-failures (object)
Package

cl-scripting/failure.

Methods
Reader Method: muffle-failures ((context context))

automatically generated reader method

Source

file-type.lisp.

Target Slot

muffle-failures.

Generic Reader: names (object)
Package

cl-scripting/failure.

Methods
Reader Method: names ((context context))

automatically generated reader method

Source

file-type.lisp.

Target Slot

names.


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

5.2.4 Conditions

Condition: execution-error
Package

cl-scripting/failure.

Source

file-type.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

print-object.

Condition: execution-failure
Package

cl-scripting/failure.

Source

file-type.lisp.

Direct superclasses

execution-error.

Direct methods
Direct slots
Slot: context
Initform

(quote nil)

Initargs

:context

Readers

failure-context.

Writers

This slot is read-only.

Slot: reason
Initargs

:reason

Readers

failure-reason.

Writers

This slot is read-only.

Condition: execution-failures
Package

cl-scripting/failure.

Source

file-type.lisp.

Direct superclasses

execution-error.

Direct methods
Direct slots
Slot: failures
Initform

(quote nil)

Initargs

:failures

Readers

failure-list.

Writers

This slot is read-only.


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

5.2.5 Classes

Class: context
Package

cl-scripting/failure.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: names
Type

list

Initargs

:names

Readers

names.

Writers

This slot is read-only.

Slot: muffle-failures
Type

boolean

Initargs

:muffle-failures

Readers

muffle-failures.

Writers

This slot is read-only.

Slot: ancestor
Type

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

Initargs

:ancestor

Readers

ancestor.

Writers

This slot is read-only.

Slot: failures
Type

list

Readers

failures.

Writers

(setf failures).


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

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

(
(setf failures): Private generic functions
(setf failures): Private generic functions

A
ancestor: Private generic functions
ancestor: Private generic functions

C
call-with-failure-context: Private ordinary functions
call-without-stopping: Public ordinary functions

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

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

M
Macro, with-failure-context: Public macros
Macro, without-stopping: Public macros
make-error: Private ordinary functions
make-failure: Private ordinary functions
make-failures: Private ordinary functions
Method, (setf failures): Private generic functions
Method, ancestor: Private generic functions
Method, failure-context: Private generic functions
Method, failure-list: Private generic functions
Method, failure-reason: Private generic functions
Method, failures: Private generic functions
Method, muffle-failures: Private generic functions
Method, names: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
muffle-failures: Private generic functions
muffle-failures: Private generic functions

N
names: Private generic functions
names: Private generic functions

P
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

R
register-command: Public ordinary functions
register-commands: Public ordinary functions
register-failures: Private ordinary functions
result-values: Private ordinary functions
run-command: Public ordinary functions

S
success: Public ordinary functions
success-if: Public ordinary functions
success-values: Public ordinary functions
successp: Public ordinary functions

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

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

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

A.4 Data types

Jump to:   C   E   F   P   S  
Index Entry  Section

C
cl-scripting: The cl-scripting system
cl-scripting: The cl-scripting package
cl-scripting.asd: The cl-scripting/cl-scripting․asd file
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: Private classes
Condition, execution-error: Private conditions
Condition, execution-failure: Private conditions
Condition, execution-failures: Private conditions
context: Private classes

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

F
File, cl-scripting.asd: The cl-scripting/cl-scripting․asd file
File, file-type.lisp: The cl-scripting/cl-scripting/file-type․lisp file
File, file-type.lisp: The cl-scripting/failure/file-type․lisp file
File, file-type.lisp: The cl-scripting/commands/file-type․lisp file
file-type.lisp: The cl-scripting/cl-scripting/file-type․lisp file
file-type.lisp: The cl-scripting/failure/file-type․lisp file
file-type.lisp: The cl-scripting/commands/file-type․lisp file

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   F   P   S