This is the asdf-dependency-grovel Reference Manual, version 1.108, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:36:39 2024 GMT+0.
asdf-dependency-grovel/asdf-dependency-grovel.asdasdf-dependency-grovel/package.lispasdf-dependency-grovel/variables.lispasdf-dependency-grovel/classes.lispasdf-dependency-grovel/asdf-classes.lispasdf-dependency-grovel/grovel.lispasdf-dependency-grovel/asdf-ops.lispThe main system appears first, followed by any subsystem dependency.
asdf-dependency-grovelAnalyse the dependencies in an ASDF system
Andreas Fuchs, Matthew Steele and Francois-Rene Rideau
ASDF-DEPENDENCY-GROVEL will analyse the actual dependencies in an ASDF system.
Based on an analysis with file granularity ,
it can output an optimized system definition,
based on which compilation can be parallelized.
Based on an analysis with form granularity,
it can output a summary from which you can untangle
the circularities in your build.
1.108
asdf (system).
package.lisp (file).
variables.lisp (file).
classes.lisp (file).
asdf-classes.lisp (file).
grovel.lisp (file).
asdf-ops.lisp (file).
handlers (module).
Modules are listed depth-first from the system components tree.
asdf-dependency-grovel/handlersgrovel.lisp (file).
asdf-dependency-grovel (system).
Files are sorted by type and then listed depth-first from the systems components trees.
asdf-dependency-grovel/asdf-dependency-grovel.asdasdf-dependency-grovel/package.lispasdf-dependency-grovel/variables.lispasdf-dependency-grovel/classes.lispasdf-dependency-grovel/asdf-classes.lispasdf-dependency-grovel/grovel.lispasdf-dependency-grovel/asdf-ops.lispasdf-dependency-grovel/asdf-dependency-grovel.asdasdf-dependency-grovel (system).
asdf-dependency-grovel/package.lispasdf-dependency-grovel (system).
asdf-dependency-grovel/variables.lisppackage.lisp (file).
asdf-dependency-grovel (system).
*check-internal-symbols-p* (special variable).
*constituent-table* (special variable).
*current-constituent* (special variable).
*debug-trace* (special variable).
*global-mutations* (special variable).
*grovel-dir-suffix* (special variable).
*macroexpansion-handlers* (special variable).
*old-macroexpand-hook* (special variable).
*preprocess-form-p* (special variable).
*previous-package* (special variable).
*previously-interned-symbols* (special variable).
*suspected-constants* (special variable).
*suspected-variables* (special variable).
*system-base-dir* (special variable).
asdf-dependency-grovel/classes.lisppackage.lisp (file).
variables.lisp (file).
asdf-dependency-grovel (system).
initialize-instance (method).
print-object (method).
asdf-component-constituent (class).
asdf-component-constituent-component (reader method).
build-merged-graph (function).
collect-slots (function).
constituent (class).
constituent-add-provision (function).
constituent-add-use (function).
constituent-children (reader method).
constituent-dependency-table (function).
constituent-descendant-p (function).
constituent-designator (generic function).
constituent-index (reader method).
constituent-parent (reader method).
constituent-provision-table (function).
constituent-provisions (reader method).
(setf constituent-provisions) (writer method).
constituent-summary (generic function).
constituent-uses (reader method).
(setf constituent-uses) (writer method).
cyclic-reachable-p (function).
dnode (class).
dnode-constituents (reader method).
dnode-parent (reader method).
dnodes-needed-by (reader method).
dnodes-that-depend-on (reader method).
do-hashset (macro).
do-until (macro).
fail-if-not-acyclic (function).
file-constituent (class).
file-constituent-path (reader method).
find-a-cycle-if-any (function).
form-constituent (class).
form-constituent-position (reader method).
form-constituent-summary (reader method).
get-file-constituents (function).
hashset-add (function).
hashset-contains-p (function).
hashset-count (function).
hashset-empty-p (function).
hashset-pop (function).
hashset-remove (function).
hashset-subset-p (function).
heap-count (function).
heap-empty-p (function).
heap-insert (function).
heap-pop (function).
loop-hashset (macro).
make-dnode (function).
make-hashset (function).
make-heap (function).
new-temp-constituent (function).
propagate-constituent-downward (function).
propagate-constituent-upward (function).
simple-print-object (function).
simple-print-object-mixin (class).
slots-to-print (generic function).
temp-constituent (class).
temp-constituent-label (reader method).
top-constituent (class).
topologically-stable-sort-graph (function).
try-to-merge-dnodes (function).
walk-constituents-postorder (macro).
walk-constituents-preorder (macro).
with-gensyms (macro).
asdf-dependency-grovel/asdf-classes.lisppackage.lisp (file).
asdf-dependency-grovel (system).
additional-initargs (reader method).
additional-initargs (method).
instrumented-cl-source-file (class).
instrumented-component (class).
instrumented-module (class).
additional-dependencies (reader method).
escaped-around-compile-hook (function).
output-file-type (reader method).
overridden-dependencies (reader method).
translated-name (reader method).
translated-pathname (reader method).
asdf-dependency-grovel/grovel.lisppackage.lisp (file).
variables.lisp (file).
classes.lisp (file).
asdf-classes.lisp (file).
asdf-dependency-grovel (system).
fine-grain-instrumented-load (function).
instrumented-compile-file (function).
instrumented-load (function).
print-big-ol-dependency-report (function).
reload (function).
signal-provider (function).
signal-user (function).
with-constituent-groveling (macro).
additional-dependencies* (function).
asdf-system-file-components (function).
call-with-constituent-groveling (function).
canonical-package-name (function).
check-for-transfers (function).
coerce-class-name (function).
constituent-dependency-forms (function).
do-walk-symbols (macro).
does-macroexpand (macro).
does-macroexpand-with-epilogue (macro).
does-macroexpand-with-prologue (macro).
does-not-macroexpand (function).
dwim-stringify-component-spec (function).
enclosing-file-constituent (generic function).
enough-component-spec (function).
groveling-macroexpand-hook (function).
handle-macroexpansion (function).
initially-grovel-dependencies (function).
instrument-defun-body (function).
instrumented-eval (function).
instrumented-sharp+ (function).
instrumented-sharp- (function).
instrumented-sharp-s (function).
instrumented-sharpdot (function).
instrumented-sharpquote (function).
make-instrumented-readtable (function).
map-over-instrumented-component-and-parents (function).
maybe-translated-component-class (function).
maybe-translated-component-name (function).
normalize-pathname-directory (function).
normalize-pathname-directory-component* (function).
normalized-component-name (function).
noticing-*feature*-changes (macro).
operate-on-asdf-component-constituent (function).
operate-on-constituent (function).
operate-on-file-constituent (function).
operate-on-file-level-constituent (function).
operate-on-form-constituent (function).
operating-on-asdf-component-constituent (macro).
operating-on-file-constituent (macro).
operating-on-form-constituent (macro).
output-component-file (function).
overridden-dependencies* (function).
preprocess-form (function).
print-constituent-dependency-report (function).
print-constituent-file-splitting-strategy (function).
replace-transfers (function).
signal-new-internal-symbols (function).
(setf signal-symbol-macroexpansion) (setf expander).
signal-symbol-macroexpansion (function).
signal-typespec (function).
strip-extension (function).
strip/ (function).
summarize-form (function).
symbol-macroify (macro).
transfer-constituent (function).
with-groveling-macroexpand-hook (macro).
with-groveling-readtable (macro).
wtf (function).
asdf-dependency-grovel/asdf-ops.lisppackage.lisp (file).
variables.lisp (file).
grovel.lisp (file).
asdf-dependency-grovel (system).
component-file (class).
dependency-op (class).
input-files (method).
operation-done-p (method).
output-files (method).
output-files (method).
perform (method).
perform (method).
perform (method).
perform (method).
read-component-file (function).
systems-in-configuration (function).
%comp-file-reader (function).
*default-component-class* (special variable).
call-with-dependency-tracking (function).
load-instrumented-systems (function).
prepare-dependency-op (class).
state-of (function).
(setf state-of) (function).
with-dependency-tracking (macro).
Packages are listed by definition order.
asdf-dependency-grovelasdf/interface.
common-lisp.
uiop/driver.
additional-initargs (generic function).
component-file (class).
dependency-op (class).
fine-grain-instrumented-load (function).
instrumented-cl-source-file (class).
instrumented-compile-file (function).
instrumented-component (class).
instrumented-load (function).
instrumented-module (class).
print-big-ol-dependency-report (function).
read-component-file (function).
reload (function).
signal-provider (function).
signal-user (function).
systems-in-configuration (function).
with-constituent-groveling (macro).
%comp-file-reader (function).
*check-internal-symbols-p* (special variable).
*constituent-table* (special variable).
*current-constituent* (special variable).
*debug-trace* (special variable).
*default-component-class* (special variable).
*global-mutations* (special variable).
*grovel-dir-suffix* (special variable).
*macroexpansion-handlers* (special variable).
*old-macroexpand-hook* (special variable).
*preprocess-form-p* (special variable).
*previous-package* (special variable).
*previously-interned-symbols* (special variable).
*suspected-constants* (special variable).
*suspected-variables* (special variable).
*system-base-dir* (special variable).
additional-dependencies (generic reader).
additional-dependencies* (function).
asdf-component-constituent (class).
asdf-component-constituent-component (generic reader).
asdf-system-file-components (function).
build-merged-graph (function).
call-with-constituent-groveling (function).
call-with-dependency-tracking (function).
canonical-package-name (function).
check-for-transfers (function).
coerce-class-name (function).
collect-slots (function).
constituent (class).
constituent-add-provision (function).
constituent-add-use (function).
constituent-children (generic reader).
constituent-dependency-forms (function).
constituent-dependency-table (function).
constituent-descendant-p (function).
constituent-designator (generic function).
constituent-index (generic reader).
constituent-parent (generic reader).
constituent-provision-table (function).
constituent-provisions (generic reader).
(setf constituent-provisions) (generic writer).
constituent-summary (generic function).
constituent-uses (generic reader).
(setf constituent-uses) (generic writer).
cyclic-reachable-p (function).
dnode (class).
dnode-constituents (generic reader).
dnode-parent (generic reader).
dnodes-needed-by (generic reader).
dnodes-that-depend-on (generic reader).
do-hashset (macro).
do-until (macro).
do-walk-symbols (macro).
does-macroexpand (macro).
does-macroexpand-with-epilogue (macro).
does-macroexpand-with-prologue (macro).
does-not-macroexpand (function).
dwim-stringify-component-spec (function).
enclosing-file-constituent (generic function).
enough-component-spec (function).
escaped-around-compile-hook (function).
fail-if-not-acyclic (function).
file-constituent (class).
file-constituent-path (generic reader).
find-a-cycle-if-any (function).
form-constituent (class).
form-constituent-position (generic reader).
form-constituent-summary (generic reader).
get-file-constituents (function).
groveling-macroexpand-hook (function).
handle-macroexpansion (function).
hashset-add (function).
hashset-contains-p (function).
hashset-count (function).
hashset-empty-p (function).
hashset-pop (function).
hashset-remove (function).
hashset-subset-p (function).
heap-count (function).
heap-empty-p (function).
heap-insert (function).
heap-pop (function).
initially-grovel-dependencies (function).
instrument-defun-body (function).
instrumented-eval (function).
instrumented-sharp+ (function).
instrumented-sharp- (function).
instrumented-sharp-s (function).
instrumented-sharpdot (function).
instrumented-sharpquote (function).
load-instrumented-systems (function).
loop-hashset (macro).
make-dnode (function).
make-hashset (function).
make-heap (function).
make-instrumented-readtable (function).
map-over-instrumented-component-and-parents (function).
maybe-translated-component-class (function).
maybe-translated-component-name (function).
new-temp-constituent (function).
normalize-pathname-directory (function).
normalize-pathname-directory-component* (function).
normalized-component-name (function).
noticing-*feature*-changes (macro).
operate-on-asdf-component-constituent (function).
operate-on-constituent (function).
operate-on-file-constituent (function).
operate-on-file-level-constituent (function).
operate-on-form-constituent (function).
operating-on-asdf-component-constituent (macro).
operating-on-file-constituent (macro).
operating-on-form-constituent (macro).
output-component-file (function).
output-file-type (generic reader).
overridden-dependencies (generic reader).
overridden-dependencies* (function).
prepare-dependency-op (class).
preprocess-form (function).
print-constituent-dependency-report (function).
print-constituent-file-splitting-strategy (function).
propagate-constituent-downward (function).
propagate-constituent-upward (function).
replace-transfers (function).
signal-new-internal-symbols (function).
(setf signal-symbol-macroexpansion) (setf expander).
signal-symbol-macroexpansion (function).
signal-typespec (function).
simple-print-object (function).
simple-print-object-mixin (class).
slots-to-print (generic function).
state-of (function).
(setf state-of) (function).
strip-extension (function).
strip/ (function).
summarize-form (function).
symbol-macroify (macro).
temp-constituent (class).
temp-constituent-label (generic reader).
top-constituent (class).
topologically-stable-sort-graph (function).
transfer-constituent (function).
translated-name (generic reader).
translated-pathname (generic reader).
try-to-merge-dnodes (function).
walk-constituents-postorder (macro).
walk-constituents-preorder (macro).
with-dependency-tracking (macro).
with-gensyms (macro).
with-groveling-macroexpand-hook (macro).
with-groveling-readtable (macro).
wtf (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Reload the asdf-dependency-grovel system safely.
Signal that symbol ‘name’ of kind ‘form-type’ is being provided by the current constituent. For example, (defun foo ...) would signal with ‘name’ foo and ‘form-type’ defun.
Signal that symbol ‘name’ of kind ‘form-type’ is being used by the current constituent. For example, (with-foo ...) might signal with ‘name’ with-foo and ‘form-type’ defmacro.
instrumented-component)) ¶instrumented-component)) ¶automatically generated reader method
constituent) &key) ¶dependency-op) (c component-file)) ¶asdf/action.
dependency-op) (comp component-file)) ¶asdf/action.
dependency-op) (c component-file)) ¶asdf/action.
compile-op) (comp instrumented-cl-source-file)) ¶Put instrumented FASL files in a temporary directory relative to the base of the system.
asdf/action.
dependency-op) (c component-file)) ¶asdf/action.
load-op) (comp instrumented-cl-source-file)) ¶asdf/action.
compile-op) (comp instrumented-cl-source-file)) ¶asdf/action.
load-source-op) (comp instrumented-cl-source-file)) ¶asdf/action.
simple-print-object-mixin) stream) ¶source-file.
asdf/operate.
:load-systems
:merge-systems
t
:verbose
asdf/action.
:output-file
:base-pathname
:base-asd-file
A list of mappings from components in systems to additional initargs that the instrumented components should receive. E.g.:
((:foo-system ("module" "component-name") :additional-dependencies ())
(:foo-system ("component2") :data-files ())
:additional-initargs
load-source-op.
asdf/action.
(quote asdf-dependency-grovel::prepare-dependency-op)
cl-source-file.
instrumented-component.
:translated-name
This slot is read-only.
:translated-pathname-form
This slot is read-only.
:output-file-type
This slot is read-only.
:additional-dependencies
This slot is read-only.
:override-dependencies
This slot is read-only.
:additional-initargs
This slot is read-only.
instrumented-component.
module.
| Initarg | Value |
|---|---|
:default-component-class | (quote instrumented-cl-source-file) |
If non-nil, then pay attention to dependencies that might be caused by
an :import-from or :shadowing-import-from in a defpackage. If nil, then
signal-internal-symbols becomes a no-op, and the defpackage and in-package
handlers do less work.
Hash table mapping constituent designators to constituent objects (initialized by with-constituent-groveling).
The lowest-level constituent that we are currently inside.
When non-nil, enables all kinds of output for debugging ADG.
Experimental – likely to be removed in the future. (msteele)
Bound to a value that is unique once per operating on each dependency-groveling system.
When the override macroexpand hook is active, this is bound to the old value of *macroexpand-hook*.
Used to let the groveling-macroexpand-hook know when it needs to preprocess a form before macroexpanding it. It starts out as t, but is bound to nil within the instrumented-eval function.
The most recent package to be set by in-package. We use *previous-package* instead of *package* directly because after loading a file, we need to know which package we were in just before the load finished, but the load function resets *package* when the load finishes.
The symbols that were already interned in *previous-package*. This gets updated each time we finish a constituent, and each time we hit an in-package form. Note that there’s subtlety involved in making sure this works regardless of whether or not we are groveling at the granularity of top-level forms.
Hash table containing the symbols that should be treated as if they were constants (as if by defconstant) when used in forms.
Hash table containing the symbols that should be treated as if they were variables (as if by defvar/defparameter) when used in forms.
Designates the directory under which ADG will create its temporary directory
for instrumented dependency-discovery FASLs.
When nil, ADG will use the base-pathname of the target system;
when non-nil, ADG will use that value as a pathname designator for it.
Like dolist, but for hashsets.
Visit each symbol in ‘form’ one at a time, bind ‘sym’ to that symbol, and execute the body. Note that this will not visit non-symbols, such as numeric literals.
Loop macro for hashsets.
Used internally; not exported.
Used internally; not exported.
Like dolist, but visits constituents in a postorder traversal.
Like dolist, but visits constituents in a preorder traversal.
Turn on the groveling-macroexpand-hook within the body. This macro is idempotent, so it’s safe to nest it (and we occasionally do).
Turn on the groveling readtable within the body.
Walk the tree up through all parent components and collect their :additional-dependencies.
Flatten the tree of modules/components into a list that contains only the non-module components.
Return the name of a package as a symbol, given either a package object or a string or symbol naming the package. Note that given a package nickname as a string or symbol, it returns a symbol for that nickname, not for the primary name of that package.
Peform any transfers appearing in the given form, and return a copy of the form with transfers removed; if the given contains no transfers, return the original form object (rather than a copy).
Add a provision to the constituent. The provision should be a list of two elements: the name of the thing provided, and a symbol indicating the kind of thing provided, e.g. ’(*foo* defvar).
Add a use to the constituent. The use should be a list of two elements: the name of the thing used, and a symbol indicating the kind of thing used, e.g. ’(*foo* defvar).
Create a table mapping constituents to constituents to lists of reasons.
Return t if con1 is a descendant of con2, nil otherwise.
Create a hash table mapping provisions to constituents that provide them.
Return t if ‘end-node’ is cyclic-reachable from ‘start-node’, nil othewise. If nodes A and B have the same parent, then node B is said to be cyclic-reachable from a node A if there is a way to get from A to B that passes through a node with a different parent (this implies that merging nodes A and B would create a cycle between two nodes with different parents).
A handler can return (does-not-macroexpand) to indicate that does not wish to provide any special expansion, and will thus defer to the normal expansion for the macro.
If the graph contains a cycle, return a list of the dnodes involved; if there is no cycle, return nil.
Return a list of file-constituents that are descendants of the given constituent.
A substitute for ‘*macroexpand-hook*’ that provides the entry into the magic of asdf-dependency-grovel.
Handle macroexpansion of a macro called ‘name’ on ‘form’ with macro function ‘function’ in ‘environment’. Either dispatch to the appropriate handler, or else simply signal the use of the macro, and provide no special expansion. Return two values: first, a boolean indicating whether any special expansion was done, and second, the special expansion form (or nil if none).
Add an item to the hashset.
Return t if the item is in the hashset, nil otherwise.
Return the number of items in the hashset.
Return t if the hashset is empty, nil otherwise.
Remove and return an arbitrary item from the hashset.
Remove an item from the hashset.
Return t if ‘set1’ is a subset of ‘set2’, nil otherwise.
Return the number of elements in the heap.
Return t if the heap is empty, nil otherwise.
Add an element to the heap.
Remove the element with the smallest priority-value from the heap and return two values: the element removed (or nil if the heap was already empty), and a boolean that is nil if the heap was indeed already empty or t otherwise.
Insert FORM into list of defun body forms BODY such that the return value of BODY is the same as it would be without FORM, keeping declarations intact.
Like eval, but preprocess the form first, and then eval it with the groveling-macroexpand-hook in place.
Create a new dnode containing a single constituent.
Create a new hashset with the specified test function.
Make an empty min-heap. The :key argument should be a function mapping elements of the heap to a priority value (typically a number) by which that item will be sorted. If no :key function is given, the element itself is used as the priority value.
Create a new temp-constituent with an automatically generated label.
Walk the form, signaling any suspected variables or constants, and uses of symbols from defpackages.
Copy all uses and provisions from the constituent to all its descendants, and do the same for each descendant.
Copy all uses and provisions from the constituent’s descendants to it, and do the same for each descendant.
Return a form similar to the one given, but replace with-transfer-constituent subforms with their included results, while transferring the included constituents.
This should be called by the in-package handler as well as at the end of each constituent (at every level). It looks for symbols that have been added to *previous-package* since the last time *previously-interned-symbols* was populated, and signals that the current constituent provided them. Uses of these symbols are picked up in the :import-from and :shadowing-import-from clauses of a defpackage. The :populate keyword, if non-nil, tells signal-new-internal-symbols to populate *previously-interned-symbols* with any missing symbols (after signaling provisions).
Traverse a type specification and signal-user as appropriate.
Add all provisions and uses in the given constituent to the current constituent. Typically, the given constituent will be a temp-constituent, for example one produced by our instrumented sharpdot reader-macro.
Either merge the nodes and return t, or do nothing and return nil.
WTF stands for When-Trace-Format. When *debug-trace* is non-nil, it will format some debug info to stdout.
instrumented-component)) ¶automatically generated reader method
asdf-component-constituent)) ¶The ASDF component.
constituent)) ¶A list of direct children of this constituent.
Return the unique designator of the constituent.
file-constituent)) ¶asdf-component-constituent)) ¶form-constituent)) ¶constituent)) ¶top-constituent)) ¶null)) ¶constituent)) ¶The index of this constituent within its parent (if any).
constituent)) ¶The parent constituent directly containing this one, or nil if the constituent has no parent.
constituent)) ¶constituent)) ¶A hashset of things provided by this constituent.
Return a summary of the identity of the constituent.
temp-constituent)) ¶form-constituent)) ¶constituent)) ¶constituent)) ¶constituent)) ¶A hashset of things used by this constituent.
uses.
asdf-component-constituent)) ¶file-constituent)) ¶form-constituent)) ¶file-constituent)) ¶The path of the file.
path.
form-constituent)) ¶The position in the file at which the form starts.
form-constituent)) ¶A human-readable string summarizing the form.
instrumented-component)) ¶automatically generated reader method
instrumented-component)) ¶automatically generated reader method
append.
:most-specific-first
temp-constituent)) ¶asdf-component-constituent)) ¶constituent)) ¶temp-constituent)) ¶The label to use as the summary of this constituent.
instrumented-component)) ¶automatically generated reader method
instrumented-component)) ¶automatically generated reader method
The ASDF component.
asdf/component.
(error "must supply a component")
:component
This slot is read-only.
The parent constituent directly containing this one, or nil if the constituent has no parent.
:parent
This slot is read-only.
A list of direct children of this constituent.
This slot is read-only.
The index of this constituent within its parent (if any).
0
This slot is read-only.
A hashset of things used by this constituent.
(asdf-dependency-grovel::make-hashset :test (quote equal))
A hashset of things provided by this constituent.
(asdf-dependency-grovel::make-hashset :test (quote equal))
The parent of all constituents in this node.
(error "must supply a parent")
:parent
This slot is read-only.
The set of constituents in this node.
(asdf-dependency-grovel::make-hashset :test (quote eql))
This slot is read-only.
The set of nodes that depend on this node.
(asdf-dependency-grovel::make-hashset :test (quote eql))
This slot is read-only.
The set of nodes that this node depends on.
(asdf-dependency-grovel::make-hashset :test (quote eql))
This slot is read-only.
The path of the file.
(error "must supply a path")
:path
This slot is read-only.
The position in the file at which the form starts.
common-lisp.
:position
This slot is read-only.
A human-readable string summarizing the form.
:summary
This slot is read-only.
prepare-source-op.
asdf/action.
(quote asdf-dependency-grovel:dependency-op)
The label to use as the summary of this constituent.
(error "must supply a label")
:label
This slot is read-only.
| Jump to: | %
(
A B C D E F G H I L M N O P R S T W |
|---|
| Jump to: | %
(
A B C D E F G H I L M N O P R S T W |
|---|
| Jump to: | *
A B C I L M N O P S T U V |
|---|
| Jump to: | *
A B C I L M N O P S T U V |
|---|
| Jump to: | A C D F G H I M P S T V |
|---|
| Jump to: | A C D F G H I M P S T V |
|---|