This is the deploy Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:21:32 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
deployTools to aid in the deployment of a fully standalone application.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/deploy.git)
zlib
2.0.0
cffi (system).
sha3 (system).
documentation-utils (system).
trivial-features (system).
package.lisp (file).
toolkit.lisp (file).
library.lisp (file).
hooks.lisp (file).
checksum.lisp (file).
deploy.lisp (file).
osx.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
deploy/deploy.asddeploy/package.lispdeploy/toolkit.lispdeploy/library.lispdeploy/hooks.lispdeploy/checksum.lispdeploy/deploy.lispdeploy/osx.lispdeploy/documentation.lispdeploy/toolkit.lisppackage.lisp (file).
deploy (system).
*data-location* (special variable).
*status-output* (special variable).
copy-directory-tree (function).
data-directory (function).
env-set-p (function).
redirect-output (function).
runtime-directory (function).
status (function).
directory-contents (function).
discover-subdirectories (function).
env-paths (function).
find-relative-path-to (function).
make-lib-pathname (function).
pathname-filename (function).
resolve-cffi-spec (function).
split (function).
system-applicable-p (function).
xml-escape (function).
deploy/library.lisptoolkit.lisp (file).
deploy (system).
*system-source-directories* (special variable).
close-library (method).
close-library (method).
define-library (macro).
ensure-library (function).
find-source-file (method).
find-source-file (method).
library (class).
library-dont-deploy-p (reader method).
(setf library-dont-deploy-p) (writer method).
library-dont-open-p (reader method).
(setf library-dont-open-p) (writer method).
library-name (method).
library-name (method).
library-open-p (method).
library-open-p (method).
library-path (reader method).
(setf library-path) (writer method).
library-sources (reader method).
(setf library-sources) (writer method).
library-system (reader method).
(setf library-system) (writer method).
list-libraries (function).
open-library (method).
open-library (method).
possible-directories (method).
possible-directories (method).
possible-pathnames (method).
possible-pathnames (method).
print-object (method).
shared-initialize (method).
elf-file-p (function).
ensure-shared-library-file (function).
follow-ld-script (function).
deploy/hooks.lisplibrary.lisp (file).
deploy (system).
define-hook (macro).
define-resource-directory (macro).
hook (function).
(setf hook) (function).
hook (class).
hook-function (reader method).
(setf hook-function) (writer method).
hook-name (reader method).
(setf hook-name) (writer method).
hook-priority (reader method).
(setf hook-priority) (writer method).
hook-type (reader method).
(setf hook-type) (writer method).
print-object (method).
remove-hook (function).
run-hooks (function).
*hooks* (special variable).
deploy/checksum.lisphooks.lisp (file).
deploy (system).
*source-checksum* (special variable).
source-checksum (function).
*build-time* (special variable).
checksum-component (function).
checksum-file (function).
checksum-systems (function).
deploy/deploy.lispchecksum.lisp (file).
deploy (system).
*compression-factor* (special variable).
deploy-op (class).
deployed-p (function).
discover-entry-point (method).
output-files (method).
perform (method).
perform (method).
quit (function).
*foreign-libraries-to-reload* (special variable).
call-entry-prepared (function).
query-for-library-path (function).
warmly-boot (function).
deploy/osx.lispdeploy.lisp (file).
deploy (system).
*info-plist-template* (special variable).
osx-app-deploy-op (class).
output-files (method).
parse-info-plist (function).
*info-plist-readtable* (special variable).
Packages are listed by definition order.
deployorg.shirakumo.deploy
common-lisp.
*compression-factor* (special variable).
*data-location* (special variable).
*info-plist-template* (special variable).
*source-checksum* (special variable).
*status-output* (special variable).
*system-source-directories* (special variable).
close-library (generic function).
copy-directory-tree (function).
data-directory (function).
define-hook (macro).
define-library (macro).
define-resource-directory (macro).
deploy-op (class).
deployed-p (function).
discover-entry-point (generic function).
ensure-library (function).
env-set-p (function).
find-source-file (generic function).
hook (function).
(setf hook) (function).
hook (class).
hook-function (generic reader).
(setf hook-function) (generic writer).
hook-name (generic reader).
(setf hook-name) (generic writer).
hook-priority (generic reader).
(setf hook-priority) (generic writer).
hook-type (generic reader).
(setf hook-type) (generic writer).
library (class).
library-dont-deploy-p (generic reader).
(setf library-dont-deploy-p) (generic writer).
library-dont-open-p (generic reader).
(setf library-dont-open-p) (generic writer).
library-name (generic function).
library-open-p (generic function).
library-path (generic reader).
(setf library-path) (generic writer).
library-sources (generic reader).
(setf library-sources) (generic writer).
library-system (generic reader).
(setf library-system) (generic writer).
list-libraries (function).
open-library (generic function).
osx-app-deploy-op (class).
parse-info-plist (function).
possible-directories (generic function).
possible-pathnames (generic function).
quit (function).
redirect-output (function).
remove-hook (function).
run-hooks (function).
runtime-directory (function).
source-checksum (function).
status (function).
*build-time* (special variable).
*foreign-libraries-to-reload* (special variable).
*hooks* (special variable).
*info-plist-readtable* (special variable).
call-entry-prepared (function).
checksum-component (function).
checksum-file (function).
checksum-systems (function).
directory-contents (function).
discover-subdirectories (function).
elf-file-p (function).
ensure-shared-library-file (function).
env-paths (function).
find-relative-path-to (function).
follow-ld-script (function).
make-lib-pathname (function).
pathname-filename (function).
query-for-library-path (function).
resolve-cffi-spec (function).
split (function).
system-applicable-p (function).
warmly-boot (function).
xml-escape (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Relative path designating the location of the resource directory.
This path should be relative to the location of
the executable.
You may set this variable before deployment to
influence where resource files are stored.
See DATA-DIRECTORY
This variable holds a pathname pointing to the Info.plist template to use for OS X app bundles.
See PARSE-INFO-PLIST
The output stream of status messages.
You can set this to NIL if you want to suppress status
messages on the console, or set them to some other
stream that won’t bother the user.
See STATUS
This variable holds a list of paths to system library directories.
Deploy will search through these paths to attempt to
find the source of libraries if the more explicitly
provided paths should fail.
Define a new hook function.
The args list’s arguments are automatically turned into keyword arguments for the hook function. This allows you to only specify the arguments that you are interested in.
The following arguments are available for all hook types:
- SYSTEM The ASDF system object the application is built
with.
- OP The ASDF operation object used to build the
application.
The following hook types are recognised:
- :load These functions should perform the loading of
systems or other kinds of things that will
potentially change the set of libraries.
- :deploy These functions are responsible for copying
files into the deployment target directory.
It supplies the following extra arguments:
- DIRECTORY The target directory into which resource
files should be placed.
- :build These functions should prepare the system for
the dump to binary. Specifically you might
want to shut down existing threads, close file
handles, remove unneeded baggage, and remove
potentially sensitive information about your
system.
- :boot These functions are run right before the
primary entry point is executed. Thus they are
responsible for preparing the runtime to
continue by restarting threads, re-opening
files, and so forth.
It supplies the following extra arguments:
- DIRECTORY The directory in which the resource files
now reside after boot.
- :quit These functions are run right before the
executable exits completely. They offer a
last-minute opportunity to dump some
information about the system, or to clean up
vital resources.
See HOOK
See REMOVE-HOOK
Define additional properties for a foreign library.
The NAME should be one of a valid CFFI foreign library as defined by CFFI:DEFINE-FOREIGN-LIBRARY.
Valid properties are:
- :SYSTEM
- :SOURCES
- :PATH
- :DONT-OPEN
- :DONT-DEPLOY
See LIBRARY
See LIBRARY-SYSTEM
See LIBRARY-SOURCES
See LIBRARY-PATH
See LIBRARY-DONT-OPEN-P
See LIBRARY-DONT-DEPLOY-P
Shorthand to define a hook that simply deploys the given directory.
The directory has to be a form that evaluates to a
pathname to a directory that should be copied. The
path is merged with the system source directory of
the system being deployed. This means that relative
paths are relative to the source root of your system.
See DEFINE-HOOK
See COPY-DIRECTORY-TREE
Copy the source directory to the target directory.
If COPY-ROOT is true, the source folder itself is
copied, otherwise only its contents are copied.
EXCLUDE may be a function of one argument, a source path, which
returns a boolean designating whether the source file should be
excluded or not.
IF-EXISTS may be one of the following values, governing what to do if
the destination file exists already:
:REPLACE :SUPERSEDE :OVERWRITE
— Replaces the file regardless
NIL :IGNORE
— Does nothing
:ERROR
— Signals an error
:UPDATE
— Replaces the file if its write date is older than the source
file’s
Return an absolute path to the resource directory.
See DATA-DIRECTORY
Returns T if the current Lisp environment has been booted from a deployed executable.
Return the corresponding LIBRARY instance, if possible.
The following happens for the following type of
the argument:
- LIBRARY The argument is returned.
- CFFI:FOREIGN-LIBRARY The object is CHANGE-CLASSd
into a LIBRARY instance.
- SYMBOL The library instance is
retrieved by name and then
passed back in.
See CFFI::GET-FOREIGN-LIBRARY
See LIBRARY
Returns the value of the given environment variable if it is set to a non-empty value.
Accessor to the hook instance of the given type and name.
See *HOOKS*
See HOOK
See REMOVE-HOOK
Return a fresh list of known foreign libraries.
All the returned libraries will be of type LIBRARY.
See LIBRARY
See CFFI:LIST-FOREIGN-LIBRARIES
See ENSURE-LIBRARY
Parses the Info.plist file and replaces values as appropriate.
Specifically, anything enclosed in [] is taken as a
list of symbols designating functions to call with
the system object. The resulting values are then
turned into a string by PRINC-TO-STRING, and escaped
for usage by XML-ESCAPED before writing them to
the returned string in place of the []. Note that you
can enclose multiple symbols. The value of the first
function call that returns non-NIL is used as the
value to splice into the file.
This allows to conveniently fill an Info.plist
template with values from the ASDF system.
Have a look at the standard Info.plist file shipped
with Deploy for what’s possible.
See *INFO-PLIST-TEMPLATE*
Runs the quit hooks and terminates the application.
If an error occurs during the execution of a quit hook, it
is ignored.
See RUN-HOOKS
Redirect all output to the given file.
This changes *STANDARD-OUTPUT*, *ERROR-OUTPUT*,
*TRACE-OUTPUT*, and *DEBUG-IO*. For the latter,
only its output stream is changed.
The stream to the given target file is returned.
Remove the hook of the given type and name.
See *HOOKS*
See HOOK
Run the hooks of the given type, supplying the given arguments.
Refer to DEFINE-HOOKS for the recognised arguments for
each hook type.
This function simply iterates through *HOOKS*, checks the
HOOK-TYPE for compliance, establishes a REPORT-ERROR
restart, and then applies the HOOK-FUNCTION to the given
arguments.
The REPORT-ERROR restart simply prints out the error it
receives and is thus useful for ignoring errors that
might occur during the execution of a hook.
See *HOOKS*
See HOOK-FUNCTION
See DEFINE-HOOK
Returns a pathname to the directory where the executable is being run in.
See UIOP:ARGV0
Print a status message to *status-output*.
The level determines the granularity of the message.
Higher levels mean "more detailed".
See *STATUS-OUTPUT*
Close/unload the library.
See CFFI:CLOSE-FOREIGN-LIBRARY
Attempt to resolve the given ASDF system’s entry point to a function.
The entry point may be either a function or a class
designator. If a class, returned is a function that
simply instantiates the class.
See ASDF/SYSTEM:COMPONENT-ENTRY-POINT
Attempt to find the source file of the library on the system.
Uses the directories listed in POSSIBLE-DIRECTORIES
to look for the library source.
The directories are searched for pathnames that
match one of the POSSIBLE-PATHNAMES for the library.
See POSSIBLE-DIRECTORIES
See POSSIBLE-PATHNAMES
Accessor to the function of the hook.
This function is what is executed when RUN-HOOKS
is called.
See HOOK
See RUN-HOOKS
Accessor to the name of the hook.
The name should be a symbol.
See HOOK
Accessor to the priority of the hook.
The priority should be an integer.
The higher the priority, the earlier the hook is
executed.
See HOOK
Accessor to the type of the hook.
The type can be one of :LOAD :BUILD :DEPLOY :BOOT :QUIT.
See HOOK
Accessor to whether to deploy (copy) the library to the resources directory on build.
See LIBRARY
Accessor to whether the library should not be opened on boot.
See LIBRARY
Return the library’s name.
See CFFI:FOREIGN-LIBRARY-NAME
Returns whether the library is currently open.
See CFFI:FOREIGN-LIBRARY-LOADED-P
Accessor to the definite path to the library’s source file.
If this is NIL, the library could not be found.
See LIBRARY
Accessor to the list of additional paths to search for source files.
See LIBRARY
Accessor to the ASDF system associated with the library.
If there is a system associated with this library,
the system’s source tree is used to search for the
library’s source file.
See LIBRARY
Open/load the library.
See CFFI:LOAD-FOREIGN-LIBRARY
Return a list of possible directories to search for the library.
By default this list includes:
- The LIBRARY-SOURCES of the library.
- The directory tree of the LIBRARY-SYSTEM’s source.
- The CFFI:*FOREIGN-LIBRARY-DIRECTORIES*
- The *SYSTEM-SOURCE-DIRECTORIES*
- The paths from the following environment variables:
- PATH on Windows
- LD_LIBRARY_PATH on Linux
- DYLD_LIBRARY_PATH on Darwin
See LIBRARY-SOURCES
See LIBRARY-SYSTEM
See DISCOVER-SUBDIRECTORIES
See CFFI:*FOREIGN-LIBRARY-DIRECTORIES*
See *SYSTEM-SOURCE-DIRECTORIES*
See ENV-PATHS
Return a list of possible file pathnames that match the library.
By default this list includes:
- The CFFI:FOREIGN-LIBRARY-PATHNAME if present.
- Paths computed through the CFFI library’s spec.
- A generic path after the LIBRARY-NAME.
See CFFI:FOREIGN-LIBRARY-PATHNAME
See CFFI:DEFINE-FOREIGN-LIBRARY
See LIBRARY-NAME
See LIBRARY
See RESOLVE-CFFI-SPEC
osx-app-deploy-op) (c system)) ¶asdf/action.
An ASDF operation to perform a deployment.
When this operation is performed, the following steps
are taken:
1. The :LOAD hooks are run with the appropriate
arguments.
2. The output files are determined, which should be
a list of two paths, the first being the executable
to dump to, and the second being a directory where
all the resources should be stored.
3. The list of libraries to reload on boot is computed
by removing all libraries that are either marked as
dont-open, or aren’t yet opened from LIST-LIBRARIES.
4. The deployment directories are created.
5. The *DATA-LOCATION* path is adapted to be relative
to the binary file.
6. The :DEPLOY hooks are run with the appropriate
arguments.
7. The :BUILD hooks are run with the appropriate
arguments.
8. The image is dumped to an executable format, using
core compression if available, and using the
appropriate application type depending on the
presence of the operating system and the
:DEPLOY-CONSOLE feature flag.
See LIST-LIBRARIES
See *FOREIGN-LIBRARIES-TO-RELOAD*
See *DATA-LOCATION*
See FIND-RELATIVE-PATH-TO
See RUN-HOOKS
program-op.
This class encapsulates a hook.
Hooks are functions that are run during various
points of deployment and execution of the resulting
executable.
See HOOK-NAME
See HOOK-TYPE
See HOOK-FUNCTION
See HOOK-PRIORITY
See HOOK
See REMOVE-HOOK
See DEFINE-HOOK
See RUN-HOOKS
| Initarg | Value |
|---|---|
:name | (error name required.) |
:type | (error type required.) |
:function | (constantly nil) |
:priority | 0 |
:name
common-lisp.
:type
common-lisp.
:function
:priority
Class to represent a foreign library.
This is a subclass of CFFI:FOREIGN-LIBRARY with some
additional slots for information necessary for the
Deploy system.
Upon shared-initialize, if the LIBRARY-PATH is not
explicitly set, it is resolved through FIND-SOURCE-
FILE.
See LIBRARY-SYSTEM
See LIBRARY-SOURCES
See LIBRARY-PATH
See LIBRARY-DONT-OPEN-P
See LIBRARY-DONT-DEPLOY-P
See FIND-SOURCE-FILE
foreign-library.
close-library.
find-source-file.
(setf library-dont-deploy-p).
library-dont-deploy-p.
(setf library-dont-open-p).
library-dont-open-p.
library-name.
library-open-p.
(setf library-path).
library-path.
(setf library-sources).
library-sources.
(setf library-system).
library-system.
open-library.
possible-directories.
possible-pathnames.
print-object.
shared-initialize.
:system
:sources
:path
:dont-open
:dont-deploy
This deployment op generates an OS X app bundle.
See DEPLOY-OP
See PARSE-INFO-PLIST
See *INFO-PLIST-TEMPLATE*
This variable keeps a list of library instances to open on boot.
The variable is set during deployment and should not be modified unless you know what you’re doing.
This variable holds a list of all hook instances.
The list should be sorted by priority of the hooks
in descending order.
See HOOK
See RUN-HOOKS
Custom readtable used to parse parts of the info plist.
Sets up a basic environment to run the entry point in.
In particular, it sets up an EXIT restart to allow you to quit the application, adds an error handler to handle the top-level errors, potentially redirects all output streams, executes the warm boot, and finally calls the entry point.
If an error should occur during boot or during the
execution of the entry point, a debugger is only invoked
if the environment variable DEPLOY_DEBUG_BOOT is set to a
non-empty value. Otherwise an error will lead to an exit
restart invocation.
If the environment variable DEPLOY_REDIRECT_OUTPUT is set
to a non-empty value, REDIRECT-OUTPUT is called with its
value.
See WARMLY-BOOT
See REDIRECT-OUTPUT
Returns all files and subdirectories within the given pathname’s directory.
Return a list of all directories contained in the path.
This includes the path itself.
Some linux distributions keep ld scripts in the lib directories as links, follow them if necessary
Returns the paths contained in the given environment variable.
For Windows systems, the split character is ;
otherwise it is :
See SPLIT
See UIOP:GETENV
Attempt to find a way to "get to" the target directory.
This tries to construct a relative path from the source to the target pathname, using :UP transforms in the pathname. If no relative path can be found, an error is signalled.
Create a pathname with the proper type for a library.
The type is OS-dependent.
Linux: "so"
Darwin: "dylib"
Windows: "dll"
Return the full file name of the pathname as a string.
Resolve the CFFI foreign library spec to a list of usable pathnames.
This is the spec as used in CFFI:DEFINE-FOREIGN-
LIBRARY.
See CFFI:DEFINE-FOREIGN-LIBRARY
Split the string on each split character.
Empty subsequences are not included.
Returns T if the system-spec is applicable for the current system.
If system-spec is T, this returns T. Otherwise T is
returned if the system-spec is in *FEATURES*.
Perform a warm boot.
This updates the CFFI:*FOREIGN-LIBRARY-DIRECTORIES* variable
to a sensible value which should hopefully ensure that your
designated libraries are reloaded on boot.
This will also run all :BOOT hooks with the appropriate
arguments supplied.
See CFFI:*FOREIGN-LIBRARY-DIRECTORIES*
See RUN-HOOKS
Escape the string for XML.
The following replacements are made:
"<" => "<"
">" => ">"
"&" => "&
| Jump to: | (
C D E F G H L M O P Q R S W X |
|---|
| Jump to: | (
C D E F G H L M O P Q R S W X |
|---|
| Jump to: | *
D F N P S T |
|---|
| Jump to: | *
D F N P S T |
|---|
| Jump to: | C D F H L O P S T |
|---|
| Jump to: | C D F H L O P S T |
|---|