The asdf-viz Reference Manual

Table of Contents

The asdf-viz Reference Manual

This is the asdf-viz Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 11:27:54 2021 GMT+0.

1 Introduction

* ASDF-VIZ

This is a set of command line utilities for visualizing various object hierarchies of a lisp system.
They are roswell-compatible command-line utilities distributed by quicklisp.
Command installation is done by =ros install asdf-viz=.


*NEWS Oct 20, 2017* We added another utility =call-graph-viz= which can visualize the call graph of a function.

*NEWS Nov 6, 2017* We added another utility =class-viz= which visualizes the class inheritances.

*NEWS Nov 25, 2017* We have a license flag -l / --licence for =asdf-viz=.

*NEWS Sep 19, 2018* System-provided =asdf:require-system= systems (e.g. =sb-introsoect=) are plotted in a different shape/color. (See weblocks examples)

** asdf-viz -- visualizing the library dependencies of asdf systems.

+ Simple usage: =$ asdf-viz [output.png] [system-name]...=
+ Complex usage: =$ asdf-viz [[-e|--exclude SYSTEM]...] [-l|--license] PNG-PATH [SYSTEM...]=

Sample output of =asdf-viz -l asdf-viz.png asdf-viz= :

[[./asdf-viz.png]]

[[./weblocks.png]]

[[./spinneret.png]]

** call-graph-viz -- visualizing the call graph

#+begin_src 
Usage: call-graph-viz [options...] png-path

source options
  -s / --system SYSTEM : Quickload the system in the beginning. (specified multiple times, accumulates)
  -l / --load FILE     : Load the FILE before the visualization.(specified multiple times, accumulates)
  -r / --ros FILE      : Load a .ros script before the visualization. (specified multiple times, accumulates)
                         This avoids the problem of shebangs in roswell scripts.

filter options
  -p / --package PKG   : Limit the symbols to the package.      (specified multiple times, accumulates)
                         Package names are automatically upcased.
  -f / --function FN   : Specify the root nodes..               (specified multiple times, accumulates)
  -i / --include-outside-calls : Specifies if the leaf node can contain symbols outside the specified packages.

Examples:

call-graph-viz -s alexandria -p alexandria -f alexandria:symbolicate symbolicate.png
call-graph-viz -s alexandria -f alexandria:symbolicate symbolicate.png
 -- Visualize the call graph of alexandria:symbolicate .
    The second example has the same meaning, where -p option is inferred from the symbol package.

call-graph-viz -i -s alexandria -f alexandria:symbolicate symbolicate2.png
 -- Visualize the call graph of alexandria:symbolicate . Leaf nodes include symbols outside alexandria.

call-graph-viz -s alexandria -p alexandria alexandria.png
 -- Visualize the call graph of all external fbound symbols in alexandria
#+end_src

Example outputs:

[[./symbolicate.png]]

[[./symbolicate2.png]]

[[./alexandria.png]]

** class-viz -- visualizing the class hierarchy

#+begin_src 
Usage: class-viz [-s|--system system]* [png-path] [class names...]
Example: class-viz asdf.png asdf:component
Example: class-viz -s plump plump.png plump:node
#+end_src

Example outputs:

[[./asdf.png]]

[[./plump.png]]

** Dependencies

[[https://github.com/snmsts/roswell/][roswell]] and graphviz.

** Installation

+ =ros install asdf-viz=
+ set up PATH to include =.roswell/bin/= 

** Author

+ Masataro Asai (guicho2.71828@gmail.com)

* Copyright

Copyright (c) 2015 Masataro Asai (guicho2.71828@gmail.com)

* License

Licensed under the LLGPL License.

2 Systems

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

2.1 asdf-viz

Author

Masataro Asai

Contact

guicho2.71828@gmail.com

License

LLGPL

Description

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

Version

0.1

Dependencies

• iterate
• cl-dot
• trivia
• swank
• closer-mop

Source

asdf-viz.asd (file)

Component

src (module)

3 Modules

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

3.1 asdf-viz/src

Parent

asdf-viz (system)

Location

src/

Components

• asdf.lisp (file)
• call-graph.lisp (file)
• class-hierarchy.lisp (file)

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.asd

Location

asdf-viz.asd

Systems

asdf-viz (system)

4.1.2 asdf-viz/src/asdf.lisp

Parent

src (module)

Location

src/asdf.lisp

Packages

asdf-viz

Exported Definitions

visualize-asdf-hierarchy (function)

Internal Definitions

• *excluded* (special variable)
• *license* (special variable)
• dependency-name (function)

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

Parent

src (module)

Location

src/call-graph.lisp

Packages

asdf-viz.call-graph

Exported Definitions

visualize-callgraph (function)

Internal Definitions

• belongs-to-packages (function)
• call-graph (class)
• callees (function)

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

Parent

src (module)

Location

src/class-hierarchy.lisp

Packages

asdf-viz.class-hierarchy

Exported Definitions

visualize-class-hierarchy (function)

5 Packages

Packages are listed by definition order.

5.1 asdf-viz

Source

asdf.lisp (file)

Use List

• trivia.level2
• cl-dot
• common-lisp

Exported Definitions

visualize-asdf-hierarchy (function)

Internal Definitions

• *excluded* (special variable)
• *license* (special variable)
• dependency-name (function)

5.2 asdf-viz.call-graph

Source

call-graph.lisp (file)

Use List

• trivia.level2
• cl-dot
• common-lisp

Exported Definitions

visualize-callgraph (function)

Internal Definitions

• belongs-to-packages (function)
• call-graph (class)
• callees (function)

5.3 asdf-viz.class-hierarchy

Source

class-hierarchy.lisp (file)

Use List

• trivia.level2
• cl-dot
• common-lisp

Exported Definitions

visualize-class-hierarchy (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: visualize-asdf-hierarchy TARGET-PNG &optional SEED-SYSTEMS MODE

Package

asdf-viz

Source

asdf.lisp (file)

Function: visualize-callgraph TARGET-PNG PKG-DESIGNATORS &key SEEDS INCLUDE-OUTSIDE-CALLS

Package

asdf-viz.call-graph

Source

call-graph.lisp (file)

Function: visualize-class-hierarchy TARGET-PNG &optional BASE-CLASSES

Package

asdf-viz.class-hierarchy

Source

class-hierarchy.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *excluded*

Package

asdf-viz

Source

asdf.lisp (file)

Special Variable: *license*

Package

asdf-viz

Source

asdf.lisp (file)

6.2.2 Functions

Function: belongs-to-packages PACKAGES FNAME

Package

asdf-viz.call-graph

Source

call-graph.lisp (file)

Function: callees SYMBOL

Package

asdf-viz.call-graph

Source

call-graph.lisp (file)

Function: dependency-name DEPENDENCY-DEF

Package

asdf-viz

Source

asdf.lisp (file)

6.2.3 Classes

Class: call-graph ()

Package

asdf-viz.call-graph

Source

call-graph.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• graph-object-points-to (method)
• graph-object-node (method)
• graph-object-points-to (method)
• graph-object-node (method)
• graph-object-points-to (method)
• graph-object-node (method)

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

A.2 Functions

A.3 Variables

A.4 Data types