The cl-launch Reference Manual

This is the cl-launch Reference Manual, version 4.1.4.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:10:26 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 cl-launch

Runtime for cl-launch

Author

Francois-Rene Rideau

License

MIT

Version

4.1.4.1

Dependency

asdf (system)., at least version "3.1.2"

Source

cl-launch.asd.

Child Component

launcher.lisp (file).


2 Files

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


2.1 Lisp


2.1.1 cl-launch/cl-launch.asd

Source

cl-launch.asd.

Parent Component

cl-launch (system).

ASDF Systems

cl-launch.


2.1.2 cl-launch/launcher.lisp

Source

cl-launch.asd.

Parent Component

cl-launch (system).

Packages

cl-launch.

Public Interface
Internals

3 Packages

Packages are listed by definition order.


3.1 cl-launch

Source

launcher.lisp.

Use List
  • asdf/interface.
  • common-lisp.
  • uiop/driver.
Public Interface

compile-and-load-file (function).

Internals

4 Definitions

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


4.1 Public Interface


4.1.1 Ordinary functions

Function: compile-and-load-file (source &key force-recompile verbose load output-file)

compiles and load specified SOURCE file, if either required by keyword argument FORCE-RECOMPILE, or not yet existing, or not up-to-date. Keyword argument VERBOSE specifies whether to be verbose.
Returns two values: the fasl path, and T if the file was (re)compiled

Package

cl-launch.

Source

launcher.lisp.


4.1.2 Standalone methods

Method: component-pathname ((c cl-source-code))
Package

asdf/component.

Source

launcher.lisp.

Method: perform ((o load-op) (c cl-source-code))
Package

asdf/action.

Source

launcher.lisp.

Method: perform ((o compile-op) (c cl-source-code))
Package

asdf/action.

Source

launcher.lisp.

Method: perform :around ((o compile-op) (c cl-source-file-in-package))
Package

asdf/action.

Source

launcher.lisp.


4.2 Internals


4.2.1 Special variables

Special Variable: *cl-launch-file*
Package

cl-launch.

Source

launcher.lisp.

Special Variable: *cl-launch-header*
Package

cl-launch.

Source

launcher.lisp.

Special Variable: *dependency-counter*
Package

cl-launch.

Source

launcher.lisp.

Special Variable: *temporary-file-prefix*
Package

cl-launch.

Source

launcher.lisp.

Special Variable: *temporary-filenames*
Package

cl-launch.

Source

launcher.lisp.

Special Variable: *verbose*
Package

cl-launch.

Source

launcher.lisp.


4.2.2 Ordinary functions

Function: build-program (dump build restart final init quit)
Package

cl-launch.

Source

launcher.lisp.

Function: cl-launch-files ()
Package

cl-launch.

Source

launcher.lisp.

Function: cleanup-temporary-files ()
Package

cl-launch.

Source

launcher.lisp.

Function: compute-arguments ()
Package

cl-launch.

Source

launcher.lisp.

Function: dump-sexp-to-file (x n)
Package

cl-launch.

Source

launcher.lisp.

Function: dump-stream-to-file (i n)
Package

cl-launch.

Source

launcher.lisp.

Function: ensure-lisp-file (x &optional name)
Package

cl-launch.

Source

launcher.lisp.

Function: ensure-lisp-file-name (x &optional name)
Package

cl-launch.

Source

launcher.lisp.

Function: ensure-lisp-loadable (x)
Package

cl-launch.

Source

launcher.lisp.

Function: file-newer-p (new-file old-file)

Returns true if NEW-FILE is strictly newer than OLD-FILE.

Package

cl-launch.

Source

launcher.lisp.

Function: load-file (source &key output-file)
Package

cl-launch.

Source

launcher.lisp.

Function: load-quicklisp ()
Package

cl-launch.

Source

launcher.lisp.

Function: load-sys (system)
Package

cl-launch.

Source

launcher.lisp.

Function: make-dependency (dump fun arg pkg previous)
Package

cl-launch.

Source

launcher.lisp.

Function: make-dependency-system (rdeps options)
Package

cl-launch.

Source

launcher.lisp.

Function: make-temporary-filename (x)
Package

cl-launch.

Source

launcher.lisp.

Function: make-temporary-system (stem rdeps options)
Package

cl-launch.

Source

launcher.lisp.

Function: register-temporary-filename (n)
Package

cl-launch.

Source

launcher.lisp.

Function: run (&key quicklisp source-registry build dump restart final init quit)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-file-from-code (i x)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-file-from-file (f x)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-file-from-foo (dumper arg x)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-file-from-sexp (i x)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-file-from-stream (i x)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-file-from-string (i x)
Package

