This is the asdf-finalizers Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:36:45 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
asdf-finalizersEnforced calling of finalizers for Lisp code
Francois-Rene Rideau
asdf (system)., at least version "3.0"
pkgdcl.lisp (file).
finalizers.lisp (file).
asdf-support.lisp (file).
initialization.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
asdf-finalizers/asdf-finalizers.asdasdf-finalizers/pkgdcl.lispasdf-finalizers/finalizers.lispasdf-finalizers/asdf-support.lispasdf-finalizers/initialization.lispasdf-finalizers/asdf-finalizers.asdasdf-finalizers (system).
asdf-finalizers/finalizers.lisppkgdcl.lisp (file).
asdf-finalizers (system).
*warn-when-finalizers-off* (special variable).
assert-no-finalizer-left-behind (function).
call-with-finalizers (function).
eval-at-toplevel (function).
final-forms (macro).
finalizers-off (condition).
finalizers-off-error (condition).
finalizers-off-simple-error (condition).
finalizers-off-simple-warning (condition).
finalizers-off-warning (condition).
no-finalizer-left-behind-p (function).
register-final-form (function).
register-finalizer (function).
using-finalizers-p (function).
with-finalizers (macro).
*debug-finalizers* (special variable).
*finalizers* (special variable).
*finalizers-data* (special variable).
disable-finalizers (function).
expand-final-forms (function).
final-forms-internal (macro).
missing-final-forms (condition).
reset-finalizers (function).
asdf-finalizers/asdf-support.lispfinalizers.lisp (file).
asdf-finalizers (system).
check-finalizers-around-compile (function).
compile-check-finalizers (function).
asdf-finalizers/initialization.lisppkgdcl.lisp (file).
asdf-finalizers (system).
Packages are listed by definition order.
asdf-finalizersasdf/interface.
common-lisp.
*warn-when-finalizers-off* (special variable).
assert-no-finalizer-left-behind (function).
call-with-finalizers (function).
check-finalizers-around-compile (function).
compile-check-finalizers (function).
eval-at-toplevel (function).
final-forms (macro).
finalizers-off (condition).
finalizers-off-error (condition).
finalizers-off-simple-error (condition).
finalizers-off-simple-warning (condition).
finalizers-off-warning (condition).
no-finalizer-left-behind-p (function).
register-final-form (function).
register-finalizer (function).
using-finalizers-p (function).
with-finalizers (macro).
*debug-finalizers* (special variable).
*finalizers* (special variable).
*finalizers-data* (special variable).
disable-finalizers (function).
expand-final-forms (function).
final-forms-internal (macro).
missing-final-forms (condition).
reset-finalizers (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Flag to enable or disable the raising warnings
when finalizers are used outside of context.
Typically, you want that flag to be on while compiling your application, but
off when your application is done compiled and you’re at runtime.
This macro will expand into any final forms so far registered.
The forms will be expanded inside an
(EVAL-WHEN (:COMPILE-TOPLEVEL :LOAD-TOPLEVEL :EXECUTE) ...)
but you can override that with your own EVAL-WHEN.
You need to have finalizers enabled to use this macro (see WITH-FINALIZERS).
In a file that uses finalizers, you MUST include (FINAL-FORMS)
after the last finalizer was used and before the end of the file,
or the compilation will fail.
Typically, you will write (FINAL-FORMS) as the very last form in your file,
or if you didn’t use the asdf-finalizers package, you will instead write
(ASDF-FINALIZERS:FINAL-FORMS).
Evaluate BODY in a context where finalizers are enabled.
By default, don’t finalize, because we want to catch code
that fails to finalize in the same file that requires code finalization.
This macro is typically used by ASDF when you configure it as below.
For convenience, you may also use it to test code at the REPL;
you may then pass an argument FINALIZE with true value,
and WITH-FINALIZERS will evaluate finalization forms.
Assuming your system :depends-on (:asdf-finalizers),
you may use this function as your :around-compile function
for an ASDF system, module or file, as in
:around-compile "asdf-finalizers:check-finalizers-around-compile"
This will allow you to use finalizers within covered source files,
and will issue an error if you fail to evaluate (FINAL-FORMS)
after the last finalizer was used and before the end of the file.
Alternatively, you may use ASDF::FINALIZED-CL-SOURCE-FILE below.
You may also have your own custom :around-compile hooks
chain into CHECK-FINALIZERS-AROUND-COMPILE
to achieve the same effect and more.
This function, to be used within a macro, deftype, reader-macro, etc.,
will evaluate toplevel FORM now during the macroexpansion phase, but also
register it to be evaluated at the toplevel as part of the FINAL-FORMS,
so that assuming you use the FINAL-FORMS afterwards but before the end of current file,
so it is available to whoever load the associated FASL or CFASL.
If the FORM has already been registered, it is skipped.
Either now or when loading the (C?)FASL, the evaluation of FORM will be skipped
when ALREADY-DONE-P-FORM evaluates to a true value.
When finalizers are not enabled, warn with given warning and arguments or
with a default warning, unless ALREADY-DONE-P-FORM evaluated to a true value,
at which point we trust the user to somehow have done the right thing,
and a build from clean will hopefully catch him if he didn’t.
This function, to be used within a macro, reader-macro, deftype, etc., will register a constant piece of code to the evaluated at toplevel at the end of the current code fragment (e.g. file).
This function, to be used within a macro, reader-macro, deftype, etc.,
will register a THUNK to be called during finalization.
Dependencies may be enforced by thunk calling thunk dependencies.
Any form returned by the THUNK will be included in the finalized code
after the code from any previously registered thunk of constant code fragment,
and after the code from any registered dependency.
condition.
error.
finalizers-off.
finalizers-off-error.
simple-error.
finalizers-off-warning.
simple-warning.
finalizers-off.
warning.
Flag to enable debugging output for finalizers.
simple-warning.
| Jump to: | A C D E F M N R U W |
|---|
| Jump to: | A C D E F M N R U W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | A C F I M P S |
|---|
| Jump to: | A C F I M P S |
|---|