The cl-all Reference Manual

Table of Contents

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

The cl-all Reference Manual

This is the cl-all Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 13:06:21 2019 GMT+0.


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

1 Introduction

## About CL-ALL
This is a simple script to run a snippet in several lisp implementations. Requires at least SBCL.

## How To
You can either build a fixed SBCL binary with ``make``, or symlink ``cl-all.sh`` to ``cl-all``. Either way, once ``cl-all`` is in your path:

::
cl-all '(print :hi)'
cl-all sbcl ecl '(print "Oh man!")'
cl-all --print '"Oh man"'
cl-all --file "something.lisp"
echo ":stdin" | cl-all --print
::

You can also load this system into your SBCL session and use it from the comfort of the REPL:

:: common-lisp
(cl-all:eval-in-lisp :ecl "(print call-arguments-limit)")
::

## Example Output
::
$ cl-all --print call-arguments-limit
 --> ABCL:     50
 --> Allegro:  16384
 --> CCL:      65536

 --> CLisp:    4096

 --> CMUCL:    536870911
 --> ECL:      65536
 --> MKCL:     2305843009213693951
 --> SBCL:     4611686018427387903
::

## CLI Reference
::
cl-all (implementation | option | snippet)*

  implementation:
    The given implementation is run. If no implementations are
    explicitly specified, all known and available implementations
    are used. See -l for a list of available implementations.
  
  option:
    --print -p   Causes the last form's value to be printed.
    --file  -f   Uses the given file as input.
    --eval  -e   Evaluates the given expression.
    --no-rc -n   Do not run implementation init files.
    --lisps -l   Lists all known and available implementations and exit.
    --help  -h   Show this usage prompt and exit.
    --           All further arguments are used as tokens to be evaluated,
                 concatenated by spaces.
  
  snippet:
    A lisp snippet to be evaluated.
  
  If no snippet, file, or eval option is given, the standard input is
  used to read forms from. Forms are read until EOF is encountered (C-d).
::

## Known Implementations
- ABCL
- Allegro
- CCL
- Clasp
- Clisp
- CMUCL
- ECL
- MKCL
- SBCL


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

2 Systems

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


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

2.1 cl-all

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/halftone

License

Artistic

Description

A script to evaluate expressions in multiple lisp implementations.

Version

1.0.0

Dependency

required module sb-posix (for feature sbcl)

Source

cl-all.asd (file)

Component

cl-all.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-all.asd

Location

cl-all.asd

Systems

cl-all (system)


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

3.1.2 cl-all/cl-all.lisp

Parent

cl-all (system)

Location

cl-all.lisp

Packages

cl-all

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-all

Source

cl-all.lisp (file)

Use List

common-lisp

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 Functions

Function: available-lisp-implementations ()
Package

cl-all

Source

cl-all.lisp (file)

Function: lisp-implementations ()
Package

cl-all

Source

cl-all.lisp (file)

Function: toplevel &optional ARGS
Package

cl-all

Source

cl-all.lisp (file)


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

5.1.2 Generic functions

Generic Function: eval-in-lisp LISP INPUT WITH-RC
Package

cl-all

Source

cl-all.lisp (file)

Methods
Method: eval-in-lisp (LISP sbcl) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP mkcl) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP ecl) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP cmucl) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP clisp) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP clasp) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP ccl) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP allegro) (FILE pathname) WITH-RC
Method: eval-in-lisp (LISP abcl) (FILE pathname) WITH-RC
Method: eval-in-lisp LISP (STREAM stream) _
Method: eval-in-lisp LISP (STRING string) _
Method: eval-in-lisp (LISP (eql t)) _ __
Method: eval-in-lisp (IMPLS list) _ __
Method: eval-in-lisp LISP _ __
Method: eval-in-lisp (LISP implementation) _ __ around
Generic Function: executable OBJECT
Package

cl-all

Methods
Method: executable LISP
Source

cl-all.lisp (file)

Method: executable (IMPLEMENTATION implementation)

automatically generated reader method

Source

cl-all.lisp (file)

Generic Function: local-executable LISP
Package

