Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

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 Mon May 15 03:19:00 2023 GMT+0.

Next: Systems, Previous: The asdf-viz Reference Manual, Up: The asdf-viz Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The asdf-viz Reference Manual [Contents][Index]

2 Systems

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

asdf-viz

Previous: Systems, Up: Systems [Contents][Index]

2.1 `asdf-viz`

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

Author

Masataro Asai

Contact

guicho2.71828@gmail.com

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

Next: Files, Previous: Systems, Up: The asdf-viz Reference Manual [Contents][Index]

3 Modules

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

asdf-viz/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `asdf-viz/src`

Source

asdf-viz.asd.

Parent Component

asdf-viz (system).

Child Components

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

Next: Packages, Previous: Modules, Up: The asdf-viz Reference Manual [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: asdf-viz/src/asdf.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `asdf-viz/asdf-viz.asd`

Source: asdf-viz.asd.
Parent Component: asdf-viz (system).
ASDF Systems: asdf-viz.

Next: asdf-viz/src/call-graph.lisp, Previous: asdf-viz/asdf-viz.asd, Up: Lisp [Contents][Index]

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

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

Next: asdf-viz/src/class-hierarchy.lisp, Previous: asdf-viz/src/asdf.lisp, Up: Lisp [Contents][Index]

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

Source

asdf-viz.asd.

Parent Component

src (module).

Packages

asdf-viz.call-graph.

Public Interface

graph-object-node (method).
graph-object-node (method).
graph-object-node (method).
graph-object-points-to (method).
graph-object-points-to (method).
graph-object-points-to (method).
visualize-callgraph (function).

Internals

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

Previous: asdf-viz/src/call-graph.lisp, Up: Lisp [Contents][Index]

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

Next: Definitions, Previous: Files, Up: The asdf-viz Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

asdf-viz
asdf-viz.class-hierarchy
asdf-viz.call-graph

Next: asdf-viz.class-hierarchy, Previous: Packages, Up: Packages [Contents][Index]

5.1 `asdf-viz`

Source

asdf.lisp.

Use List

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

Public Interface

visualize-asdf-hierarchy (function).

Internals

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

Next: asdf-viz.call-graph, Previous: asdf-viz, Up: Packages [Contents][Index]

5.2 `asdf-viz.class-hierarchy`

Source

class-hierarchy.lisp.

Use List

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

Public Interface

visualize-class-hierarchy (function).

Previous: asdf-viz.class-hierarchy, Up: Packages [Contents][Index]

5.3 `asdf-viz.call-graph`

Source

call-graph.lisp.

Use List

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

Public Interface

visualize-callgraph (function).

Internals

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

Next: Indexes, Previous: Packages, Up: The asdf-viz Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Ordinary functions
Standalone methods

Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

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.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Special variables
Ordinary functions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Special variables

Special Variable: *excluded* ¶

Package: asdf-viz.
Source: asdf.lisp.

Special Variable: *license* ¶

Package: asdf-viz.
Source: asdf.lisp.

Next: Classes, Previous: Special variables, Up: Internals [Contents][Index]

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.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.3 Classes

Class: call-graph ¶

Package

asdf-viz.call-graph.

Source

call-graph.lisp.

Direct methods

graph-object-node.
graph-object-node.
graph-object-node.
graph-object-points-to.
graph-object-points-to.
graph-object-points-to.

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

Previous: Definitions, Up: The asdf-viz Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	B C D F G M V

	Index Entry	Section

B
	`belongs-to-packages`:	Private ordinary functions

C
	`callees`:	Private ordinary functions

D
	`dependency-name`:	Private ordinary functions

F
	`Function, belongs-to-packages`:	Private ordinary functions
	`Function, callees`:	Private ordinary functions
	`Function, dependency-name`:	Private ordinary functions
	`Function, visualize-asdf-hierarchy`:	Public ordinary functions
	`Function, visualize-callgraph`:	Public ordinary functions
	`Function, visualize-class-hierarchy`:	Public ordinary functions

G
	`graph-object-node`:	Public standalone methods
	`graph-object-node`:	Public standalone methods
	`graph-object-node`:	Public standalone methods
	`graph-object-points-to`:	Public standalone methods
	`graph-object-points-to`:	Public standalone methods
	`graph-object-points-to`:	Public standalone methods

M
	`Method, graph-object-node`:	Public standalone methods
	`Method, graph-object-node`:	Public standalone methods
	`Method, graph-object-node`:	Public standalone methods
	`Method, graph-object-points-to`:	Public standalone methods
	`Method, graph-object-points-to`:	Public standalone methods
	`Method, graph-object-points-to`:	Public standalone methods

V
	`visualize-asdf-hierarchy`:	Public ordinary functions
	`visualize-callgraph`:	Public ordinary functions
	`visualize-class-hierarchy`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* I P S

	Index Entry	Section

*
	`excluded`:	Private special variables
	`license`:	Private special variables

I
	`include-outside-calls`:	Private classes

P
	`packages`:	Private classes

S
	`Slot, include-outside-calls`:	Private classes
	`Slot, packages`:	Private classes
	`Special Variable, excluded`:	Private special variables
	`Special Variable, license`:	Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	A C F M P S

	Index Entry	Section

A
	`asdf-viz`:	The asdf-viz system
	`asdf-viz`:	The asdf-viz package
	`asdf-viz.asd`:	The asdf-viz/asdf-viz․asd file
	`asdf-viz.call-graph`:	The asdf-viz․call-graph package
	`asdf-viz.class-hierarchy`:	The asdf-viz․class-hierarchy package
	`asdf.lisp`:	The asdf-viz/src/asdf․lisp file

C
	`call-graph`:	Private classes
	`call-graph.lisp`:	The asdf-viz/src/call-graph․lisp file
	`Class, call-graph`:	Private classes
	`class-hierarchy.lisp`:	The asdf-viz/src/class-hierarchy․lisp file

F
	`File, asdf-viz.asd`:	The asdf-viz/asdf-viz․asd file
	`File, asdf.lisp`:	The asdf-viz/src/asdf․lisp file
	`File, call-graph.lisp`:	The asdf-viz/src/call-graph․lisp file
	`File, class-hierarchy.lisp`:	The asdf-viz/src/class-hierarchy․lisp file

M
	`Module, src`:	The asdf-viz/src module

P
	`Package, asdf-viz`:	The asdf-viz package
	`Package, asdf-viz.call-graph`:	The asdf-viz․call-graph package
	`Package, asdf-viz.class-hierarchy`:	The asdf-viz․class-hierarchy package

S
	`src`:	The asdf-viz/src module
	`System, asdf-viz`:	The asdf-viz system

The asdf-viz Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 asdf-viz

3 Modules

3.1 asdf-viz/src

4 Files

4.1 Lisp

4.1.1 asdf-viz/asdf-viz.asd

4.1.2 asdf-viz/src/asdf.lisp

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

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

5 Packages

5.1 asdf-viz

5.2 asdf-viz.class-hierarchy

5.3 asdf-viz.call-graph

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.1.2 Standalone methods

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

6.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `asdf-viz`

3.1 `asdf-viz/src`

4.1.1 `asdf-viz/asdf-viz.asd`

4.1.2 `asdf-viz/src/asdf.lisp`

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

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

5.1 `asdf-viz`

5.2 `asdf-viz.class-hierarchy`

5.3 `asdf-viz.call-graph`