Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the asdf-viz Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:43:36 2020 GMT+0.
• Introduction | What asdf-viz is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
* 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.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The asdf-viz system |
Masataro Asai
LLGPL
Visualizes the dependencies between asdf systems / Visualize the function call graph.
0.1
asdf-viz.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The asdf-viz/src module |
asdf-viz (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The asdf-viz.asd file | ||
• The asdf-viz/src/asdf.lisp file | ||
• The asdf-viz/src/call-graph.lisp file | ||
• The asdf-viz/src/class-hierarchy.lisp file |
Next: The asdf-viz/src/asdf․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
asdf-viz.asd
asdf-viz (system)
Next: The asdf-viz/src/call-graph․lisp file, Previous: The asdf-viz․asd file, Up: Lisp files [Contents][Index]
src (module)
src/asdf.lisp
visualize-asdf-hierarchy (function)
Next: The asdf-viz/src/class-hierarchy․lisp file, Previous: The asdf-viz/src/asdf․lisp file, Up: Lisp files [Contents][Index]
src (module)
src/call-graph.lisp
visualize-callgraph (function)
Previous: The asdf-viz/src/call-graph․lisp file, Up: Lisp files [Contents][Index]
src (module)
src/class-hierarchy.lisp
visualize-class-hierarchy (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The asdf-viz package | ||
• The asdf-viz.call-graph package | ||
• The asdf-viz.class-hierarchy package |
Next: The asdf-viz․call-graph package, Previous: Packages, Up: Packages [Contents][Index]
asdf.lisp (file)
visualize-asdf-hierarchy (function)
Next: The asdf-viz․class-hierarchy package, Previous: The asdf-viz package, Up: Packages [Contents][Index]
call-graph.lisp (file)
visualize-callgraph (function)
Previous: The asdf-viz․call-graph package, Up: Packages [Contents][Index]
class-hierarchy.lisp (file)
visualize-class-hierarchy (function)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
call-graph.lisp (file)
class-hierarchy.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions | ||
• Internal classes |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Next: Internal classes, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
call-graph.lisp (file)
call-graph.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
call-graph.lisp (file)
standard-object (class)
list of packages to limit the visualization of the call graph
:packages
If the leaf node contains symbols outside PACKAGES
:include-outside-calls
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | A F L M |
---|
Jump to: | A F L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | B C D F V |
---|
Jump to: | B C D F V |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
I P S |
---|
Jump to: | *
I P S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | A C P S |
---|
Jump to: | A C P S |
---|