cl-all

Methods
Method: local-executable LISP
Source

cl-all.lisp (file)

Method: local-executable (LISP implementation)
Source

cl-all.lisp (file)

Generic Function: name OBJECT
Package

cl-all

Methods
Method: name LISP
Source

cl-all.lisp (file)

Method: name (IMPLEMENTATION implementation)

automatically generated reader method

Source

cl-all.lisp (file)

Generic Function: run-lisp LISP &rest ARGS
Package

cl-all

Methods
Method: run-lisp LISP &rest ARGS
Source

cl-all.lisp (file)

Method: run-lisp (LISP implementation) &rest ARGS
Source

cl-all.lisp (file)


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

5.1.3 Classes

Class: abcl ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Class: allegro ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Direct slots
Slot: name
Initform

"allegro"

Slot: executable
Initform

(quote ("alisp" "allegro"))

Class: ccl ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Direct slots
Slot: executable
Initform

(quote ("ccl64" "lx86cl64" "ccl" "lx86cl"))

Class: clasp ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Direct slots
Slot: name
Initform

"clasp"

Class: clisp ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Direct slots
Slot: name
Initform

"clisp"

Class: cmucl ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Class: ecl ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Class: implementation ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: name
Readers

name (generic function)

Slot: executable
Readers

executable (generic function)

Slot: local-executable
Class: mkcl ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods
Class: sbcl ()
Package

cl-all

Source

cl-all.lisp (file)

Direct superclasses

implementation (class)

Direct methods

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *help-string*
Package

cl-all

Source

cl-all.lisp (file)


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

5.2.2 Macros

Macro: case* TEST ARG1 &body CASES
Package

cl-all

Source

cl-all.lisp (file)


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

5.2.3 Functions

Function: bytes= ARRAY &rest TEST
Package

cl-all

Source

cl-all.lisp (file)

Function: copy-stream-to-stream INPUT OUTPUT
Package

cl-all

Source

cl-all.lisp (file)

Function: create-input-file &key INPUT OUTPUT PRINT
Package

cl-all

Source

cl-all.lisp (file)

Function: executable-file-p PATH
Package

cl-all

Source

cl-all.lisp (file)

Function: executable-paths &optional PATHVAR
Package

cl-all

Source

cl-all.lisp (file)

Function: find-executable NAME &optional DIRECTORIES
Package

cl-all

Source

cl-all.lisp (file)

Function: run EXECUTABLE &rest ARGS
Package

cl-all

Source

cl-all.lisp (file)

Function: split SPLIT STRING
Package

cl-all

Source

cl-all.lisp (file)

Function: starts-with PREFIX STRING
Package

cl-all

Source

cl-all.lisp (file)

Function: temp-file ()
Package

cl-all

Source

cl-all.lisp (file)


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

5.2.4 Generic functions

Generic Function: ensure-lisp LISP
Package

cl-all

Methods
Method: ensure-lisp (LISP symbol)
Source

cl-all.lisp (file)

Method: ensure-lisp (LISP class)
Source

cl-all.lisp (file)

Method: ensure-lisp (LISP implementation)
Source

cl-all.lisp (file)

Generic Function: eval-wrapper LISP FILE
Package

cl-all

Source

cl-all.lisp (file)

Methods
Method: eval-wrapper LISP FILE
Generic Function: quit-form LISP CODE
Package

cl-all

Source

cl-all.lisp (file)

Methods
Method: quit-form (LISP sbcl) CODE
Method: quit-form (LISP mkcl) CODE
Method: quit-form (LISP ecl) CODE
Method: quit-form (LISP cmucl) CODE
Method: quit-form (LISP clisp) CODE
Method: quit-form (LISP clasp) CODE
Method: quit-form (LISP ccl) CODE
Method: quit-form (LISP allegro) CODE
Method: quit-form (LISP abcl) CODE

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-all.asd: The cl-all<dot>asd file
cl-all/cl-all.lisp: The cl-all/cl-all<dot>lisp file

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

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

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   B   C   E   F   G   L   M   N   Q   R   S   T  
Index Entry  Section

