The asdf-viz Reference Manual

This is the asdf-viz Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 04:18:21 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 asdf-viz

Visualizes the dependencies between asdf systems / Visualize the function call graph.

Author

Masataro Asai

Contact

License

LLGPL

Version

0.1

Dependencies
  • iterate (system).
  • cl-dot (system).
  • trivia (system).
  • swank (system).
  • closer-mop (system).
Source

asdf-viz.asd.

Child Component

src (module).


3 Modules

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


3.1 asdf-viz/src

Source

asdf-viz.asd.

Parent Component

asdf-viz (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 asdf-viz/asdf-viz.asd

Source

asdf-viz.asd.

Parent Component

asdf-viz (system).

ASDF Systems

asdf-viz.


4.1.2 asdf-viz/src/asdf.lisp

Source

asdf-viz.asd.

Parent Component

src (module).

Packages

asdf-viz.

Public Interface

visualize-asdf-hierarchy (function).

Internals

4.1.3 asdf-viz/src/call-graph.lisp

Source

asdf-viz.asd.

Parent Component

src (module).

Packages

asdf-viz.call-graph.

Public Interface
Internals

4.1.4 asdf-viz/src/class-hierarchy.lisp

Source

asdf-viz.asd.

Parent Component

src (module).

Packages

asdf-viz.class-hierarchy.

Public Interface

visualize-class-hierarchy (function).


5 Packages

Packages are listed by definition order.


5.1 asdf-viz

Source

asdf.lisp.

Use List
  • cl-dot.
  • common-lisp.
  • trivia.level2.
Public Interface

visualize-asdf-hierarchy (function).

Internals

5.2 asdf-viz.class-hierarchy

Source

class-hierarchy.lisp.

Use List
  • cl-dot.
  • common-lisp.
  • trivia.level2.
Public Interface

visualize-class-hierarchy (function).


5.3 asdf-viz.call-graph

Source

call-graph.lisp.

Use List
  • cl-dot.
  • common-lisp.
  • trivia.level2.
Public Interface

visualize-callgraph (function).

Internals

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: visualize-asdf-hierarchy (target-png &optional seed-systems mode)
Package

asdf-viz.

Source

asdf.lisp.

Function: visualize-callgraph (target-png pkg-designators &key seeds include-outside-calls)
Package

asdf-viz.call-graph.

Source

call-graph.lisp.

Function: visualize-class-hierarchy (target-png &optional base-classes)
Package

asdf-viz.class-hierarchy.

Source

class-hierarchy.lisp.


6.1.2 Standalone methods

Method: graph-object-node ((graph call-graph) (object list))
Package

cl-dot.

Source

call-graph.lisp.

Method: graph-object-node ((graph call-graph) (object symbol))
Package

cl-dot.

Source

call-graph.lisp.

Method: graph-object-node ((graph call-graph) (object package))
Package

cl-dot.

Source

call-graph.lisp.

Method: graph-object-points-to ((graph call-graph) (object list))
Package

cl-dot.

Source

call-graph.lisp.

Method: graph-object-points-to ((graph call-graph) (object symbol))
Package

cl-dot.

Source

call-graph.lisp.

Method: graph-object-points-to ((graph call-graph) (object package))
Package

cl-dot.

Source

call-graph.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *excluded*
Package

asdf-viz.

Source

asdf.lisp.

Special Variable: *license*
Package

asdf-viz.

Source

asdf.lisp.


6.2.2 Ordinary functions

Function: belongs-to-packages (packages fname)
Package

asdf-viz.call-graph.

Source

call-graph.lisp.

Function: callees (symbol)
Package

asdf-viz.call-graph.

Source

call-graph.lisp.

Function: dependency-name (dependency-def)
Package

asdf-viz.

Source

asdf.lisp.


6.2.3 Classes

Class: call-graph
Package

asdf-viz.call-graph.

Source

call-graph.lisp.

Direct methods
Direct slots
Slot: packages

list of packages to limit the visualization of the call graph

Initargs

:packages

Slot: include-outside-calls

If the leaf node contains symbols outside PACKAGES

Initargs

:include-outside-calls


Appendix A Indexes


A.1 Concepts