The cl-sandbox Reference Manual

This is the cl-sandbox Reference Manual, version 0.0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:38:36 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-sandbox

Utility package for creating safe experimental environment.

Author

Mateusz Malisz <>

License

MIT

Version

0.0.4

Source

cl-sandbox.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-sandbox/src

Source

cl-sandbox.asd.

Parent Component

cl-sandbox (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-sandbox/cl-sandbox.asd

Source

cl-sandbox.asd.

Parent Component

cl-sandbox (system).

ASDF Systems

cl-sandbox.


4.1.2 cl-sandbox/src/package.lisp

Source

cl-sandbox.asd.

Parent Component

src (module).

Packages

sandbox.


4.1.3 cl-sandbox/src/sandbox.lisp

Source

cl-sandbox.asd.

Parent Component

src (module).

Public Interface
Internals

%change-name (function).


5 Packages

Packages are listed by definition order.


5.1 sandbox

Source

package.lisp.

Nickname

cl-sandbox

Use List

common-lisp.

Public Interface
Internals

%change-name (function).


6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: exit ()

Close sandbox session, returning to the previous package and deleting the sandbox package..

Package

sandbox.

Source

sandbox.lisp.

Function: pause ()

Pause sandbox session, leaving pacakge for future use.

Package

sandbox.

Source

sandbox.lisp.

Function: resume ()

Resume paused sandbox session.

Package

sandbox.

Source

sandbox.lisp.

Function: start (&key import-used-packages import-internal-symbols)

Start Sandbox session. The Sandbox package will use all packages from the origin package and this package. If you do not wish for this to happen, either provide NIL as an argument to import-used-packages
to not import anything except symbols from origin package,
or provide your list of packages to import-used-packages;
any packages you specify there will be used.
By default, only exported symbols are imported.
To import internal symbols from orign package,
provide T to import-internal-symbols

Package

sandbox.

Source

sandbox.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: %change-name (new-name)

Change name of sandbox package to NEW-NAME.

Package

sandbox.

Source

sandbox.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables