Wolfram Language Paclet Repository
Community-contributed installable additions to the Wolfram Language
Call graphs generation for context functions
Introduction
This paclet -- -- provides functions for making a call graph between the functions that belong to specified contexts.
Paclet's main function is CallGraph that gives a graph with vertices that are functions names and edges that show which function calls which other functions. With the default option values the graph vertices labeled with function names that have as tooltips the corresponding usage messages.
Load the paclet
In[19]:=
Needs["AntonAntonov`CallGraph`"]
General design
The main package function is CallGraph. With the default values of its options CallGraph produces a graph with labeled nodes and the labels have tooltips that show the usage messages of the functions. It assumed that this is would be the most generated type of call graph when studying the code of different sets of packages.
The argument of CallGraph is a context string or a list of context strings.
We can make simple, non-label, non-tooltip graph using CallGraph[__, "UsageTooltips"False].
The simple graph can be modified with the functions:
◼
CallGraphAddPrintDefinitionsButtons
◼
CallGraphBiColorCircularEmbedding
Each of those functions is decorating the simple graph in a particular way.
Contexts to analyze
Install and load paclet
In[11]:=
PacletInstall["StianRamsnes/MaXrd"]Needs["StianRamsnes`MaXrd`"]
Out[11]=
PacletObject
 |  |
|
Usage examples
Make a call graph
In[13]:=
 | CallGraph |
Out[13]=
Generate a call graph by excluding symbols
In[17]:=
gr=
["StianRamsnes`MaXrd`",ExclusionsMap[ToExpression,Names[{"StianRamsnes`MaXrd`*Data","StianRamsnes`MaXrd`*Q"}]],ImageSize900]
 | CallGraph |
Out[17]=
Generate call graph with buttons to print definitions
In[18]:=
gr0=
["StianRamsnes`MaXrd`","UsageTooltips"False];gr1=
[gr0,GraphLayoutAutomatic,ImageSize900]
 | CallGraph |
| CallGraphAddPrintDefinitionsButtons |
Out[19]=
Generate circular embedding graph color
In[22]:=
cols=RandomSample[ColorData["Rainbow"]/@Rescale[Range[VertexCount[gr1]]]];
[gr,"VertexColors"cols,ImageSize900,"EdgeThickness"Thick]
| CallGraphBiColorCircularEmbedding |
Out[23]=
Options
◼
"PrivateContexts"
Should the functions of the private contexts be included in the call graph.
Should the functions of the private contexts be included in the call graph.
◼
"SelfReferencing"
Should the self referencing edges be excluded or not.
Should the self referencing edges be excluded or not.
◼
"AtomicSymbols"
Should atomic symbols be included in the call graph.
Should atomic symbols be included in the call graph.
◼
Exclusions
Symbols to be excluded from the call graph.
Symbols to be excluded from the call graph.
◼
"UsageTooltips"
Should vertex labels with the usage tooltips be added.
Should vertex labels with the usage tooltips be added.
◼
"UsageTooltipsStyle"
The style of the usage tooltips.
The style of the usage tooltips.
Possible issues
◼
With large context (e.g. “System`”) the call graph generation might take long time.
◼
With "PrivateContexts"False the call graph will be empty if the public functions do not depend on each other.
◼
For certain packages the scanning of the down values would produce (multiple) error messages or warnings.