A
available-lisp-implementations: Exported functions

B
bytes=: Internal functions

C
case*: Internal macros
copy-stream-to-stream: Internal functions
create-input-file: Internal functions

E
ensure-lisp: Internal generic functions
ensure-lisp: Internal generic functions
ensure-lisp: Internal generic functions
ensure-lisp: Internal generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-in-lisp: Exported generic functions
eval-wrapper: Internal generic functions
eval-wrapper: Internal generic functions
executable: Exported generic functions
executable: Exported generic functions
executable: Exported generic functions
executable-file-p: Internal functions
executable-paths: Internal functions

F
find-executable: Internal functions
Function, available-lisp-implementations: Exported functions
Function, bytes=: Internal functions
Function, copy-stream-to-stream: Internal functions
Function, create-input-file: Internal functions
Function, executable-file-p: Internal functions
Function, executable-paths: Internal functions
Function, find-executable: Internal functions
Function, lisp-implementations: Exported functions
Function, run: Internal functions
Function, split: Internal functions
Function, starts-with: Internal functions
Function, temp-file: Internal functions
Function, toplevel: Exported functions

G
Generic Function, ensure-lisp: Internal generic functions
Generic Function, eval-in-lisp: Exported generic functions
Generic Function, eval-wrapper: Internal generic functions
Generic Function, executable: Exported generic functions
Generic Function, local-executable: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, quit-form: Internal generic functions
Generic Function, run-lisp: Exported generic functions

L
lisp-implementations: Exported functions
local-executable: Exported generic functions
local-executable: Exported generic functions
local-executable: Exported generic functions

M
Macro, case*: Internal macros
Method, ensure-lisp: Internal generic functions
Method, ensure-lisp: Internal generic functions
Method, ensure-lisp: Internal generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-in-lisp: Exported generic functions
Method, eval-wrapper: Internal generic functions
Method, executable: Exported generic functions
Method, executable: Exported generic functions
Method, local-executable: Exported generic functions
Method, local-executable: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, quit-form: Internal generic functions
Method, run-lisp: Exported generic functions
Method, run-lisp: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions

Q
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions
quit-form: Internal generic functions

R
run: Internal functions
run-lisp: Exported generic functions
run-lisp: Exported generic functions
run-lisp: Exported generic functions

S
split: Internal functions
starts-with: Internal functions

T
temp-file: Internal functions
toplevel: Exported functions

Jump to:   A   B   C   E   F   G   L   M   N   Q   R   S   T  

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

A.3 Variables

Jump to:   *  
E   L   N   S  
Index Entry  Section

*
*help-string*: Internal special variables

E
executable: Exported classes
executable: Exported classes
executable: Exported classes

L
local-executable: Exported classes

N
name: Exported classes
name: Exported classes
name: Exported classes
name: Exported classes

S
Slot, executable: Exported classes
Slot, executable: Exported classes
Slot, executable: Exported classes
Slot, local-executable: Exported classes
Slot, name: Exported classes
Slot, name: Exported classes
Slot, name: Exported classes
Slot, name: Exported classes
Special Variable, *help-string*: Internal special variables

Jump to:   *  
E   L   N   S  

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

A.4 Data types

Jump to:   A   C   E   I   M   P   S  
Index Entry  Section

A
abcl: Exported classes
allegro: Exported classes

C
ccl: Exported classes
cl-all: The cl-all system
cl-all: The cl-all package
clasp: Exported classes
Class, abcl: Exported classes
Class, allegro: Exported classes
Class, ccl: Exported classes
Class, clasp: Exported classes
Class, clisp: Exported classes
Class, cmucl: Exported classes
Class, ecl: Exported classes
Class, implementation: Exported classes
Class, mkcl: Exported classes
Class, sbcl: Exported classes
clisp: Exported classes
cmucl: Exported classes

E
ecl: Exported classes

I
implementation: Exported classes

M
mkcl: Exported classes

P
Package, cl-all: The cl-all package

S
sbcl: Exported classes
System, cl-all: The cl-all system

Jump to:   A   C   E   I   M   P   S