cl-launch.

Source

launcher.lisp.

Function: temporary-filename (x)
Package

cl-launch.

Source

launcher.lisp.


4.2.3 Generic functions

Generic Reader: component-code (object)
Package

cl-launch.

Methods
Reader Method: component-code ((cl-source-code cl-source-code))

automatically generated reader method

Source

launcher.lisp.

Target Slot

code.

Generic Reader: component-package (object)
Package

cl-launch.

Methods
Reader Method: component-package ((cl-source-code cl-source-code))

automatically generated reader method

Source

launcher.lisp.

Target Slot

package.

Reader Method: component-package ((cl-source-file-in-package cl-source-file-in-package))

automatically generated reader method

Source

launcher.lisp.

Target Slot

package.


4.2.4 Classes

Class: cl-source-code
Package

asdf/interface.

Source

launcher.lisp.

Direct superclasses

source-file.

Direct methods
Direct slots
Slot: code
Package

cl-launch.

Initargs

:code

Readers

component-code.

Writers

This slot is read-only.

Slot: package
Package

common-lisp.

Initargs

:package

Readers

component-package.

Writers

This slot is read-only.

Class: cl-source-file-in-package
Package

asdf/interface.

Source

launcher.lisp.

Direct superclasses

cl-source-file.

Direct methods
Direct slots
Slot: package
Package

common-lisp.

Initargs

:package

Readers

component-package.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   B   C   D   E   F   G   L   M   P   R   T  
Index Entry  Section

B
build-program: Private ordinary functions

C
cl-launch-files: Private ordinary functions
cleanup-temporary-files: Private ordinary functions
compile-and-load-file: Public ordinary functions
component-code: Private generic functions
component-code: Private generic functions
component-package: Private generic functions
component-package: Private generic functions
component-package: Private generic functions
component-pathname: Public standalone methods
compute-arguments: Private ordinary functions

D
dump-sexp-to-file: Private ordinary functions
dump-stream-to-file: Private ordinary functions

E
ensure-lisp-file: Private ordinary functions
ensure-lisp-file-name: Private ordinary functions
ensure-lisp-loadable: Private ordinary functions

F
file-newer-p: Private ordinary functions
Function, build-program: Private ordinary functions
Function, cl-launch-files: Private ordinary functions
Function, cleanup-temporary-files: Private ordinary functions
Function, compile-and-load-file: Public ordinary functions
Function, compute-arguments: Private ordinary functions
Function, dump-sexp-to-file: Private ordinary functions
Function, dump-stream-to-file: Private ordinary functions
Function, ensure-lisp-file: Private ordinary functions
Function, ensure-lisp-file-name: Private ordinary functions
Function, ensure-lisp-loadable: Private ordinary functions
Function, file-newer-p: Private ordinary functions
Function, load-file: Private ordinary functions
Function, load-quicklisp: Private ordinary functions
Function, load-sys: Private ordinary functions
Function, make-dependency: Private ordinary functions
Function, make-dependency-system: Private ordinary functions
Function, make-temporary-filename: Private ordinary functions
Function, make-temporary-system: Private ordinary functions
Function, register-temporary-filename: Private ordinary functions
Function, run: Private ordinary functions
Function, temporary-file-from-code: Private ordinary functions
Function, temporary-file-from-file: Private ordinary functions
Function, temporary-file-from-foo: Private ordinary functions
Function, temporary-file-from-sexp: Private ordinary functions
Function, temporary-file-from-stream: Private ordinary functions
Function, temporary-file-from-string: Private ordinary functions
Function, temporary-filename: Private ordinary functions

G
Generic Function, component-code: Private generic functions
Generic Function, component-package: Private generic functions

L
load-file: Private ordinary functions
load-quicklisp: Private ordinary functions
load-sys: Private ordinary functions

M
make-dependency: Private ordinary functions
make-dependency-system: Private ordinary functions
make-temporary-filename: Private ordinary functions
make-temporary-system: Private ordinary functions
Method, component-code: Private generic functions
Method, component-package: Private generic functions
Method, component-package: Private generic functions
Method, component-pathname: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods

P
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods

R
register-temporary-filename: Private ordinary functions
run: Private ordinary functions

T
temporary-file-from-code: Private ordinary functions
temporary-file-from-file: Private ordinary functions
temporary-file-from-foo: Private ordinary functions
temporary-file-from-sexp: Private ordinary functions
temporary-file-from-stream: Private ordinary functions
temporary-file-from-string: Private ordinary functions
temporary-filename: Private ordinary functions